Each book has a built-in glossary, which may be accessed from the top-right dropdown on the cover page > Glossary.
These glossary terms may be accessed from any chapter, and if you would like to create a chapter for users to see your glossary, then you can do so by adding the Glossary Terms special include in any chapter's settings.
Creating Glossary Terms
While on your glossary page, you can add new terms using the form at the bottom of the page. Each glossary term requires a name, anchor name, and description as follows:
- The human-readable name of the term (e.g., "Project-Based Learning")
- Anchor Name
- The machine-readable name of the term, which will be used for linking purposes (e.g., "project-based_learning").
- The descriptive text for the term. HTML markup is allowed.
Editing Glossary Terms
For any term that is created, click the pencil icon next to it in order to edit.
Creating Glossary Lists within Chapters
You can include an automatically updated list of glossary terms with definitions in any chapter. This is useful if you would like to include a list of key terms within a chapter that will be updated as glossary definitions change.
To do this, edit the chapter, place the cursor where you would like the list placed, and select Tools > Glossary Terms List.
In the Anchors field, type in a comma-separated list of anchors for the book's glossary terms that you would like to have listed, and click Submit.
If you would like to edit the included list later, you can change the terms, delete them, or add new ones directly in the editor.
To update the text that appears in the chapter as glossary terms are changed, simply edit and save the chapter again.
Creating Glossary Pop-ups
You can create glossary pop-up elements within your chapter by editing the chapter, placing your cursor where you want the pop-up, and choosing Tools > Glossary Link.
Here is an example glossary pop-up:
Creating Non-Glossary Pop-Ups
You can also create pop-ups manually by editing the HTML directly, like this one:
To do this, use the following code, replacing YOUR DEFINITION HERE and YOUR TEXT HERE with your own.
<span class="glossary-link" role="button" title="YOUR DEFINITION HERE">YOUR TEXT HERE</span>