Quarto-glossary

This extension provides shortcodes for glossary in quarto.

Setup

Installing

quarto install extension debruine/quarto-glossary

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

Glossary file

You can store definitions in a YAML file. Use markdown to create paragraphs, links, and lists. Make sure each new line in a definition is indented two spaces (sorry YAML is a bit picky, but it’s the best human-editable solution).

SESOI: |
  Smallest Effect Size of Interest: the smallest effect that is theoretically or practically meaningful

  See [Equivalence Testing for Psychological Research](https://doi.org/10.1177/2515245918770963) for a tutorial on methods for choosing an SESOI.
p-value: |
  The probability of the observed data, or more extreme data, if the null hypothesis is true. The lower the p-value, the higher the test statistic, and less likely it is to observe the data if the null hypothesis is true.

Defaults

In the YAML header of your document, or the _quarto.yml file for your book or website, add the following defaults:

glossary:
  path: glossary.yml
  popup: click
  show: true

Set path to the path to your glossary YAML file, popup to “click”, “hover”, or “none”, and show to true or false. You can change these defaults for any individual inline glossary item.

Examples

The simplest use starts with the word glossary and then the term to be defined. Click on the underlined word to see a pop-up definition.

{{< glossary power >}}

Display

No need to change if you’re just using different case:

{{< glossary Power >}}

Use quotes if your term is more than one word.

{{< glossary "effect size" >}}

Add a display argument if you want to display something different than the term:

{{< glossary alpha display="alpha criterion" >}}

Popups

The default is “click”, which allows you to use styled html in the popup (see Styles below).

{{< glossary alpha popup="click" >}}

The “hover” option uses the web browser’s built-in tooltip styles, so you can’t use html in the definitions. However, you can now set the click event to open a link.

[{{< glossary alpha popup="hover" >}}](https://psyteachr.github.io/glossary/a#alpha)

Set popup to “none” if you want to add the definition to the glossary table, but not use a popup.

{{< glossary alpha popup="none" >}}

Definitions

If you need to include a definition for a term that is not in the glossary file or is different from the one in the glossary file, you can set the def argument.

{{< glossary quarto def="An open-source scientific and technical publishing system" >}}

Add to Table

If you don’t want to add a glossary item to the table, set add_to_table=false.

{{< glossary SESOI add_to_table=true >}}

{{< glossary R def="The best language" add_to_table=false >}}

Table

If you set table=true, you will get a glossary table with all the terms you’ve defined on this page.

{{< glossary table=true >}}

Term	Definition
alpha	The threshold chosen in Neyman-Pearson hypothesis testing to distinguish test results that lead to the decision to reject the null hypothesis, or not, based on the desired upper bound of the Type 1 error rate. An alpha level of 5% is most commonly used, but other alpha levels can be used as long as they are determined and preregistered by the researcher before the data is analyzed.
effect size	‘quantitative reflection of the magnitude of some phenomenon that is used for the purpose of addressing a question of interest’ (Kelley & Preacher, 2012)
sesoi	Smallest Effect Size of Interest: the smallest effect that is theoretically or practically meaningfulSee Equivalence Testing for Psychological Research for a tutorial on methods for choosing an SESOI.
power	The probability of rejecting the null hypothesis when it is false, for a specific analysis, effect size, sample size, and criteria for significance.
quarto	An open-source scientific and technical publishing system