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

Glossary of Terms and Tooltip on abbreviations #50

Open
adam2k opened this issue Oct 18, 2022 · 4 comments
Open

Glossary of Terms and Tooltip on abbreviations #50

adam2k opened this issue Oct 18, 2022 · 4 comments

Comments

@adam2k
Copy link
Contributor

adam2k commented Oct 18, 2022

This is a feature request split into two parts:

  1. Add a glossary of the abbreviations used throughout the document
  2. As a follow up, add tooltips to enable mouse over interactions that quickly display the full expansion of the abbreviations (or something similar)
@adam2k
Copy link
Contributor Author

adam2k commented Oct 18, 2022

I started my own personal glossary of these terms, so I'm willing to help out with this.

@willcl-ark
Copy link
Collaborator

willcl-ark commented Oct 19, 2022

I think this could be pretty useful for new contributors and would be interested to see a draft PR with the terms in!

My initial thoughts would be to have the glossary as it's own file (glossary.adoc) where items are in a description list format.

Then create a link to it in index.adoc with an include as with the other sections..

Regarding the second point, I agree this would be nice, but know of no way to implement this in the current asciidoc format, without using some wizardry which I do not have the capabilites for! (I think it would have to be done with a custom inline macro, but not sure even this would work as I don't know how to link to a specific description list item...)

@adam2k
Copy link
Contributor Author

adam2k commented Oct 24, 2022

Thanks @willcl-ark. The second part is a nice to have, but I can certainly open up a PR for a new glossary.adoc and then we can take it from there.

I dug into the asciidoc format docs and I agree, I can't find an easy way to do this at the moment either.

@willcl-ark
Copy link
Collaborator

Merged a first draft.

I'd like to keep this open as I think a few of the terms could do with revising, and a few new terms be added :)

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

Successfully merging a pull request may close this issue.

2 participants