Merge pull request #10206 from quarto-dev/bugfix/10004

Lua - process shortcodes in string attributes throughout AST

Author: cscheid

news/changelog-1.6.md

@@ -7,6 +7,7 @@ All changes included in 1.6:
 
 ## Lua filters
 
+- ([#10004](https://github.com/quarto-dev/quarto-cli/issues/10004)): Resolve callout titles, theorem names, and `code-summary` content through `quarto_ast_pipeline()` and `process_shortcodes()`.
 - ([#10196](https://github.com/quarto-dev/quarto-cli/issues/10196)): protect against nil values in `float.caption_long`.
 
 ## `typst` Format

src/resources/extensions/quarto/docusaurus/docusaurus_utils.lua

@@ -26,7 +26,8 @@ function render_folded_block(block)
     })
 
     if not isEmpty(summary) then
-      tappend(beginPara.content, markdownToInlines(summary))
+      local inlines = process_shortcodes(string_to_quarto_ast_inlines(summary))
+      tappend(beginPara.content, inlines)
     end
     beginPara.content:insert(pandoc.RawInline("markdown", "</summary>"))
     div.content:insert(beginPara)

src/resources/filters/common/pandoc.lua

@@ -132,9 +132,9 @@ function resolveHeadingCaption(div)
   local capEl = div.content[1]
   if capEl ~= nil and is_regular_node(capEl, "Header") then
     div.content:remove(1)
-    return capEl.content
+    return quarto.utils.as_inlines(capEl.content)
   else 
-    return nil
+    return pandoc.Inlines({})
   end
 end
 

src/resources/filters/crossref/theorems.lua

@@ -55,6 +55,10 @@ function crossref_theorems()
           end
 
           -- capture then remove name
+          -- 
+          -- we have string_to_quarto_ast_inlines but we don't need it here
+          -- because this filter happened after shortcode processing, and this
+          -- is a regular div we're processing
           local name = markdownToInlines(el.attr.attributes["name"])
           if not name or #name == 0 then
             name = resolveHeadingCaption(el)

src/resources/filters/customnodes/callout.lua

@@ -45,7 +45,7 @@ function _callout_main()
     -- and returns the custom node
     parse = function(div)
       quarto_global_state.hasCallouts = true
-      local title = markdownToInlines(div.attr.attributes["title"])
+      local title = string_to_quarto_ast_inlines(div.attr.attributes["title"] or "")
       if not title or #title == 0 then
         title = resolveHeadingCaption(div)
       end

src/resources/filters/customnodes/shortcodes.lua

@@ -200,6 +200,11 @@ local function handle_shortcode(shortcode_tbl, node, context)
   return callShortcodeHandler(handler, shortcode_struct, context), shortcode_struct
 end
 
+local _shortcodes_filter = nil
+function process_shortcodes(content)
+  return _quarto.ast.walk(content, _shortcodes_filter)
+end
+
 function shortcodes_filter()
 
   local code_shortcode = shortcode_lpeg.make_shortcode_parser({
@@ -329,6 +334,8 @@ function shortcodes_filter()
       return doc
     end
   }
+
+  _shortcodes_filter = filter
   return filter
 end
 

src/resources/filters/quarto-post/foldcode.lua

@@ -24,7 +24,7 @@ function render_folded_block(block)
     })
 
     if not isEmpty(summary) then
-      tappend(beginPara.content, markdownToInlines(summary))
+      tappend(beginPara.content, process_shortcodes(string_to_quarto_ast_inlines(summary)))
     end
     beginPara.content:insert(pandoc.RawInline("html", "</summary>"))
     div.content:insert(beginPara)

src/resources/filters/quarto-pre/parseblockreftargets.lua

@@ -10,7 +10,7 @@ function parse_blockreftargets()
       return
     end
     -- capture then remove name
-    local name = markdownToInlines(el.attr.attributes["name"])
+    local name = string_to_quarto_ast_inlines(el.attr.attributes["name"] or "")
     if not name or #name == 0 then
       name = resolveHeadingCaption(el)
     end
@@ -32,7 +32,7 @@ function parse_blockreftargets()
 
     local name = string_to_quarto_ast_inlines(el.attributes["name"] or "")
     if not name or #name == 0 then
-      name = resolveHeadingCaption(el) or pandoc.Inlines({})
+      name = resolveHeadingCaption(el)
     end
     el.attributes["name"] = nil 
     local identifier = el.identifier

src/resources/filters/quarto-pre/parsefiguredivs.lua

@@ -140,7 +140,7 @@ local function kable_raw_latex_fixups(content, identifier)
         identifier = label_identifier,
         type = "Table",
         content = pandoc.Blocks({ raw }),
-        caption_long = pandoc.Blocks({pandoc.Plain(string_to_quarto_ast_inlines(caption_content))}),
+        caption_long = pandoc.Blocks({pandoc.Plain(string_to_quarto_ast_inlines(caption_content or ""))}),
       })
     end
   })

src/resources/lua-types/pandoc/inlines.lua

@@ -27,7 +27,7 @@ pandoc.Inlines = {}
 Create an inlines list 
 ]]
 ---@param inlines any Inline elements
----@return pandoc.List
+---@return pandoc.Inlines
 function pandoc.Inlines(inlines) end