From dbf72551a8ad03b594610f47ebc9d7bfb7be7720 Mon Sep 17 00:00:00 2001
From: NGPixel <github@ngpixel.com>
Date: Fri, 28 Aug 2026 19:31:17 -0400
Subject: [PATCH] feat: add insert abbr button in markdown editor

---
 backend/locales/en.json                    |  3 ++
 frontend/src/assets/icons.generated.js     |  3 +-
 frontend/src/components/EditorMarkdown.vue | 48 +++++++++++++++++++---
 3 files changed, 48 insertions(+), 6 deletions(-)

diff --git a/backend/locales/en.json b/backend/locales/en.json
index 34fe7beda..3e2d99809 100644
--- a/backend/locales/en.json
+++ b/backend/locales/en.json
@@ -1736,6 +1736,8 @@
   "editor.localeRel.selectPage": "Select Page",
   "editor.localeRel.thisPage": "This page",
   "editor.localeRel.title": "Locale Relations",
+  "editor.markup.abbreviationDefinition": "Definition",
+  "editor.markup.abbreviationTerm": "TERM",
   "editor.markup.admonitionDanger": "Caution Admonition",
   "editor.markup.admonitionImportant": "Important Admonition",
   "editor.markup.admonitionInfo": "Note Admonition",
@@ -1758,6 +1760,7 @@
   "editor.markup.heading": "Heading {level}",
   "editor.markup.highlight": "Highlight",
   "editor.markup.inlineCode": "Inline Code",
+  "editor.markup.insertAbbreviation": "Insert Abbreviation",
   "editor.markup.insertAssets": "Insert Assets",
   "editor.markup.insertBlock": "Insert Block",
   "editor.markup.insertCodeBlock": "Insert Code Block",
diff --git a/frontend/src/assets/icons.generated.js b/frontend/src/assets/icons.generated.js
index e14a5a8ad..dd0dfeb4c 100644
--- a/frontend/src/assets/icons.generated.js
+++ b/frontend/src/assets/icons.generated.js
@@ -5,7 +5,7 @@
   never waits on (or depends on) the icon service. Regenerate with `npm run icons` after adding or
   removing an icon; `check-icons.mjs` fails the build if this drifts.
 
-  269 icons.
+  270 icons.
 */
 export const BUNDLED_ICONS = {
   "la:angle-right": {"body":"<path fill=\"currentColor\" d=\"M12.969 4.281L11.53 5.72L21.812 16l-10.28 10.281l1.437 1.438l11-11l.687-.719l-.687-.719z\"/>","width":32,"height":32},
@@ -271,6 +271,7 @@ export const BUNDLED_ICONS = {
   "mdi:table-split-cell": {"body":"<path fill=\"currentColor\" d=\"M19 14h2v6H3v-6h2v4h14zM3 4v6h2V6h14v4h2V4zm8 7v2H8v2l-3-3l3-3v2zm5 0V9l3 3l-3 3v-2h-3v-2z\"/>","width":24,"height":24},
   "mdi:tag": {"body":"<path fill=\"currentColor\" d=\"M5.5 7A1.5 1.5 0 0 1 4 5.5A1.5 1.5 0 0 1 5.5 4A1.5 1.5 0 0 1 7 5.5A1.5 1.5 0 0 1 5.5 7m15.91 4.58l-9-9C12.05 2.22 11.55 2 11 2H4c-1.11 0-2 .89-2 2v7c0 .55.22 1.05.59 1.41l8.99 9c.37.36.87.59 1.42.59s1.05-.23 1.41-.59l7-7c.37-.36.59-.86.59-1.41c0-.56-.23-1.06-.59-1.42\"/>","width":24,"height":24},
   "mdi:text-box-outline": {"body":"<path fill=\"currentColor\" d=\"M5 3c-1.11 0-2 .89-2 2v14c0 1.11.89 2 2 2h14c1.11 0 2-.89 2-2V5c0-1.11-.89-2-2-2zm0 2h14v14H5zm2 2v2h10V7zm0 4v2h10v-2zm0 4v2h7v-2z\"/>","width":24,"height":24},
+  "mdi:tooltip-plus-outline": {"body":"<path fill=\"currentColor\" d=\"M4 2h16a2 2 0 0 1 2 2v12a2 2 0 0 1-2 2h-4l-4 4l-4-4H4a2 2 0 0 1-2-2V4a2 2 0 0 1 2-2m0 2v12h4.83L12 19.17L15.17 16H20V4zm7 2h2v3h3v2h-3v3h-2v-3H8V9h3z\"/>","width":24,"height":24},
   "mdi:toy-brick-plus": {"body":"<path fill=\"currentColor\" d=\"M19 6V5a2 2 0 0 0-2-2h-2a2 2 0 0 0-2 2v1h-2V5a2 2 0 0 0-2-2H7a2 2 0 0 0-2 2v1H3v14h10.09a5.5 5.5 0 0 1-.09-1a6 6 0 0 1 8-5.66V6m-1 9v3h3v2h-3v3h-2v-3h-3v-2h3v-3Z\"/>","width":24,"height":24},
   "mdi:transfer-down": {"body":"<path fill=\"currentColor\" d=\"M16 3v2H8V3zm0 4v2H8V7zm0 4v2H8v-2zM5 15h14l-7 7z\"/>","width":24,"height":24},
   "mdi:transfer-up": {"body":"<path fill=\"currentColor\" d=\"M8 21v-2h8v2zm0-4v-2h8v2zm0-4v-2h8v2zm11-4H5l7-7z\"/>","width":24,"height":24},
diff --git a/frontend/src/components/EditorMarkdown.vue b/frontend/src/components/EditorMarkdown.vue
index 0b40047aa..f670f5331 100644
--- a/frontend/src/components/EditorMarkdown.vue
+++ b/frontend/src/components/EditorMarkdown.vue
@@ -44,11 +44,6 @@
             t('editor.markup.insertDefinitionList')
           }}</w-tooltip>
         </w-btn>
