Contents
This component adds a page in the ModX manager interface that allows you to create & maintain a list of
explanations for key terms in your site. Entries into the glossary take the form of term => explanation
where term
is the phrase being described and explanation
is the description of said term.
Included in the package is a snippet called Glossary which will output the glossary terms to a resource page. The snippet is fully templatable using chunks specified as optional parameters to the snippet call, and various features can be turned on or off in the same manner.
This snippet outputs a list of terms and explanations, ordered alphabetically and grouped by first letter. It also ouputs a navigation list of links at the top of the glossary list to allow a user to jump to a specific letter.
showNav
- show the letter nav at the top of the list [default = true]navOuterTpl
- chunk to use as the outer template for the letter navnavItemTpl
- chunk to use for each item/link in the letter navlistOuterTpl
- chunk to use as the outer template for the term listlistGroupTpl
- chunk to use for each letter group in the term listlistTermTpl
- chunk to use for each term in a letter group
The Highlighter plugin parses page content fields on render and replaces all occurrences of terms with markup defined in the plugin's tpl chunk. This can be used to provide a link directly to the glossary entry for that term.
tpl
- the chunk to use for the replacementresId
- id of a resource displaying the [[Glossary]] snippet (for link generation)
[[+link]]
- link url including hash anchor[[+term]]
- the term being referenced[[+explanation]]
- the explanation for this term