Linking to a glossary entry¶

Basic¶

Link to this glossary definition using the following syntax. This will produce a link to the definition in your documentation:

-   See the <section:term> for details

Example

Link to the previously defined glossary term in the term section:

-   See the <demo:my_term1> for definition of term 1
-   See the <demo:my term 2> for definition of term 2

See the my_term1 for definition of term 1
See the my term 2 for definition of term 1

Case sensitivity¶

starting from version 1.7.0 [beta]

By default, this term definitions and references are case-sensitive, i.e. you need to use the exact spelling in your links as used in your term definition.

By setting ignore_case to true, the plugin will ignore the case in order to find definitions for your links.

Example

plugins:
    search
    ezglossary:
        ignore_case: true

See the MY_term1 for definition of term 1

Individual reference texts¶

By default the term is used as text for the link, however, you can override the term using the | modifier:

Example

-   You can define multiple <term:section|glossary sections>

You can define multiple glossary sections

Note

When using a link with individual reference texts in a table, you need to quote the |.

| row1                              | row2 |
|-----------------------------------|------|
| <term:section\|glossary sections> | ...  |

Handling plurals¶

starting from version 1.7.0a2 (not stable released yet)

A most common problem when linking to glossary terms is that you want to use the plural form of the word in the link text while linking to the term in singular.

Example

Definition:

GPU
:   A GPU is a ....

Linking:

Many <term:GPUs> support ...

Note

At this point of time, plural lookup is only available for the english language.

However, future versions may support additional langugaes (with your help). Furthermore a feature is planned to allow you to define your own rules for the lookup.

Lookup using the inflect library¶

The inflect library supports converting plurals to singulars, it has some advantages and drawbacks. If you want to use this library to convert plurals to singulars, you can add the following entry to the configuration:

plugins:
    search
    ezglossary:
      plurals: inflect

Looking up using the plugin's logic¶

This plugin has an own implementation logic to lookup singulars, which might not be perfect as well, but might catch some edge cases which the inflect library does not catch.

Try the own implementation by adding this configuration entry:

plugins:
    search
    ezglossary:
      plurals: en

Using markdown links¶

starting from version 1.6.0

When setting the markdown_links to true, ezglossary will also search for markdown links. If it identifies that a link points to a glossary entry, it will link it as well:

Note

When using unicode characters in term definitions, linking them using the <section:term> syntax might not work. In this case you have to use markdown links in order to link to those terms.

Note

In case your definition contains emojis, linking them using the <section:term> syntax will not work as well. In this case you have to use markdown links.

Example

my happy term :smile:
:   I am so happy

-   See [](my happy term)

plugins:
    search
    ezglossary:
      markdown_links: true

Example

-   See [](configuration:tooltip) for details
-   See [tooltips](configuration:tooltip) for details

Output

See tooltip for details
See tooltips for details

markdown_links: Defines wether ezglossary should also link markdown links to glossary entries.

Tooltips¶

The tooltip configuration allows you to control wether tooltips should be displayed with a preview on the definition:

plugins:
    search
    ezglossary:
      tooltip: [none, short, full]

Options:

none: Tooltips are disabled
short: The reference link shows the first line of the definition as a tooltip (link title)
full: The reference link shows the full definition as a tooltip.

Example

plugins:
    search
    ezglossary:
      tooltip: full

Active tooltips

Configuration¶

tooltip: Configure tooltips for reference links. Default is none.
plurals: Configure if and how the plugin shall lookup the term in singular if a plural is provided in the link text. See handling plurals for more details.
ignore_case: Set to true to ignore the case for terms in the definition lookup.