Login Register

Documentation

Hierarchical Lesson Report

Description

The Hierarchical Lesson Report module enables inserting a ready-made lesson report, including percentage results for each presentation page, a total percentage result, and a number of checks, mistakes, and errors. The module supports a hierarchical lesson structure and displays summary values for all chapters. It is possible to modify the appearance of each part of the report individually.

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
Title Label Label for a column with page names, displayed in the report's header.
Show Results Checking this property enables displaying the column with a progress bar and percentage result.
Results Label Label for a column showing the result, displayed in the report's header.
Show Checks Checking this property enables displaying the column with the number of checks.
Checks Label Label for the checks column, displayed in the report's header.
Show Mistakes Checking this property enables displaying the column with the number of mistakes.
Mistakes Label Label for the mistakes column, displayed in the report's header.
Show Errors Checking this property enables displaying the column showing the number of errors.
Errors Label A label for the errors column, displayed in the report's header.
Show Total Checking this property enables displaying the row with a total presentation result.
Total Label Label for the total row, displayed in the first column.
Max score award label Label for the max score column, displayed in the report's header.
Page scores label Label for the page scores column, displayed in the report's header.
Depth of expand Defines the depth of expanding the initial nodes. If the value is not set, all nodes will collapse.
Row classes Each line of this property is a class that will be assigned to a corresponding row in the report. If the number of class rows is smaller than the number of report rows - the classes will be assigned repeatedly.
Show page scores Checking this property enables displaying the column showing the page score (in <score> / <max score> format).
Show max score award Checking this property enables displaying the column showing the maximum page score.
Disable score on pages The semicolon-separated list of page indexes for which user progress (e.g., results) won't be displayed. In addition, ignored pages will not be taken into account while calculating the total score of the lesson. NOTE: When providing page indexes lesson chapters visible in the pages section are also counted towards the index.
Enable pages The semicolon-separated list of page indexes that will be displayed and taken into account while calculating the score. If empty, all pages will be displayed.
Unvisited page scores label If a page hasn't been visited, the score is shown as 0/0. To avoid this situation, it is possible to change the value 0/0 to some text. This text can be defined in this property.
Alternative page titles The list of specified alternative page names. If the "is chapter" option is checked, the item will apply to the chapter specified by an index. The index is the number of a page (starting from 0) or a chapter. Page name input is used to replace the tile.
Lang attribute Allows setting the language used to read the contents of the card via the TTS module.
Speech texts Sets the values of speech texts - predefined phrases providing additional context while using the module in the TTS mode. Speech texts are always read using the content's default language.
Use weighted arithmetic mean Checking this property enables using weighted arithmetic mean to calculate the value in the result column (progress bar and percentage result).
Learn more about weights by visiting the Activity scoring section.
Exclude unvisited pages in the total When unchecked, the total score is calculated from all reported pages.

Supported commands

Command name Params Description
--- --- ---

The Hierarchical Lesson Report module doesn't support any commands.

Advanced Connector integration

Due to no supported commands, there is no integration of the Hierarchical Lesson Report module with Advanced Connector.

Events

The Hierarchical Lesson Report module does not send any events.

CSS classes

Class name Description
.hier_report Indicates the main look of the report.
.hier_report td Indicates the distance between the data cells in the report's table.
.hier_report-header Indicates the look of the report's header.
.hier_report-odd Indicates the look of the oddly numbered lines.
.hier_report-even Indicates the look of the evenly numbered lines.
.hier_report-footer Indicates the look of the report's footer.
.hier_report-chapter Indicates the look of the lines containing chapters.
.hier_report-progress Indicates the look of the progress column including the text value of the percentage result.
.ui-progressbar Indicates the parameter defining the look of internal bars, that increase proportionally to the user's progress.
.hier_report-checks Indicates the look of the checks column.
.hier_report-mistakes Indicates the look of the mistakes column.
.hier_report-errors Indicates the look of the errors column.

Examples

1.1. Report
.hier_report {
padding: 15px;
border-radius: 5px;
border:1px solid gray;
background-color: white;
color: gray;
overflow: auto;
}

1.2. Report td
.hier_report td{
padding: 10px;
}

1.3. Report header
.hier_report-header{
font-weight: bold;
color:black !important;
background-color: #bde0ff;
}

1.4. Report footer
.hier_report-footer{
font-weight: bold;
color:black !important;
background-color: #bde0ff;
}

1.5. Report chapter
.hier_report-chapter{
background-color: Lavender;
}

1.6. Report odd
.hier_report-odd{
background-color: AliceBlue;
}

1.7. Report even
.hier_report-even{
background-color: #f0f1ff;
}

1.8. Report progress column
.hier_report-progress {
text-align: center;
color: #0A8DBD;
display: inline-block;
width: 190px;
}

1.9. Report checks column
.hier_report-checks {
width: 10%;
color: green;
text-align: center;
}

1.10. Report mistakes column
.hier_report-mistakes {
width: 10%;
color: #990000;
text-align: center;
}

1.11. Report errors column
.hier_report-errors {
width: 10%;
color: red;
text-align: center;
}

1.12. Report progress bar
.ui-progressbar {
padding: 2px;
width: 130px !important;
height: 15px !important;
border-radius: 5px;
border:2px solid #02789F;
background-color: #3CC6CD;
border-radius: 5px;
float: left;
}

Demo presentation

Demo presentation contains examples of how to use the Hierarchical Lesson Report module.