Repository navigation
Releases
Simple Glossary 0.2.0
Simple Glossary 0.2.0 — release notes
New: add a term without opening the glossary
Add a term to the glossary is a new command that opens a small window with a box for the term and a box for what it means.
- Enter saves and Escape cancels.
- If you have text selected in a note when you run the command, it is filled in as the term.
- If the term is already in the glossary, in any combination of capitals, the window tells you as you type and won't save it.
- A term can be up to 40 characters, and can't contain any of these characters:
: * _ ` [ ] # | < >. These characters would stop the plugin reading it back as a term. Terms likeCI/CD,C++,R&Dand5Gare fine. - If the glossary note doesn't exist yet, it is created.
The command has no hotkey to start with. Give it one in Settings → Hotkeys: search for "Simple Glossary".
The glossary stays sorted
The new term is added as a plain list item, - TERM: what it means. The glossary's list is then sorted A–Z by the term alone:
- Bold, links,
[[…]]and capitals are ignored, and numbers sort as numbers (5G before 10G). - If the glossary has lists under separate headings, each list is sorted on its own, and the new term goes into the longest list.
- Lines indented under an entry move with it.
- Each list keeps a single bullet style, and numbered lists are renumbered, so a stray
1.among-items doesn't split the list in two.
Headings, text and everything else in the note stay where they are.
Privacy
This is the first version of Simple Glossary that writes to a note. It writes only to your glossary note, and only when you press Save in the new window. It still makes no network requests, and it doesn't change any other note.
Simple Glossary 0.1.1
Simple Glossary 0.1.1 — release notes
The first release of Simple Glossary, an Obsidian plugin for desktop. It marks the terms from your glossary note wherever they appear in your other notes, and explains each one in a tooltip when you hover over it.
What it does
- Reads a glossary note of list items such as
**ADM**: Audio Definition Model,[RAG](url) Retrieval-Augmented Generationor[[SYMCA]]: South Yorkshire Mayoral Combined Authority. Hashtags are removed from the explanation, and the first web address becomes a link in the tooltip. - Marks terms in Reading view and while editing.
- Matches whole words only, and is case-sensitive.
- Matches simple plurals ("BAs"), unless you turn that off.
- By default, marks only the first time each term appears in a note.
- Leaves code, headings, tags, web addresses, frontmatter and comments alone.
- Links to a term, such as
[[SYMCA]], get the tooltip as well, and still work as links. - Clicking a term in Reading view opens the glossary at that entry. While editing, Ctrl-click it (Cmd-click on a Mac). The tooltip also has an "Open in glossary" link.
- When you choose the glossary note in settings, matching notes are suggested as you type. The plugin reloads the glossary whenever you save it, and follows it if you rename or move it.
Privacy
Simple Glossary reads your notes and never changes them. It makes no network requests.