Printing a summary

Basic

Place a summary of all definitions for a section anywhere in your documentation:

# Terms and Definitions

<glossary::demo>

Example

Lets generate the summary for the section term:

# Demo terms

<glossary::demo>

This will produce the following summary. Note that the summary contains links to all definitions (def) and references (ref) to all terms in your documentation:

Output

fency#definition

• Defining glossary entries
• Defining glossary entries

fency#definition

my term 2

• Linking to a glossary entry
• Defining glossary entries

my term 3

• Defining glossary entries

my_term1

• Linking to a glossary entry
• Defining glossary entries

page_reference

• Page references
• Page references

Overriding the output behaviour

Override the default values for list_definitions and list_references by placing a modifier behind the glossary reference:

<glossary::demo|no_refs>

Note

When overriding the output behaviour in summaries printed in a table, you need to quote the |:

| row1                     | row2 |
|--------------------------|------|
| <glossary:demo\|no_refs> | ...  |

no_refs

Dont add reference links to the summary.

<glossary::demo|no_refs>

output

fency#definition

• Defining glossary entries

fency#definition

my term 2

• Defining glossary entries

my term 3

• Defining glossary entries

my_term1

• Defining glossary entries

page_reference

• Page references

no_defs

Don't add definitions to the summary:

<glossary::demo|no_defs>

output

fency#definition

• Defining glossary entries

fency#definition

my term 2

• Linking to a glossary entry

my term 3

my_term1

• Linking to a glossary entry

page_reference

• Page references

do_defs and do_refs

<glossary::demo|do_defs+do_refs>

output

fency#definition

• Defining glossary entries
• Defining glossary entries

fency#definition

my term 2

• Linking to a glossary entry
• Defining glossary entries

my term 3

• Defining glossary entries

my_term1

• Linking to a glossary entry
• Defining glossary entries

page_reference

• Page references
• Page references

Configuration

list_definitions

If set to false, definitions are not listed in the summary. Default is true.

GlobalPer section

plugins:
    - search
    - ezglossary:
        - list_definitions: false

plugins:
    - search
    - ezglossary:
        sections:
            demo
        section_config:
            - name: demo
              list_references = true

        - list_definitions: false

list_references

If set to false, references are not listed in the summary. Default is true.

GlobalPer section

plugins:
    - search
    - ezglossary:
        - list_references: false

plugins:
    - search
    - ezglossary:
        sections:
            demo
        section_config:
            - name: demo
              list_references = true

        - list_references: false

Themes

Passing a theme option to the <glossary::section> statement will load a customized jinja template for that theme named summary-<theme>.html.

<glossary::demo|theme=detailed>

Example

This theme shows the term definitions in the glossary:

Quote

fency#definition

a term using the # character

• Defining glossary entries

fency#definition

my term 2

Definition of my term 2

• Linking to a glossary entry

my term 3

Definition of my term 3

my_term1

Definition of my_term 1

• Linking to a glossary entry

page_reference

Page references

• Page references

Available themes are:

detailed:

Shows the definition of the term in the summary.

table:

Uses tables to display the summary

Further reading

• Read the sections documentation to see how to configure sections.