Skip to main content

Preprocessor for Foliant for collecting document glossary.

Project description

Glossary collector for Foliant

Glossary preprocessor collects terms and definitions from the files stated and inserts them to specified places of the document.

Installation

$ pip install foliantcontrib.glossary

Config

To enable the preprocessor, add glossary to preprocessors section in the project config.

preprocessors:
  - glossary

The preprocessor has a number of options (default values stated below):

preprocessors:
  - glossary:
        term_definitions: 'term_definitions.md'
        definition_mark: ':   '
        files_to_process: ''

term_definitions : Local or remote file with terms and definitions in Pandoc definition_lists notation (by default this file stored in foliant project folder, but you can place it other folder). Also you can use includes in this file to join several glossary files. In this case includes preprocessor should be stated before glossary in foliant.yml preprocessors section. Note that if several definitions of one term are found, only first will be used.

definition_mark : Preprocessor uses this string to determine, if the definition should be inserted here. ": " for Pandoc definition_lists notation.

files_to_process : You can set certain files to process by preprocessor.

Usage

Just add the preprocessor to the project config, set it up and enjoy the automatically collected glossary in your document.

Example

foliant.yml

...
chapters:
    - text.md

preprocessors:
...
    - includes
    - glossary
...

term_definitions.md

# Glossary

<include nohead="true">
    $https://git.repo/repo_name_1$src/glossary_1.md
</include>

<include nohead="true">
    $https://git.repo/repo_name_2$src/glossary_2.md
</include>

glossary_1.md from repo_1

# Glossary

Term 1

:   Definition 1

Term 2

:   Definition 2

Term 3

:   Definition 3

glossary_2.md from repo_2

# Glossary

Term 4

:   Definition 4

        { some code, part of Definition 4 }

    Third paragraph of definition 4.

Term 5

:   Definition 5

text.md

# Main chapter

Some text.

# Glossary

:   Term 1

:   Term 4

:   Term 2

__all__.md

# Main chapter

Some text.

# Glossary

Term 1

:   Definition 1


Term 4

:   Definition 4

        { some code, part of Definition 4 }

    Third paragraph of definition 4.


Term 2

:   Definition 2

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for foliantcontrib.glossary, version 1.0.0
Filename, size File type Python version Upload date Hashes
Filename, size foliantcontrib.glossary-1.0.0-py3-none-any.whl (4.5 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size foliantcontrib.glossary-1.0.0.tar.gz (3.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page