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

Create a glossary for RISC-V #1

Open
kersten1 opened this issue Mar 7, 2024 · 2 comments
Open

Create a glossary for RISC-V #1

kersten1 opened this issue Mar 7, 2024 · 2 comments
Labels

Comments

@kersten1
Copy link
Collaborator

kersten1 commented Mar 7, 2024

There is a glossary topic here - https://github.com/riscv/riscv-glossary.

This topic needs to be spruced up and then can be distributed as part of the HTML, unless we decide that it is worth of inclusion in the ISA PDFs.

@kbroch-rivosinc
Copy link
Collaborator

I can imagine including the whole RISCV glossary in some specs would be overkill but if it was useful, I would submodule the repo in and then include like this: https://docs.asciidoctor.org/asciidoc/latest/sections/glossary/#glossary-section-syntax

There's also the possibility of using tags in the glossary items to allow partial inclusion https://docs.asciidoctor.org/asciidoc/latest/directives/include/#include-syntax

Finally many glossary items are acronyms, I am going to explore creating #31. With something like this we could get interesting functionality like:

  • mouseover tooltips in HTML that show what the acronym means
  • PDF would just link to definition in glossary
  • spell out acronym first time it is used but not after

@kersten1
Copy link
Collaborator Author

kersten1 commented May 7, 2024

First part of this is complete - the glossary exists - https://github.com/riscv/riscv-glossary/

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

No branches or pull requests

2 participants