Documentation

Paragraph eKeyboard

Description

The Paragraph eKeyboard module allows a student to enter a free form text. It also allows providing basic formatting in a WYSIWYG way (similar to MS Word and other rich text editors) and entering national chars from the virtual keyboard attached to a text field.

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 body. The value should be expressed in the same way as in CSS. It is a comma separated list of font names.
For example: Helvetica, Arial, Verdana.
For more information, visit http://www.w3schools.com/cssref/pr_font_font-family.asp.
Default font size Set the default font size for the editor body. The value should be expressed in the same way as in CSS. It is a numeric value with a unit.
For example: 14px, 3em.
For more information, please visit http://www.w3schools.com/cssref/pr_font_font-size.asp.
Hide toolbar Hides a toolbar and so extends the editable area space.
Editable placeholder Makes placeholder editable, so it's contents will not be cleared on the focus on the module.
Custom toolbar Enables to define a custom toolbar. Below is a list of all available toolbar/menu controls that you can add to your Paragraph addon:

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.
Placeholder text This property enables you to specify a free text content to be used as a placeholder. Allows for html styling.
Custom CSS This property enables you to specify a separate file with custom CSS styles that extend the main CSS content. This CSS file is the one 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 Custom CSS file.

This property allows online resources. Find out more »

Keyboard Layout Type Type of the eKeyboard layout. You can choose one of the standard layouts: French, German and Spanish special characters or Custom which means you can set whatever Layout you like by configuring Custom Layout field.
Custom Keyboard Layout Buttons should be space separated, group of buttons (rows) should be new line separated. Layout object has to have at least a "default" property with standard keyboard. The following action keys are supported:
  • {shift} – used as CapsLock
  • {empty} – used as an empty space
Keyboard Position Position of the Keyboard in relation to the text field. If position is right or left, the keyboard layout will be transposed. If position is set as Custom, you have to specify the position by presentation CSS styles.
Manual grading Selecting this Paragraph's property allows the teacher to manually grade the Paragraph’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 be verified without previewing the lesson. If selected, the value of `weight` property will be treated as max score.
Show answers Text to display on Show Answers.
Title The title of the Paragraph 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 be only a whole number in 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.

Supported commands

Command name Params Description
show --- shows the module
hide --- hides the module
isVisible --- returns true if module is visible, otherwise false
lock --- locks the module, hiding it's contents and disabling edition
unlock --- unlocks the module, displaying it's contents and enabling edition
getText --- returns module content
setText text sets the content of the module to the text given as parameter
isAttempted --- returns true if any text was inserted
isAIReady --- Returns true if model AI is ready to score addon.

Scoring

Paragraph thanks to Open Activity functionality can be scored by AI and/or Teacher. To activate scoring addon must have the Manual grading property selected.

Property Description
maxScore Equal to the value provided in `Weight` propety.
If `Manual grading` property is not selected then returns 0.
score Content of addon can be scored by Teacher and AI.
If `Manual grading` property is not selected then returns 0.
If addon was scored by Teacher and AI, then use score provided by Teacher.
If addon was neither scored by Teacher and AI, then score will be equal to 0.
errorCount Always returns 0.

Events

Field name Description
Value blur - event send on exiting the module

CSS Classes

Property name Description
.paragraph-keyboard-wrapper Simple addon wrapper
.paragraph-wrapper Simple wrapper for Text editor.
.paragraph-keyboard Layer with eKeyboard.
.paragraph-keyboard-letter Standard keyboard letter.
.paragraph-keyboard-empty Empty field on keyboard.
.paragraph-keyboard-letter.clicked Style appears when a letter is clicked.
.paragraph-keyboard-shift Style for CapsLock button.
.paragraph-keyboard-shift.clicked Style when CapsLock button is clicked.

Demo presentation

Demo presentation contains examples of the Paragraph eKeyboard addon's usage.