fixing bot fmk template

Author: topdeveloper739

docs/scorecard.md

@@ -0,0 +1,139 @@
+
+
+| Property | Type | Value | Description 
+| :--------|:-----|:------|:------------
+| `id`| `string` || ID of the element on the page
+| `type`| `string` | "Scorecard" |
+| `title`| `string` || Title that will appear at the top of the card
+| `size`| `{ w: number, h: number}` || Width/Height of the card. The size of each inner card is 2x2 or 2x3 depending on subheading
+| `dependencies`| `object` || Dependencies that will be requested for this element
+| `props`| `object` || Additional properties to define for this element
+| `actions`| `object` || Defined actions for this element
+
+# Three States
+There are 3 configuraions for this element type
+
+## Single value
+
+To read how to define dependencies [click here](/dependencies).
+Define `dependencies` as follows:
+
+| Property | Description 
+| :--------|:------------
+| `value`| Large value to display
+| `color`| Color to be used
+| `icon`| Icon to display next to the large value
+| `subvalue`| Small value to display
+| `className`| Class name to add to value
+
+Define `properties` as follow:
+
+| Property | Type | Description 
+| :--------|:-----|:------------
+| `subheading`| `string` | Large value to display
+| `onClick`| `string` | Action name [[Read about actions](/actions)]
+
+```js
+{
+  id: "errors",
+  type: "Scorecard",
+  title: "Errors",
+  size: { w: 2, h: 3 },
+  dependencies: {
+    value: "errors:handledAtTotal",
+    color: "errors:handledAtTotal_color",
+    icon: "errors:handledAtTotal_icon",
+    subvalue: "errors:handledAtTotal",
+    className: "errors:handledAtTotal_class"
+  },
+  props: { subheading: "Avg" }
+}
+```
+
+## Multiple values
+
+## Dynamic cards
+
+# Actions
+Selected cards will call an action with the card's value.
+A card value has the following properties:
+
+| Property | Description 
+| :--------|:------------
+| `value`| Large value to display
+| `heading`| Large heading under large value
+| `color`| Color to be used
+| `icon`| Icon to display next to the large value
+| `subvalue`| Small value to display
+| `subheading`| Small heading under small value to display
+| `className`| Class name to add to value
+
+These are examples of openning a dialog when clicking on a card:
+
+`One value card`:
+
+```js
+{
+  id: "errors",
+  type: "Scorecard",
+  title: "Errors",
+  size: { w: 2, h: 3 },
+  dependencies: {
+    value: "errors:handledAtTotal",
+    color: "errors:handledAtTotal_color",
+    icon: "errors:handledAtTotal_icon",
+    subvalue: "errors:handledAtTotal",
+    className: "errors:handledAtTotal_class"
+  },
+  props: {
+    subheading: "Avg",
+    onClick: "onErrorsClick"
+  },
+  actions: {
+    onErrorsClick: {
+      action: "dialog:errors",
+      params: {
+        title: "args:heading",
+        type: "args:type",
+        innermostMessage: "args:innermostMessage",
+        queryspan: "timespan:queryTimespan"
+      }
+    }
+  }
+}
+```
+
+`Dyanmic card click`: 
+
+```js
+{
+  id: "scores",
+  type: "Scorecard",
+  size: { w: 2, h: 3 },
+  dependencies: {
+    card_errors_value: "errors:handledAtTotal",
+    card_errors_heading: "::Errors",
+    card_errors_color: "errors:handledAtTotal_color",
+    card_errors_icon: "errors:handledAtTotal_icon",
+    card_errors_subvalue: "errors:handledAtTotal",
+    card_errors_subheading: "::Avg",
+    card_errors_className: "errors:handledAtTotal_class",
+    card_errors_onClick: "::onErrorsClick",
+
+    card_users_value: "ai:users-value",
+    card_users_heading: "::Total Users",
+    card_users_icon: "ai:users-icon"
+  },
+  actions: {
+    onErrorsClick: {
+      action: "dialog:errors",
+      params: {
+        title: "args:heading",
+        type: "args:type",
+        innermostMessage: "args:innermostMessage",
+        queryspan: "timespan:queryTimespan"
+      }
+    }
+  }
+}
+```