@pie-element/complex-rubric 3.7.8-next.74 → 3.7.8-next.80

package/configure/node_modules/@pie-element/{rubric/docs/config-schema.json.md → multi-trait-rubric/docs/pie-schema.json.md}

@@ -1,42 +1,136 @@
+Model for the MultiTraitRubric Interaction
+
 The schema defines the following properties:
 
-# `baseInputConfiguration` (object)
+# `halfScoring` (boolean)
+
+Indicates if half scoring is enabled
+
+# `pointLabels` (boolean)
+
+Indicates if point labels should be shown
+
+# `visibleToStudent` (boolean)
+
+Indicates if should be visible to student
+
+# `description` (boolean)
+
+Indicates if description should be shown
+
+# `standards` (boolean)
+
+Indicates if standards should be shown
+
+# `excludeZero` (boolean)
+
+Indicates if scoring should start at 0 or 1
+
+# `spellCheckEnabled` (boolean, required)
+
+Indicates if spellcheck is enabled for the author. Default value is true
+
+# `scales` (array, required)
+
+scales
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+## `maxPoints` (number, required)
+
+Indicates max limit for scoring points
+
+## `scorePointsLabels` (array, required)
+
+Score labels. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.
+
+## `traitLabel` (string, required)
+
+Trait label
+
+## `traits` (array, required)
+
+Traits
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+### `name` (string, required)
+
+Trait name
+
+### `standards` (array, required)
+
+Trait standards
 
-Properties of the `baseInputConfiguration` object:
+The object is an array with all elements of the type `string`.
 
-## `math` (object)
+### `description` (string, required)
+
+Trait description
+
+### `scorePointsDescriptors` (array, required)
+
+Score point descriptors. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.
+
+# `id` (string, required)
+
+Identifier to identify the Pie Element in html markup, Must be unique within a pie item config.
+
+# `element` (string, required)
+
+The html Element tag name
+
+---
+
+# Sub Schemas
+
+The schema defines the following additional types:
+
+## `EditableHtmlConfigureProp` (object)
+
+Properties of the `EditableHtmlConfigureProp` object:
+
+### `math` (object)
 
 Properties of the `math` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `audio` (object)
+### `audio` (object)
 
 Properties of the `audio` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `video` (object)
+### `video` (object)
 
 Properties of the `video` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `image` (object)
+### `image` (object)
 
 Properties of the `image` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `customPlugins` (array)
+### `customPlugins` (array)
 
 An array of objects that determine custom plugins.
 A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
@@ -46,288 +140,217 @@ The object is an array with all elements of the type `object`.
 
 The array object has the following properties:
 
-### `event` (string, required)
+#### `event` (string, required)
 
 The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
 PIE will emit the event prefixed with "PIE-".
 Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
 
-### `iconAlt` (string, required)
+#### `iconAlt` (string, required)
 
 The alt for the custom button icon
 
-### `iconType` (string, required)
+#### `iconType` (string, required)
 
 The icon type.
 Currently, only "SVG" is supported.
 
-### `icon` (string, required)
+#### `icon` (string, required)
 
 The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
 
-## `blockquote` (object)
+### `blockquote` (object)
 
 Properties of the `blockquote` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `h3` (object)
+### `h3` (object)
 
 Properties of the `h3` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `characters` (object)
+### `characters` (object)
 
 Properties of the `characters` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `bold` (object)
+### `bold` (object)
 
 Properties of the `bold` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `html` (object)
+### `html` (object)
 
 Properties of the `html` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `italic` (object)
+### `italic` (object)
 
 Properties of the `italic` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `ol_list` (object)
+### `ol_list` (object)
 
 Properties of the `ol_list` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `redo` (object)
+### `redo` (object)
 
 Properties of the `redo` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `strikethrough` (object)
+### `strikethrough` (object)
 
 Properties of the `strikethrough` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `sub` (object)
+### `sub` (object)
 
 Properties of the `sub` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `sup` (object)
+### `sup` (object)
 
 Properties of the `sup` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `table` (object)
+### `table` (object)
 
 Properties of the `table` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `ul_list` (object)
+### `ul_list` (object)
 
 Properties of the `ul_list` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `underline` (object)
+### `underline` (object)
 
 Properties of the `underline` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `undo` (object)
+### `undo` (object)
 
 Properties of the `undo` object:
 
-### `disabled` (boolean)
+#### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-# `settingsPanelDisabled` (boolean)
-
-Indicates if the settings panel is not available
-
-# `showExcludeZero` (object)
-
-Properties of the `showExcludeZero` object:
-
-## `settings` (boolean)
-
-Indicates if the item has to be displayed in the Settings Panel
-
-## `label` (string)
-
-Indicates the label for the item that has to be displayed in the Settings Panel
-
-# `showMaxPoint` (object)
-
-Properties of the `showMaxPoint` object:
-
-## `settings` (boolean)
-
-Indicates if the item has to be displayed in the Settings Panel
-
-## `label` (string)
-
-Indicates the label for the item that has to be displayed in the Settings Panel
-
-# `width` (string)
-
-How large can the rubric be
-
-# `mathMlOptions` (object)
-
-Properties of the `mathMlOptions` object:
-
-## `mmlOutput` (number)
-
-Indicates if model should have mathML output instead of latex
-
-## `mmlEditing` (number)
-
-Indicates if mathML that's already in model should be editable
-
-# `maxMaxPoints` (number)
-
-Indicates the max limit for scoring points
-
-# `showPrompt` (boolean)
-
-Determines whether prompt field will be displayed or not
-
-Default: `true`
-
-# `promptLabel` (string)
-
-The label for the item stem/prompt field
-
-Default: `"Item Stemm"`
-
-# `contentDimensions` (object)
-
-Indicates the dimensions configuration for the authoring container
-Note: Some items have a default minimum width because of their content, but if
-the minWidth is lower than this, the overflow behavior will take care of that
-
-Properties of the `contentDimensions` object:
-
-## `maxHeight` (string,number)
-
-Indicates the max height of the authoring container
+## `EditableHtmlButtonConfigure` (object)
 
-Default: `"undefined"`
+Properties of the `EditableHtmlButtonConfigure` object:
 
-## `maxWidth` (string,number)
+### `disabled` (boolean)
 
-Indicates the max width of the authoring container
+Indicates if the plugin is disabled or not
 
-Default: `"undefined"`
+## `CustomPlugin` (object)
 
-## `minHeight` (string,number)
+Properties of the `CustomPlugin` object:
 
-Indicates the min height of the authoring container
+### `event` (string, required)
 
-Default: `"undefined"`
+The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
+PIE will emit the event prefixed with "PIE-".
+Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
 
-## `minWidth` (string,number)
+### `iconAlt` (string, required)
 
-Indicates the min width of the authoring container
+The alt for the custom button icon
 
-Default: `"undefined"`
+### `iconType` (string, required)
 
-Default: `": {}"`
+The icon type.
+Currently, only "SVG" is supported.
 
-# `settingsPartialScoring` (boolean)
+### `icon` (string, required)
 
-Indicates whether the settings panel wil allow the author to modify settings for partial scoring
+The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
 
-Default: `true`
+## `EditableHtmlPluginConfigure` (object)
 
----
+Properties of the `EditableHtmlPluginConfigure` object:
 
-# Sub Schemas
+### `inputConfiguration` (object)
 
-The schema defines the following additional types:
+Properties of the `inputConfiguration` object:
 
-## `EditableHtmlConfigureProp` (object)
-
-Properties of the `EditableHtmlConfigureProp` object:
-
-### `math` (object)
+#### `math` (object)
 
 Properties of the `math` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `audio` (object)
+#### `audio` (object)
 
 Properties of the `audio` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `video` (object)
+#### `video` (object)
 
 Properties of the `video` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `image` (object)
+#### `image` (object)
 
 Properties of the `image` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `customPlugins` (array)
+#### `customPlugins` (array)
 
 An array of objects that determine custom plugins.
 A custom plugin is an object which determines how the button will look like (icon) and the event name that will be triggered when button gets pressed (event).
@@ -337,175 +360,164 @@ The object is an array with all elements of the type `object`.
 
 The array object has the following properties:
 
-#### `event` (string, required)
+##### `event` (string, required)
 
 The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
 PIE will emit the event prefixed with "PIE-".
 Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
 
-#### `iconAlt` (string, required)
+##### `iconAlt` (string, required)
 
 The alt for the custom button icon
 
