quarto-dev / quarto-dev/quarto-cli

Feature request: Glossary

Open
#1,697 23 comments 51 reactions 1 assignee View on GitHub

@cscheid is already working on this.

Since Nov 15, 2022.

crossref enhancement
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

I'd like to suggest a first-class glossary in quarto, where you can link terms in the text to definitions (perhaps displayed on hover) and collect defined terms into an optional glossary table or section at the end of a chapter or the end of a book.

See this twitter thread for discussion about this with Thomas Mock and the psyTeachR glossary package for a model of what I'm thinking about, implemented in R.

Some ideas

It could require defining terms somehow in the text each time, like:

{{< gls [term](This is my definition.) >}}

Or there could be a glossary file similar to _variable.yml that you can use to link terms to:

{{< gls [text-term](file-term) >}}

This letter option might be better, as you often want to link the same term several times, or link different forms (e.g., the definition might be for "argument", but your sentence is "There are several arguments you need to set.").

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.