Skip to content

Latest commit

 

History

History
90 lines (58 loc) · 4.75 KB

README.md

File metadata and controls

90 lines (58 loc) · 4.75 KB
Raw

Glossary Extension For Quarto

Add a glossary to your document.

Installing

quarto add andrewpbray/glossary

This will install the extension under the _extensions subdirectory. If you're using version control, you will want to check in this directory.

Using

Creating the glossary consists of three steps:

  1. Activate the filter
  2. Define location of glossary
  3. Specify glossary contents

1. Activate the filter

The filter can be activated on a document through the filters key in the metadata.

---
filters:
  - glossary
---

2. Define location of glossary

The glossary can be added anywhere in the document by inserting a block with a unique id of your choosing. Here, that id is my-glossary.

The glossary will appear below this line of text.

:::{#my-glossary}
:::

Here is some more text in the document.

3. Specify glossary contents

The content that will fill in your new glossary block are specified in the document metadata through the glossary key, which has three options: id, class, and contents. For example:

---
filters:
  - glossary
glossary:
  - id: my-glossary
    class: definition
    contents:
      - "ex*"
---

This specifies that the glossary with the id of my-glossary will contain any blocks that have the class definition within all files in the document (or project) working directory that begin with ex. Note some details about each of these options:

  • id: a valid YAML string that matches the id of the block that you created in step 1. When creating the block in the document body, the id begins with # but here metadata the # is omitted. Note that certain id prefixes like def-list and thm-set will trigger Quarto to add in cross-references (which is likely undesirable in this implementation of a glossary). See the cross-references documentation for affected prefixes.

  • class: a valid YAML string that matches the class of any blocks in any targeted documents that you wish you include in the glossary. As an example, see ex-animals.qmd, where there appear two blocks with the .definition class. When adding the class to a block, the class name begins with a . but in the YAML option here the . is omitted.

  • contents: A list of files to scan through for blocks that meet the specified class. These can be a YAML list of full file paths (ending in .qmd, .md, or .ipynb) or include globs, as in the example here, to indicate multiple files ("ex*" matches both ex-plants.qmd and ex-animals.qmd).

    Further details:

    • Directories and files that begin with . and _ will be ignored, as will files called README.md and README.qmd. So too, will any file not ending in .qmd, .md, and .ipynb.

    • If the contents key does not appear in the metadata, the filter will scan all files in the working directory that meet the above criteria.

    • Globs can be used to match multiple files with a single pattern. *, for example, is a wildcard character that can be used to match 0 or more of any character and a glob prefixed with ! will ignore files that match the glob.

    • Lua has no built-in way to process globs, so this filter includes an implementation written by @davidm. Globs in base Quarto are implemented in TypeScript, so the files matched by a glob in this filter may differ from the files matched by the same glob when, say, specifying the contents for a listing.

      If you run into issues using this glob syntax, it may be helpful to check the logs (appearing as a background job) to see the list of files matching the contents that will be scanned for blocks.

Each of the options should be specified, as in the example above, as an item in a yaml list (behind a -). This permits the inclusion of multiple glossaries within the same document (see example-2.qmd).

Example

See example.qmd for an example of a document that inserts a glossary of definitions from two other files: ex-plants.qmd and ex-animals.qmd.

Compatibility

This filter operates before any of the format-specific writer filters, so it should work for a wide range of output formats. It has been tested and shown to work on html, pdf, revealjs, and docx.

In terms of system settings, this filter has been tested on MacOS and Ubuntu. It has not been tested on Windows and may fail on that OS due to the manner in which the lua filter scans the file system for matches to the glob. If that indeed is an issue, PRs welcome.