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

Dynamic Glossary collation #3370

Open
dbolack-ab opened this issue Mar 21, 2024 · 2 comments
Open

Dynamic Glossary collation #3370

dbolack-ab opened this issue Mar 21, 2024 · 2 comments
Labels
Approved Has been discussed and an approach is agreed upon New Snippet Proposed new snippet, for any theme

Comments

@dbolack-ab
Copy link
Collaborator

dbolack-ab commented Mar 21, 2024

Your idea:

Dynamic Glossary collation follows the pattern set up in Rich Indexes and definition lists.

Arbitrarily placed markdown is placed in the brew text and then collated and ordered by a snippet which outputs any number of glossary lists.

Markdown Format:
The markdown takes one of two shapes, each as a single line entry.

  1. #Glossary Term :: Glossary Definition - This creates a term/definition pair and places it on the default glossary list Glossary
  2. #GlossaryList Glossary Term :: Glossary Definition - This creates a term/definition pair and places it on the user-created glossary list GlossaryList

Markdown details:
In both cases, the markdown is consumed on parsing.

Snippet Details:
The snippet runs its own parsing of the markdown from the brew and places it in the designated Glossary List.
Duplicate terms will have their Definitions collected for shared output.
Each list will be ordered by term.
Output for each list will have the list name as an H2 header, followed by the list rendered as a PanDoc style

list followed by a \page

@ericscheid
Copy link
Collaborator

ericscheid commented Mar 21, 2024

Looks good.

I assume that the presence of the double-colon :: is what distinguishes this syntax from the index-marking syntax of #3369?

Slight suggestion might be to use single column to terminate the glossary-list-name, like this
#Glossary List Name: Term :: Glossary Definition

@dbolack-ab
Copy link
Collaborator Author

I assume that the presence of the double-colon :: is what distinguishes this syntax from the index-marking syntax of #3369?

Correct.

Slight suggestion might be to use single column to terminate the glossary-list-name, like this #Glossary List Name: Term :: Glossary Definition

This is a good idea, though I think I want to want and see how the discussion shakes out on putting the list name at the end in 3369 and use the same pattern in both places.

@5e-Cleric 5e-Cleric added Approved Has been discussed and an approach is agreed upon New Snippet Proposed new snippet, for any theme labels Apr 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved Has been discussed and an approach is agreed upon New Snippet Proposed new snippet, for any theme
Projects
None yet
Development

No branches or pull requests

3 participants