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

ENH: Add a site-wide glossary and index of acronyms #77

Open
rossbar opened this issue Sep 17, 2021 · 2 comments
Open

ENH: Add a site-wide glossary and index of acronyms #77

rossbar opened this issue Sep 17, 2021 · 2 comments
Labels
enhancement New feature or request

Comments

@rossbar
Copy link
Member

rossbar commented Sep 17, 2021

I'm thinking something along the lines of what sphinx has with the :term: and :abbr: roles, where the former links the term to a glossary entry, and the latter adds a pop-up box that shows the full name associated with an acronym when a user hovers over the link with their cursor.

I haven't looked closely, so it's possible the mainroad theme already supports some or all of this. If not, maybe this functionality could be added via shortcodes.

Not a critical feature by any means, I just thought it'd be a nice improvement given the number of new terms and acronyms that are on the site.

@rossbar rossbar added the enhancement New feature or request label Sep 17, 2021
@stefanv
Copy link
Member

stefanv commented Sep 17, 2021

Would this automatically be added to each page, or would you manually have to add it for each keyword? The prior would make sense to me, but may be a tad trickier to implement. Probably not too hard to do if we pre-process the text, or add a filter to Hugo in our template.

@rossbar
Copy link
Member Author

rossbar commented Sep 17, 2021

or would you manually have to add it for each keyword? The prior would make sense to me, but may be a tad trickier to implement.

Good point - I was locked into the role-markup mindset, but automatically cross-linking glossary terms and abbreviations would certainly be nice. 👍 to this idea!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants