Org Glossary

• Functionality
• Example
• Installation
  • Straight
  • Doom

Functionality

There are four major pieces of functionality this package provides

• Glossary
• Acronyms
• Index
• Text substitutions

Within specially named sections, Glossary terms, Acronyms, and Text substitutions are defined using definition lists, using the following forms:

- term :: definition         # implicit plural form
- term, terms :: definition  # explicit plural form

Indexed terms are defined using normal lists, using the pattern of the definition list tags above.

Then, all uses of defined terms in the document are picked up and on export Glossary/Acronym/Index sections are appended to the document.

Example

Apple and ACRs, why not substitute something.
: An apple and ACR, why not substitute something.

Mentioning apple again, and now bananas.

This is an org document.

* Glossary
- apple :: A fruit.
- banana :: Another fruit.
- pear :: Yet another fruit.
* Acronyms
- ACR :: Absolutely Credible acRonym
* Text Substitutions
- substitute :: replace
* Index Terms
- org

Installation

Straight

(use-package org-glossary
  :straight (:host github :repo "tecosaur/org-glossary"))

Doom

;; $DOOMDIR/packages.el
(package! org-glossary
  :recipe (:host github :repo "tecosaur/org-glossary"))

;; $DOOMDIR/config.el
(use-package! org-glossary :after org)