Skip to content

Defining glossary entries

Basic

Provided you use the material definition lists adding a glossary entry just works by adding a definition list with section specifiers anywhere in your documentation.

Note

Alternatively, you can directly use html description lists in your page as well.

term:glossary
:   A list of specialized words with their definitions

term herby referes to the section terms in which this glossary entry will be added.

Example

Define the term glossary in the section term:

*demo:my_term1*
:   Definition of my_term 1

demo:my_term2
:   Definition of my_term 2 

*`demo:my_term2`*
:   Definition of my_term 2
my_term1
Definition of my_term 1

[1]

my term 2
Definition of my term 2

[1]

my term 3
Definition of my term 3

List references

By adding the configuration entry to the section configuration, you can enable displaying reference links directly to the definition of a glossary term.

This can either be done in the global definition:

plugins:
    ezglossary:
        inline_refs: none

or in the section configuration:

plugins:
    ezglossary:
        section_config:
            - name: demo
              inline_refs: short

Limitations

The following characters are not allowed to be used in sections and terms, however, you can replace them with html entities if you want to use them anyway:

Character Replacement
# (as first character) #
& (as first character) &
/ /
| ¦
" "
< &#lt;
> &#gt;
: &#58;
@ &#64;

Example

demo:fancy&#35;definition
:   a term using the # character

- See <demo:fancy&#35;definition>

Output

fency#definition
a term using the # character

Configuration

inline_refs

defines how to display references in the definitions.

Options:

none [default]
No inline references are linked in the term definition
short:
Short references in the format [1] are linked in the term definition
list:
A full list of references including the page name are added to the term definition.