Skip to content

[RFC] Support Acronyms - #298

Open
cplappert wants to merge 2 commits into
mainfrom
acronyms
Open

cplappert wants to merge 2 commits into
mainfrom
acronyms

Conversation

@cplappert

@cplappert cplappert commented Oct 15, 2026 •

Copy link
Copy Markdown
Contributor

Add filters to process acronyms found in markdown

This commit adds a filter that automatically searches the Markdown file for acronyms that match those in a provided list of acronyms.
It inserts the full form the first time the acronym is used and creates a list of used acronyms to be placed in the document using the keyword \listofacronyms.

Activation

The acronym processing is activated by adding the keyword acronyms and a corresponding file, e.g., my_acronyms.yml, in the document's metadata.

Markdown file

---
title: "TITLE"
type: GUIDANCE
bibliography: bibliography.yml
csl: ieee.csl
acronyms: my_acronyms.yml
...

---

my_acronyms.yml

HTML:
  long: HyperText Markup Language

PDF:
  long: Portable Document Format
  longplural: Portable Document Formats # custom long plural form
  shortplural: PDFs  # custom short plural form

Filters

  1. The filter acronyms.lua will search for acronyms in the markdown and expand on first occurrence.
  2. The filter acronym-list.lua will prepare a table for each used acronym and create a list of acronyms. The acronym list is placed at the end of the document or at the place where the keyword \listofacronyms is placed.

Note on backwards compatibility

If there is no acronyms.yml provided by the user, no acronyms are expanded and no list of acronyms is created.

@cplappert
cplappert force-pushed the acronyms branch 2 times, most recently from 8770fb1 to 910dfdf Compare October 19, 2026 09:52
@chrisfenner

Copy link
Copy Markdown
Member

Hi @cplappert,

This is a very cool feature but I'm a bit worried about maintaining yet another large LUA script in this repository. Is it possible for you to set up your workflow so that you depend on this one but add the plugin on your side?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants