Documentation
Paragraph
Description
The Paragraph module allows the user to enter free-form text. It also allows providing basic formatting in a WYSIWYG way (similar to MS Word and other rich text editors).
Properties
The list starts with the common properties. Learn more about them by visiting the Modules description section. The other available properties are described below.
| Property name | Description |
|---|---|
| Default font family | Set the default font family for the editor's body. The value should be expressed in the same way as in the CSS. It is a comma-separated list of font names.
For example: Helvetica, Arial, Verdana. For more information, visit: https://www.w3schools.com/cssref/pr_font_font-family. |
| Default font size | Set the default font size for the editor's body. The value should be expressed in the same way as in the CSS. It is a numeric value with a unit. For example: 14px, 3em. For more information, please visit: https://www.w3schools.com/cssref/pr_font_font-size. |
| Hide toolbar | Hides the toolbar and thus extends the editable area. |
| Editable placeholder | Makes placeholder editable, so its contents will not be cleared on focus on the module. |
| Custom toolbar | Enables defining a custom toolbar. Below is a list of all available toolbar/menu controls that you can add to your Paragraph module: newdocument bold italic underline strikethrough alignleft aligncenter alignright alignjustify styleselect formatselect fontselect fontsizeselect bullist numlist outdent indent blockquote undo redo removeformat subscript superscript Note: Use pipe "|" to group buttons. |
| Custom CSS | This property lets you specify a separate file with custom CSS styles extending the main CSS content. This CSS file is used within the editor (the editable area). If "Default font family" and "Default font size" are defined, they have higher priority than styles used in the "Custom CSS" file. This property allows online resources. Find out more » |
| Use Custom CSS files | This property allows the use of resources defined in the CSS file specified in the “Custom CSS” property.
It is required that the files listed in the file in “Custom CSS” property are added as assets to the lesson. In case this property was selected first and then a CSS file was added to the “Custom CSS” property, the list of assets will be updated automatically. Functionality does not yet work with Update assets » |
| Placeholder text | This property enables specifying free text content to be used as a placeholder in the Paragraph. Allows for HTML styling. |
| Layout Type | Choose the "Default" or "French" layout. |
| Manual grading | Selecting this Paragraph's property allows the teacher to manually grade the module's content when the lesson is part of the submitted Assignment. The Paragraph can be instantly viewed by the teacher in the Assignment's results on the LMS and possibly verified without previewing the lesson. If selected, the value of the "weight" property will be treated as the max score. |
| Show Answers | A list of correct answers. On Show Answers, all correct answers are displayed at the same time, each answer separated by a new line. On Gradual Show Answers, correct answers are displayed gradually, one after another, each time the Gradual Show Answers event is triggered. |
| Title | The title of the Paragraph is visible when the Assignment's open activities are manually graded on mCourser. The title is visible above each Paragraph's preview; however, it is not visible in the lesson itself. |
| Weight | The maximum number of points the teacher can grant when grading the Assignment's open activities. This can only be a whole number in the range from 0 to 100. The default Paragraph's weight equals 1. If the "Manual grading" property is selected, this value will be used as the max score. |
| Printable | Allows to choose if the module should be included in the printout. |
| Speech texts | Sets the values of speech texts - predefined phrases providing additional context while using the module in the Text To Speech mode. Speech texts are always read using the content's default language. |
| Lang attribute | This property allows defining the language for this module (different than the language of the lesson). |
| Block in error checking mode | If this option is selected, the module is blocked in the error checking mode. |
Supported commands
| Command name | Params | Description |
|---|---|---|
| hide | --- | Hides the module if it is visible. |
| show | --- | Shows the module if it is hidden. |
| isVisible | --- | Returns true if the module is visible, otherwise false. |
| getText | --- | Returns module's content. |
| setText | text | Sets the content of the module to the text given as a parameter. |
| isAttempted | --- | Returns true if any text was inserted. |
| lock | --- | Covers the module with the mask. |
| unlock | --- | Removes the mask from the module. |
| isAIReady | --- | Returns true if the model AI is ready to score the module. |
Scoring
The Paragraph, thanks to the Open Activity functionality, can be scored by AI and/or a teacher. To activate the scoring, the module must have the Manual grading property selected. At this point, the module supports only the default way of Activity scoring, that is, when:
- Score Type in page is set to percentage.
- If the module belongs to a group then the Group scoring in the group is set to Default.
With other settings, the scoring will be miscalculated.
| Property | Description |
|---|---|
| maxScore | Equal to the value provided in Weight property. If Manual grading property is not selected, then it returns 0. |
| score | Content of the module can be scored by the teacher and AI. If Manual grading property is not selected, then it returns 0. If the module was scored by the teacher and AI, then use the score provided by the teacher. If the module was neither scored by the teacher nor AI, then the score will be equal to maxScore. |
| errorCount | Always returns 0. |
Events
The blur event occurs on exiting the module.
| Field name | Description |
|---|---|
| Name | ValueChanged |
| Item | N/A |
| Value | blur |
| Item | N/A |
Note: Which event (empty or modified) will be sent depends on the result of the isAttempted command. That is, if a module has the Placeholder text property defined and the Editable placeholder property checked, then as long as the text in the editor is the same as from the placeholder, it will be treated as empty.
The modified event occurs after blur event, when module content has been modified.
| Field name | Description |
|---|---|
| Name | ValueChanged |
| Item | N/A |
| Value | modified |
| Score | N/A |
The empty ValueChanged type event occurs:
- after a reset,
- after blur event, when module content has not been modified,
| Field name | Description |
|---|---|
| Name | ValueChanged |
| Item | N/A |
| Value | empty |
| Score | N/A |
The empty PreDestroyed type event occurs just before lesson's page close (due to a switch to another lesson page) when it had no content.
| Field name | Description |
|---|---|
| Name | PreDestroyed |
| Item | N/A |
| Value | empty |
Demo presentation
Demo presentation contains examples of how to use the Paragraph module.