Skip to content

Allow for a 'backlink' generated solution in Glossary / linking #85

@GerwinLaagland

Description

@GerwinLaagland

A notation method to link to a 'in context' location inside the glossary, so that people can navigate from the glossary to the place (or places) where they can read more about a term inside that context. This allows for navigation to and from glossary as well.

We could keep the current :term[...] notation and extend it only for the special cases where we want a glossary backlink.

Examples:

:term[Variable Scope]
:term[test cases]{term="Test Case"}
:term[Variable Scope]{source="#variable-scope-explained"}
:term[test cases]{term="Test Case" source="/docs/tests#test-case-structure"}

Proposal:

  • Keep :term[...] as the standard glossary link syntax.
  • Keep {term="..."} for alias text.
  • Add an optional source="..." attribute for the few cases where a glossary entry should offer a “read more” backlink into the docs.
  • If no source is given, no backlink is created in the glossary entry.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request
    No fields configured for Feature.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions