Documentation
Hierarchical Table of Contents
Description
The Hierarchical Table Of Contents module displays a presentation's table of contents with links to corresponding pages. The module supports the hierarchical lesson structure.
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 header. |
| Display only chapters | With this option selected, only chapters will be displayed. |
| Depth of expand | Defines the depth of expanding the initial nodes. If the value is not set, all nodes will be collapsed. |
| Show pages |
|
| Lang attribute | This property allows defining the language for this module (different than the language of the lesson). |
| 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. |
Supported commands
| Command name | Params | Description |
|---|---|---|
| hide | --- | Hides the module if it is visible. |
| show | --- | Shows the module if it is hidden. |
Advanced Connector integration
Each command supported by the Table module can be used in the Advanced Connector module's scripts. The following example shows how to show or hide a module according to the Double State Button module's state.
EVENTSTART
Source:DoubleStateButton1
Value:1
SCRIPTSTART
var module = presenter.playerController.getModule('Hierarchical_Table_Of_Contents1');
module.show();
SCRIPTEND
EVENTEND
EVENTSTART
Source:DoubleStateButton1
Value:0
SCRIPTSTART
var module = presenter.playerController.getModule('Hierarchical_Table_Of_Contents1');
module.hide();
SCRIPTEND
EVENTEND
Events
The Hierarchical Table Of Contents module does not send any events.
CSS classes
| Class name | Description |
|---|---|
| .hier_report | Indicates the main look of the table of contents. |
| .hier_report td | Indicates the distance between the data cells. |
| .hier_report-header | Indicates the look of the 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-chapter | Indicates the look of the lines containing chapters. |
| .hier_report .current-page | Indicates the look of the page being displayed. |
Demo presentation
Demo presentation contains examples of how to use the Hierarchical Table of Contents module.