#adapt-contrib-glossary
Glossary is an extension for the Adapt framework.
This extension allows for a list of glossary terms to be displayed (in alphabetical order) in the 'drawer' of the course. The terms can be clicked to reveal a definition. The list of terms is searchable.
##Installation
First, be sure to install the Adapt Command Line Interface, then from the command line run:-
adapt install adapt-contrib-glossary
This extension can also be installed by adding the extension to the adapt.json file before running adapt install
:
"adapt-contrib-glossary": "*"
##Usage
You can create links to items in the glossary in the format <a href='#' data-glossaryterm='About Framework'>Adapt Framework</a>
##Settings overview
For example JSON format, see example.json. Further details are given below which can be added to course:
"_glossary": {
"_isEnabled": true,
"title": "Glossary",
"description": "Click here to view glossary for this course",
"searchPlaceholder": "Search",
"searchWithInDescriptionLabel": "Search within Description",
"itemNotFoundMessage": "Sorry! No results to display",
"_glossaryItems": [
{
"term": "",
"description": ""
}
]
}
##Events
Event | Description | Object | ||
glossary:descriptionOpen | Triggered when the user clicks on glossary item and its description get opened |
|
##Limitations
To be completed.
##Browser spec
This component has been tested to the standard Adapt browser specification.