-#### `iconType` (string, required)
+##### `iconType` (string, required)
 
 The icon type.
 Currently, only "SVG" is supported.
 
-#### `icon` (string, required)
+##### `icon` (string, required)
 
 The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
 
-### `blockquote` (object)
+#### `blockquote` (object)
 
 Properties of the `blockquote` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `h3` (object)
+#### `h3` (object)
 
 Properties of the `h3` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `characters` (object)
+#### `characters` (object)
 
 Properties of the `characters` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `bold` (object)
+#### `bold` (object)
 
 Properties of the `bold` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `html` (object)
+#### `html` (object)
 
 Properties of the `html` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `italic` (object)
+#### `italic` (object)
 
 Properties of the `italic` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `ol_list` (object)
+#### `ol_list` (object)
 
 Properties of the `ol_list` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `redo` (object)
+#### `redo` (object)
 
 Properties of the `redo` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `strikethrough` (object)
+#### `strikethrough` (object)
 
 Properties of the `strikethrough` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `sub` (object)
+#### `sub` (object)
 
 Properties of the `sub` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `sup` (object)
+#### `sup` (object)
 
 Properties of the `sup` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `table` (object)
+#### `table` (object)
 
 Properties of the `table` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `ul_list` (object)
+#### `ul_list` (object)
 
 Properties of the `ul_list` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `underline` (object)
+#### `underline` (object)
 
 Properties of the `underline` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-### `undo` (object)
+#### `undo` (object)
 
 Properties of the `undo` object:
 
-#### `disabled` (boolean)
+##### `disabled` (boolean)
 
 Indicates if the plugin is disabled or not
 
-## `EditableHtmlButtonConfigure` (object)
-
-Properties of the `EditableHtmlButtonConfigure` object:
-
-### `disabled` (boolean)
-
-Indicates if the plugin is disabled or not
-
-## `CustomPlugin` (object)
+### `settings` (boolean)
 
-Properties of the `CustomPlugin` object:
+Indicates if the item has to be displayed in the Settings Panel
 
-### `event` (string, required)
+### `label` (string)
 
-The name of the custom event. It needs to be valid (only letters, numbers and "_" can be used).
-PIE will emit the event prefixed with "PIE-".
-Eg: event = 'client_custom_event_A' => the emitted event will be "PIE-client_custom_event_A"
+Indicates the label for the item that has to be displayed in the Settings Panel
 
-### `iconAlt` (string, required)
+## `DialogContent` (object)
 
-The alt for the custom button icon
+Properties of the `DialogContent` object:
 
-### `iconType` (string, required)
+### `title` (string)
 
-The icon type.
-Currently, only "SVG" is supported.
+Dialog box title
 
-### `icon` (string, required)
+### `text` (string)
 
-The icon string. Currently, only "SVG" is supported, so it needs to be a valid svg.
+Dialog box text
 
 ## `ConfigureProp` (object)
 
@@ -529,4 +541,74 @@ Indicates if model should have mathML output instead of latex
 
 ### `mmlEditing` (number)
 
-Indicates if mathML that's already in model should be editable
+Indicates if mathML that's already in model should be editable
+
+## `Scale` (object)
+
+Properties of the `Scale` object:
+
+### `maxPoints` (number, required)
+
+Indicates max limit for scoring points
+
+### `scorePointsLabels` (array, required)
+
+Score labels. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.
+
+### `traitLabel` (string, required)
+
+Trait label
+
+### `traits` (array, required)
+
+Traits
+
+The object is an array with all elements of the type `object`.
+
+The array object has the following properties:
+
+#### `name` (string, required)
+
+Trait name
+
+#### `standards` (array, required)
+
+Trait standards
+
+The object is an array with all elements of the type `string`.
+
+#### `description` (string, required)
+
+Trait description
+
+#### `scorePointsDescriptors` (array, required)
+
+Score point descriptors. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.
+
+## `Trait` (object)
+
+Properties of the `Trait` object:
+
+### `name` (string, required)
+
+Trait name
+
+### `standards` (array, required)
+
+Trait standards
+
+The object is an array with all elements of the type `string`.
+
+### `description` (string, required)
+
+Trait description
+
+### `scorePointsDescriptors` (array, required)
+
+Score point descriptors. Starting from 0 to max.
+
+The object is an array with all elements of the type `string`.