tool: definition list converter (#59)

Author: cscheid

crates/quarto-markdown-pandoc/tools/definition-list-converter/README.md

@@ -0,0 +1,92 @@
+# Definition List Converter
+
+This tool converts Pandoc's native DefinitionList AST nodes to the div-based definition list syntax used by quarto-markdown.
+
+## Background
+
+Pandoc supports definition lists using the following syntax:
+
+```markdown
+Term 1
+: Definition 1
+
+Term 2
+: Definition 2a
+: Definition 2b
+```
+
+However, quarto-markdown uses a div-based syntax with explicit structure:
+
+```markdown
+::: {.definition-list}
+* Term 1
+  - Definition 1
+* Term 2
+  - Definition 2a
+  - Definition 2b
+:::
+```
+
+This Lua filter converts from Pandoc's native definition list syntax to the quarto-markdown div syntax.
+
+## Usage
+
+To convert a document containing Pandoc-style definition lists:
+
+```bash
+pandoc -f markdown -t markdown \
+  --lua-filter=definition-list-to-div.lua \
+  input.md -o output.md
+```
+
+### Example
+
+Given this input (`test-input.md`):
+
+```markdown
+Term 1
+: Definition 1
+
+Term 2
+: Definition 2a
+: Definition 2b
+```
+
+Running the filter:
+
+```bash
+pandoc -f markdown -t markdown \
+  --lua-filter=definition-list-to-div.lua \
+  test-input.md
+```
+
+Produces:
+
+```markdown
+::: definition-list
+- Term 1
+
+  - Definition 1
+
+- Term 2
+
+  - Definition 2a
+  - Definition 2b
+:::
+```
+
+## Features
+
+- Converts all DefinitionList AST nodes to div-based syntax
+- Preserves term formatting (bold, emphasis, code, etc.)
+- Handles multiple definitions per term
+- Output can be parsed by quarto-markdown back into DefinitionList nodes
+
+## Requirements
+
+- Pandoc 2.11 or later
+
+## See Also
+
+- [Definition Lists Documentation](../../../../docs/syntax/definition-lists.qmd)
+- Similar tool: [Grid Table Fixer](../grid-table-fixer/)

crates/quarto-markdown-pandoc/tools/definition-list-converter/definition-list-to-div.lua

@@ -0,0 +1,60 @@
+-- Lua filter to convert Pandoc DefinitionList AST nodes to div-based definition lists
+-- This produces output in the definition-list div syntax used by quarto-markdown
+
+if PANDOC_VERSION and PANDOC_VERSION.must_be_at_least then
+    PANDOC_VERSION:must_be_at_least("2.11")
+else
+    error("pandoc version >=2.11 is required")
+end
+
+-- Convert a DefinitionList to a div with .definition-list class
+local function definition_list_to_div(def_list)
+    -- Build div attributes with .definition-list class
+    local div_attr = pandoc.Attr('', {'definition-list'}, {})
+
+    -- Build the outer bullet list containing all term-definition pairs
+    local outer_items = {}
+
+    -- Each item in the definition list is a tuple: (term, definitions)
+    -- term: list of inline elements
+    -- definitions: list of definition blocks (each definition is a list of blocks)
+    for _, item in ipairs(def_list.content) do
+        local term = item[1]  -- List of inline elements
+        local definitions = item[2]  -- List of definition blocks
+
+        -- Create the inner bullet list containing the definitions
+        local def_items = {}
+        for _, def_blocks in ipairs(definitions) do
+            -- Each definition is a list of blocks
+            -- Clone the blocks to avoid modifying the original
+            local blocks = pandoc.Blocks({})
+            for _, block in ipairs(def_blocks) do
+                table.insert(blocks, block:clone())
+            end
+
+            -- Ensure we have at least one block
+            if #blocks == 0 then
+                blocks = pandoc.Blocks({pandoc.Para({})})
+            end
+
+            table.insert(def_items, blocks)
+        end
+
+        -- Create a bullet list for the definitions
+        local def_list_elem = pandoc.BulletList(def_items)
+
+        -- Create the outer list item containing:
+        -- 1. The term as a paragraph
+        -- 2. The nested bullet list of definitions
+        local term_para = pandoc.Para(term)
+        table.insert(outer_items, {term_para, def_list_elem})
+    end
+
+    -- Create the outer bullet list (list of term-definition pairs)
+    local outer_list = pandoc.BulletList(outer_items)
+
+    -- Create the div containing the outer list
+    return pandoc.Div({outer_list}, div_attr)
+end
+
+return {{DefinitionList = definition_list_to_div}}

crates/quarto-markdown-pandoc/tools/definition-list-converter/test-input.md

@@ -0,0 +1,17 @@
+Term 1
+: Definition 1
+
+Term 2
+: Definition 2a
+: Definition 2b
+
+**Bold Term**
+: A definition with a bold term
+
+`code term`
+: A definition with a code term
+
+Complex Term with *emphasis*
+: First definition
+: Second definition
+: Third definition