{
    "info": {
        "author": "Anton Bukhtiyarov",
        "author_email": "apkraft@gmail.com",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 5 - Production/Stable",
            "Environment :: Console",
            "Intended Audience :: Developers",
            "License :: OSI Approved :: MIT License",
            "Operating System :: OS Independent",
            "Programming Language :: Python",
            "Topic :: Documentation",
            "Topic :: Utilities"
        ],
        "description": "# Glossary collector for Foliant\n\nGlossary preprocessor collects terms and definitions from the files stated and inserts them to specified places of the document.\n\n\n## Installation\n\n```shell\n$ pip install foliantcontrib.glossary\n```\n\n\n## Config\n\nTo enable the preprocessor, add `glossary` to `preprocessors` section in the project config.\n\n```yaml\npreprocessors:\n  - glossary\n```\n\nThe preprocessor has a number of options (default values stated below):\n\n```yaml\npreprocessors:\n  - glossary:\n        term_definitions: 'term_definitions.md'\n        definition_mark: ':   '\n        files_to_process: ''\n```\n\n`term_definitions`\n:   Local or remote file with terms and definitions in Pandoc [definition_lists](https://pandoc.org/MANUAL.html#definition-lists) notation (by default this file stored in foliant project folder, but you can place it other folder). Also you can use [includes](https://foliant-docs.github.io/docs/preprocessors/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.\n\n`definition_mark`\n:   Preprocessor uses this string to determine, if the definition should be inserted here. `\":   \"` for Pandoc [definition_lists](https://pandoc.org/MANUAL.html#definition-lists) notation.\n\n`files_to_process`\n:   You can set certain files to process by preprocessor.\n\n\n## Usage\n\nJust add the preprocessor to the project config, set it up and enjoy the automatically collected glossary in your document.\n\n\n## Example\n\n**foliant.yml**\n\n```yaml\n...\nchapters:\n    - text.md\n\npreprocessors:\n...\n    - includes\n    - glossary\n...\n```\n\n**term_definitions.md**\n\n```\n# Glossary\n\n<include nohead=\"true\">\n    $https://git.repo/repo_name_1$src/glossary_1.md\n</include>\n\n<include nohead=\"true\">\n    $https://git.repo/repo_name_2$src/glossary_2.md\n</include>\n```\n\n**glossary_1.md** from **repo_1**\n\n```\n# Glossary\n\nTerm 1\n\n:   Definition 1\n\nTerm 2\n\n:   Definition 2\n\nTerm 3\n\n:   Definition 3\n\n```\n\n**glossary_2.md** from **repo_2**\n\n```\n# Glossary\n\nTerm 4\n\n:   Definition 4\n\n        { some code, part of Definition 4 }\n\n    Third paragraph of definition 4.\n\nTerm 5\n\n:   Definition 5\n\n```\n\n**text.md**\n\n```\n# Main chapter\n\nSome text.\n\n# Glossary\n\n:   Term 1\n\n:   Term 4\n\n:   Term 2\n\n```\n\n**\\_\\_all\\_\\_.md**\n\n```\n# Main chapter\n\nSome text.\n\n# Glossary\n\nTerm 1\n\n:   Definition 1\n\n\nTerm 4\n\n:   Definition 4\n\n        { some code, part of Definition 4 }\n\n    Third paragraph of definition 4.\n\n\nTerm 2\n\n:   Definition 2\n\n```\n\n\n",
        "description_content_type": "text/markdown",
        "docs_url": null,
        "download_url": "",
        "downloads": {
            "last_day": -1,
            "last_month": -1,
            "last_week": -1
        },
        "home_page": "https://github.com/foliant-docs/foliantcontrib.glossary",
        "keywords": "",
        "license": "MIT",
        "maintainer": "",
        "maintainer_email": "",
        "name": "foliantcontrib.glossary",
        "package_url": "https://pypi.org/project/foliantcontrib.glossary/",
        "platform": "any",
        "project_url": "https://pypi.org/project/foliantcontrib.glossary/",
        "project_urls": {
            "Homepage": "https://github.com/foliant-docs/foliantcontrib.glossary"
        },
        "release_url": "https://pypi.org/project/foliantcontrib.glossary/1.0.0/",
        "requires_dist": [
            "foliant (>=1.0.10)",
            "foliantcontrib.includes (>=1.1.6)"
        ],
        "requires_python": "",
        "summary": "Preprocessor for Foliant for collecting document glossary.",
        "version": "1.0.0"
    },
    "last_serial": 5895583,
    "releases": {
        "1.0.0": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "90a45edc8c8506b755269451b682d8bf",
                    "sha256": "49d86fe79ec07a1c97814eb83c236c3155d318a0e7b2d4eaf28165bed662b8eb"
                },
                "downloads": -1,
                "filename": "foliantcontrib.glossary-1.0.0-py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "90a45edc8c8506b755269451b682d8bf",
                "packagetype": "bdist_wheel",
                "python_version": "py3",
                "requires_python": null,
                "size": 4452,
                "upload_time": "2019-09-27T11:15:17",
                "url": "https://files.pythonhosted.org/packages/5c/e0/f3a6e033a6310a214376fdad86f682bb44417d70d1d97696fa1d60659a77/foliantcontrib.glossary-1.0.0-py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "4f7c2d281c8ce85301699e8115c8a38b",
                    "sha256": "715b2fbf04b95e2ab671bc390a04762f57fc6fa7b34cfd4c5cb22f44e1010366"
                },
                "downloads": -1,
                "filename": "foliantcontrib.glossary-1.0.0.tar.gz",
                "has_sig": false,
                "md5_digest": "4f7c2d281c8ce85301699e8115c8a38b",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 3540,
                "upload_time": "2019-09-27T11:15:19",
                "url": "https://files.pythonhosted.org/packages/4e/22/b992b179e42dca889c86943e06f31bcd0cbaa4ff26ac5a155e297fefe840/foliantcontrib.glossary-1.0.0.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "90a45edc8c8506b755269451b682d8bf",
                "sha256": "49d86fe79ec07a1c97814eb83c236c3155d318a0e7b2d4eaf28165bed662b8eb"
            },
            "downloads": -1,
            "filename": "foliantcontrib.glossary-1.0.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "90a45edc8c8506b755269451b682d8bf",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 4452,
            "upload_time": "2019-09-27T11:15:17",
            "url": "https://files.pythonhosted.org/packages/5c/e0/f3a6e033a6310a214376fdad86f682bb44417d70d1d97696fa1d60659a77/foliantcontrib.glossary-1.0.0-py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "4f7c2d281c8ce85301699e8115c8a38b",
                "sha256": "715b2fbf04b95e2ab671bc390a04762f57fc6fa7b34cfd4c5cb22f44e1010366"
            },
            "downloads": -1,
            "filename": "foliantcontrib.glossary-1.0.0.tar.gz",
            "has_sig": false,
            "md5_digest": "4f7c2d281c8ce85301699e8115c8a38b",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 3540,
            "upload_time": "2019-09-27T11:15:19",
            "url": "https://files.pythonhosted.org/packages/4e/22/b992b179e42dca889c86943e06f31bcd0cbaa4ff26ac5a155e297fefe840/foliantcontrib.glossary-1.0.0.tar.gz"
        }
    ]
}