-        <w-btn icon="mdi:book-plus" padding="sm sm" flat @click="insertFootnote">
-          <w-tooltip anchor="center right" self="center left">{{
-            t('editor.markup.insertFootnote')
-          }}</w-tooltip>
-        </w-btn>
         <w-btn icon="mdi:emoticon-plus-outline" padding="sm sm" flat>
           <editor-emoji-menu anchor="top right" self="top left" @select="insertEmoji" />
           <w-tooltip anchor="center right" self="center left">{{
@@ -65,6 +60,16 @@
             t('editor.markup.insertIcon')
           }}</w-tooltip>
         </w-btn>
+        <w-btn icon="mdi:book-plus" padding="sm sm" flat @click="insertFootnote">
+          <w-tooltip anchor="center right" self="center left">{{
+            t('editor.markup.insertFootnote')
+          }}</w-tooltip>
+        </w-btn>
+        <w-btn icon="mdi:tooltip-plus-outline" padding="sm sm" flat @click="insertAbbreviation">
+          <w-tooltip anchor="center right" self="center left">{{
+            t('editor.markup.insertAbbreviation')
+          }}</w-tooltip>
+        </w-btn>
         <w-btn icon="mdi:line-scan" padding="sm sm" flat @click="insertHorizontalBar">
           <w-tooltip anchor="center right" self="center left">{{
             t('editor.markup.insertHorizontalBar')
@@ -959,6 +964,39 @@ function insertBeforeEachLine({ content, before, focus = true }) {
   }
 }
 
+/**
+ * An abbreviation definition, on a line of its own.
+ *
+ * `*[TERM]: definition` is a block rule, so it can follow a paragraph line directly but cannot sit
+ * inside one — the same reason the definition list breaks out of a line the cursor is mid-way
+ * through.
+ *
+ * Inserted as a Monaco snippet rather than as plain text, so the two placeholders are tab stops: the
+ * term starts selected and Tab moves to the definition. Both are typed over, never cleaned up.
+ */
+function insertAbbreviation() {
+  const model = editor.getModel()
+  const position = editor.getPosition()
+  const line = model.getLineContent(position.lineNumber)
+  const before = line.slice(0, position.column - 1).trim().length > 0 ? '\n' : ''
+  const after = line.slice(position.column - 1).trim().length > 0 ? '\n' : ''
+  const term = snippetEscape(t('editor.markup.abbreviationTerm'))
+  const definition = snippetEscape(t('editor.markup.abbreviationDefinition'))
+
+  editor
+    .getContribution('snippetController2')
+    .insert(`${before}*[\${1:${term}}]: \${2:${definition}}${after}`)
+  editor.focus()
+}
+
+/**
+ * Escape the characters Monaco's snippet parser reads as syntax, so a translated placeholder is
+ * inserted as the words it is
+ */
+function snippetEscape(text) {
+  return text.replace(/[\\$}]/g, '\\$&')
+}
+
 /**
  * Insert an Horizontal Bar
  */