Abbr Extension: Definition Sorting and Glossary storage #1467
Conversation
list by length before processing the element tree This ensures that multi-word abbreviations are implemented even if an abbreviation exists for one of those component words. To test this, added `test_abbr_superset_vs_subset()` to `tests.test_syntax.extensions.test_abbr`.
handling for empty abbreviations. - Configuration option `use_last_abbr` allows using the first instance of a term rather than the last. This is useful for sites that auto-append a glossary to pages. - If an abbreviation does not have a definition it will skip the term instead of writing abbr tags with an empty title.
The glossary file also uses the Markdown abbreviation syntax (`AbbrBlockprocessor` is used to process the file) and keeps the glossary definitions separate from the page definitions, allowing the glossary to be applied to every page while only being processed once.
|
So far I've only taken a cursory look at your changes. Here are my initial thoughts.
This is good. I should have caught the issue this fixes with the recent refactor. Thank you.
I'm not sure I am comfortable with this. In our discussion in #1465 I suggested allowing a user to pass in a Python object (such as a dict), not importing a file of Markdown content. I'm inclined to reject this on the basis that extensions already exist which allow Markdown content to be imported.
As previously explained, I don't see any value in this. You still need to ensure your definitions are in a certain order. That order is now reversed which is counterintuitive (IMO) and works the opposite of every other reference-type syntax (reference links, footnotes, etc) in Markdown. I realize this is an option which if off by default, but with there being no value to changing the setting, then why even offer it? That said, if you can provide a concrete example which demonstrates its value and changes my mind, then I would suggest renaming it |
to accept a dictionary instead of a file. Changed `load_glossary` to merge in a dictionary, overwriting any existing records. Added a `reset_glossary` method to clear the glossary. Removed the `use_last_abbr` option, since `glossary` can be used to resolve the use case `use_last_abbr` was written for.
nbanyan
changed the title
|
Discarded |
Completed removal of artifacts from removing `use_last_abbr` and updated documentation.
Also added testing to avoid having an abbreviation
where `{"": "Definition"}`.
|
@nbanyan thanks for the work on this. Much appreciated. |
Several changes/features here. All input welcome on each.
glossary: An option to include a Markdown file with abbreviations to apply to every page.use_last_abbr: An option to only keep the first instance of an abbreviation (useful when using other methods to append glossaries to pages).The glossary ended up being the more complex of the three and involved replicating some of the code/process from core.py.