Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Abbr Extension: Definition Sorting and Glossary storage #1467

Merged
merged 7 commits into from
Jun 11, 2024

Commits on May 22, 2024

  1. AbbrTreeprocessor now sorts the abbreviation

    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`.
    nbanyan committed May 22, 2024
    Configuration menu
    Copy the full SHA
    37922a7 View commit details
    Browse the repository at this point in the history

Commits on May 23, 2024

  1. Added a configuration option to abbr and

    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.
    nbanyan committed May 23, 2024
    Configuration menu
    Copy the full SHA
    9fed7aa View commit details
    Browse the repository at this point in the history

Commits on Jun 3, 2024

  1. Added a glossary option for the abbr extension

    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.
    nbanyan committed Jun 3, 2024
    Configuration menu
    Copy the full SHA
    2009c02 View commit details
    Browse the repository at this point in the history

Commits on Jun 5, 2024

  1. Changed Abbreviation Extension's glossary option

    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 committed Jun 5, 2024
    Configuration menu
    Copy the full SHA
    831449b View commit details
    Browse the repository at this point in the history

Commits on Jun 6, 2024

  1. Some linting and cleanup around abbr extension

    Completed removal of artifacts from removing
    `use_last_abbr` and updated documentation.
    nbanyan committed Jun 6, 2024
    Configuration menu
    Copy the full SHA
    4f85734 View commit details
    Browse the repository at this point in the history

Commits on Jun 10, 2024

  1. Added proper syntax for disabling an abbreviation

    Also added testing to avoid having an abbreviation
    where `{"": "Definition"}`.
    nbanyan committed Jun 10, 2024
    Configuration menu
    Copy the full SHA
    c2e16f4 View commit details
    Browse the repository at this point in the history
  2. Configuration menu
    Copy the full SHA
    4de06b1 View commit details
    Browse the repository at this point in the history