typst - reimplement subfloat counters

Author: cscheid

news/changelog-1.5.md

@@ -69,9 +69,10 @@ All changes included in 1.5:
 
 ## Typst
 
-- ([#9619](https://github.com/quarto-dev/quarto-cli/pull/9619)): Typst CSS - for a small set of elements and properties, Quarto will translate the CSS property to a Typst property. This is especially useful for processed HTML tables and `<pre>`s.
 - ([#8539](https://github.com/quarto-dev/quarto-cli/issues/8539)): Support for Typst theorems and their ilk via [typst-theorems](https://github.com/sahasatvik/typst-theorems).
+- ([#9619](https://github.com/quarto-dev/quarto-cli/pull/9619)): Typst CSS - for a small set of elements and properties, Quarto will translate the CSS property to a Typst property. This is especially useful for processed HTML tables and `<pre>`s.
 - ([#9293](https://github.com/quarto-dev/quarto-cli/pull/9293)): Add `toc-indent` to control indentation of entries in the table of contents.
+- ([#9671](https://github.com/quarto-dev/quarto-cli/issues/9671)): Reimplement `typst` subfloats to fix subfloat counters.
 - ([#9694](https://github.com/quarto-dev/quarto-cli/issues/9694)): Fix default callout (`::: callout ... ::: `) in Typst.
 - Upgrade Typst to 0.11
 - Upgrade the Typst template to draw tables without grid lines by default, in accordance with latest Pandoc.

src/resources/filters/crossref/preprocess.lua

@@ -9,6 +9,7 @@ function crossref_mark_subfloats()
     FloatRefTarget = function(float)
       float.content = _quarto.ast.walk(float.content, {
         FloatRefTarget = function(subfloat)
+          float.has_subfloats = true
           crossref.subfloats[subfloat.identifier] = {
             parent_id = float.identifier
           }

src/resources/filters/crossref/refs.lua

@@ -87,16 +87,7 @@ function resolveRefs()
             elseif _quarto.format.isAsciiDocOutput() then
               ref = pandoc.List({pandoc.RawInline('asciidoc', '<<' .. label .. '>>')})
             elseif _quarto.format.isTypstOutput() then
-              -- if we're referencing a subfloat,
-              -- we need to package the parent_id information in the
-              -- supplement as well, so that we can provide
-              -- better numbering in the typst renderer
-              local subfloat_info = crossref.subfloats[label]
-              if subfloat_info == nil then
-                ref = pandoc.List({pandoc.RawInline('typst', '@' .. label)})
-              else
-                ref = pandoc.List({pandoc.RawInline('typst', '@' .. label .. '[45127368-afa1-446a-820f-fc64c546b2c5%' .. subfloat_info.parent_id .. ']')})
-              end
+              ref = pandoc.List({pandoc.RawInline('typst', '@' .. label)})
             else
               if not resolve then
                 local refClasses = pandoc.List({"quarto-unresolved-ref"})

src/resources/filters/customnodes/floatreftarget.lua

@@ -974,40 +974,47 @@ end, function(float)
     return float.content
     -- luacov: enable
   end
-  local kind
-  local supplement = ""
-  local numbering = ""
-  local content = float.content
-
-  if float.parent_id then
-    kind = "quarto-subfloat-" .. ref
-    numbering = "(a)"
-  else
-    kind = "quarto-float-" .. ref
-    numbering = "1"
-    supplement = info.name
-  end
-
+  local kind = "quarto-float-" .. ref
+  local supplement = info.name
+  -- FIXME: custom numbering doesn't work yet
+  -- local numbering = ""
+  -- if float.parent_id then
+  --   numbering = "(a)"
+  -- else
+  --   numbering = "1"
+  -- end
+  local content = quarto.utils.as_blocks(float.content or {})
   local caption_location = cap_location(float)
 
-  -- FIXME: custom numbering doesn't work yet
-  
   if (ref == "lst") then
     -- FIXME: 
     -- Listings shouldn't emit centered blocks. 
     -- We don't know how to disable that right now using #show rules for #figures in template.
-    content = { pandoc.RawBlock("typst", "#set align(left)"), content }
+    content:insert(1, pandoc.RawBlock("typst", "#set align(left)"))
   end
 
-  return make_typst_figure {
-    content = content,
-    caption_location = caption_location,
-    caption = float.caption_long,
-    kind = kind,
-    supplement = supplement,
-    numbering = numbering,
-    identifier = float.identifier
-  }
+  if float.has_subfloats then
+    return _quarto.format.typst.function_call("quarto_super", {
+      {"kind", kind},
+      {"caption", float.caption_long},
+      {"label", pandoc.RawInline("typst", "<" .. float.identifier .. ">")},
+      {"position", pandoc.RawInline("typst", caption_location)},
+      {"supplement", supplement},
+      {"subrefnumbering", "1a"},
+      {"subcapnumbering", "(a)"},
+      content
+    }, false)
+  else
+    return make_typst_figure {
+      content = content,
+      caption_location = caption_location,
+      caption = float.caption_long,
+      kind = kind,
+      supplement = supplement,
+      numbering = numbering,
+      identifier = float.identifier
+    }
+  end
 end)
 
 _quarto.ast.add_renderer("FloatRefTarget", function(_)

src/resources/filters/layout/typst.lua

@@ -95,41 +95,53 @@ end, function(layout)
     return float.content
     -- luacov: enable
   end
+  local supplement = info.name
 
   -- typst output currently only supports a single grid
   -- as output, so no rows of varying columns, etc.
   local n_cols = layout.attributes[kLayoutNcol] or "1"
-
-  local typst_figure_content = pandoc.Div({})
-  typst_figure_content.content:insert(pandoc.RawInline("typst", "#grid(columns: " .. n_cols .. ", gutter: 2em,\n"))
-  local is_first = true
-  _quarto.ast.walk(layout.float.content, {
-    FloatRefTarget = function(_, float_obj)
-      if is_first then
-        is_first = false
-      else
-        typst_figure_content.content:insert(pandoc.RawInline("typst", ",\n"))
-      end
-      typst_figure_content.content:insert(pandoc.RawInline("typst", "  ["))
-      typst_figure_content.content:insert(float_obj)
-      typst_figure_content.content:insert(pandoc.RawInline("typst", "]"))
-      return nil
-    end
-  })
-  typst_figure_content.content:insert(pandoc.RawInline("typst", ")\n"))
   local result = pandoc.Blocks({})
   if layout.preamble then
-    result:insert(layout.preamble)
+    if pandoc.utils.type(layout.preamble) == "Blocks" then
+      result:extend(layout.preamble)
+    else
+      result:insert(layout.preamble)
+    end
   end
   local caption_location = cap_location(layout.float)
 
-  return make_typst_figure {
-    content = typst_figure_content,
-    caption_location = caption_location,
-    caption = layout.float.caption_long,
-    kind = kind,
-    supplement = info.prefix,
-    numbering = info.numbering,
-    identifier = layout.float.identifier
-  }
+  local cells = pandoc.Blocks({})
+  cells:insert(pandoc.RawInline("typst", "#grid(columns: " .. n_cols .. ", gutter: 2em,\n"))
+  layout.rows.content:map(function(row)
+    -- print(row)
+    return row.content:map(function(cell)
+      cells:insert(pandoc.RawInline("typst", "  ["))
+      cells:insert(cell)
+      cells:insert(pandoc.RawInline("typst", "],\n"))
+    end)
+  end)
+  cells:insert(pandoc.RawInline("typst", ")\n"))
+  if layout.float.has_subfloats then
+    result:insert(_quarto.format.typst.function_call("quarto_super", {
+      {"kind", kind},
+      {"caption", layout.float.caption_long},
+      {"label", pandoc.RawInline("typst", "<" .. layout.float.identifier .. ">")},
+      {"position", pandoc.RawInline("typst", caption_location)},
+      {"supplement", supplement},
+      {"subrefnumbering", "1a"},
+      {"subcapnumbering", "(a)"},
+      cells
+    }, false))
+  else
+    result:insert(make_typst_figure {
+      content = cells,
+      caption_location = caption_location,
+      caption = layout.float.caption_long,
+      kind = kind,
+      supplement = info.prefix,
+      numbering = info.numbering,
+      identifier = layout.float.identifier
+    })
+  end
+  return result
 end)

src/resources/filters/modules/typst.lua

@@ -5,20 +5,28 @@
 -- this module is exposed as quarto.format.typst
 
 local function _main()
-  local function typst_function_call(name, params)
+  local function typst_function_call(name, params, keep_scaffold)
     local result = pandoc.Blocks({})
     result:insert(pandoc.RawInline("typst", "#" .. name .. "("))
     local function add(v)
-      if type(v) == "userdata" or type(v) == "table" then
+      if type(v) == "number" then
+        result:insert(pandoc.RawInline("typst", tostring(v)))
+      elseif type(v) == "string" then
+        result:insert(pandoc.RawInline("typst", "\"" .. v .. "\""))
+      elseif v.t == "RawInline" or v.t == "RawBlock" then
+        result:insert(v)
+      elseif type(v) == "userdata" or type(v) == "table" then
+        result:insert(pandoc.RawInline("typst", "["))
         result:extend(quarto.utils.as_blocks(v) or {})
+        result:insert(pandoc.RawInline("typst", "]"))
       else
         result:extend(quarto.utils.as_blocks({pandoc.utils.stringify(v)}) or {})
       end
     end
     -- needs to be array of pairs because order matters for typst
     local n = #params
     for i, pair in ipairs(params) do
-      if type(pair) == "table" then
+      if pandoc.utils.type(pair) == "table" then
         local k = pair[1]
         local v = pair[2]
         if v ~= nil then
@@ -40,7 +48,11 @@ local function _main()
     -- The result from this div cannot be a quarto-scaffold because some typst template
     -- functions assume they can get the element's children. pandoc.Div is converted to
     -- a #block, and those are guaranteed to have children.
-    return pandoc.Div(result)
+    if keep_scaffold == false then
+      return pandoc.Div(result, pandoc.Attr("", {"quarto-scaffold"}))
+    else
+      return pandoc.Div(result)
+    end
   end
 
   local function as_typst_content(content)

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

@@ -29,6 +29,20 @@ function render_typst()
       end
     },
     {
+      FloatRefTarget = function(float)
+        if float.content.t == "Table" then
+          -- this needs the fix from https://github.com/jgm/pandoc/pulls/9778
+          float.content.classes:insert("typst-no-figure")
+        else
+          float.content = _quarto.ast.walk(float.content, {
+            Table = function(tbl)
+              tbl.classes:insert("typst-no-figure")
+              return tbl
+            end
+          })
+        end
+        return float
+      end,
       Div = function(div)
         if div.classes:includes("block") then
           div.classes = div.classes:filter(function(c) return c ~= "block" end)

src/resources/formats/typst/pandoc/quarto/definitions.typ

@@ -61,6 +61,54 @@
 
 }
 
+// Subfloats
+// This is a technique that we adapted from https://github.com/tingerrr/subpar/
+#let quartosubfloatcounter = counter("quartosubfloatcounter")
+
+#let quarto_super(
+  kind: str,
+  caption: none,
+  label: none,
+  supplement: str,
+  position: none,
+  subrefnumbering: "1a",
+  subcapnumbering: "(a)",
+  body,
+) = {
+  context {
+    let figcounter = counter(figure.where(kind: kind))
+    let n-super = figcounter.get().first() + 1
+    set figure.caption(position: position)
+    [#figure(
+      kind: kind,
+      supplement: supplement,
+      caption: caption,
+      {
+        show figure.where(kind: kind): set figure(numbering: _ => numbering(subrefnumbering, n-super, quartosubfloatcounter.get().first() + 1))
+        show figure.where(kind: kind): set figure.caption(position: position)
+
+        show figure: it => {
+          let num = numbering(subcapnumbering, n-super, quartosubfloatcounter.get().first() + 1)
+          show figure.caption: it => {
+            num.slice(2) // I don't understand why the numbering contains output that it really shouldn't, but this fixes it shrug?
+            [ ]
+            it.body
+          }
+
+          quartosubfloatcounter.step()
+          it
+          counter(figure.where(kind: it.kind)).update(n => n - 1)
+        }
+
+        quartosubfloatcounter.update(0)
+        body
+      }
+    )#label]
+  }
+}
+
+// callout rendering
+// this is a figure show rule because callouts are crossreferenceable
 #show figure: it => {
   if type(it.kind) != "string" {
     return it
@@ -98,35 +146,6 @@
     old_callout.body.children.at(1))
 }
 
-#show ref: it => locate(loc => {
-  let suppl = it.at("supplement", default: none)
-  if suppl == none or suppl == auto {
-    it
-    return
-  }
-
-  let sup = it.supplement.text.matches(regex("^45127368-afa1-446a-820f-fc64c546b2c5%(.*)")).at(0, default: none)
-  if sup != none {
-    let target = query(it.target, loc).first()
-    let parent_id = sup.captures.first()
-    let parent_figure = query(label(parent_id), loc).first()
-    let parent_location = parent_figure.location()
-
-    let counters = numbering(
-      parent_figure.at("numbering"), 
-      ..parent_figure.at("counter").at(parent_location))
-      
-    let subcounter = numbering(
-      target.at("numbering"),
-      ..target.at("counter").at(target.location()))
-    
-    // NOTE there's a nonbreaking space in the block below
-    link(target.location(), [#parent_figure.at("supplement") #counters#subcounter])
-  } else {
-    it
-  }
-})
-
 // 2023-10-09: #fa-icon("fa-info") is not working, so we'll eval "#fa-info()" instead
 #let callout(body: [], title: "Callout", background_color: rgb("#dddddd"), icon: none, icon_color: black) = {
   block(

src/resources/lua-types/quarto/format/typst.lua

@@ -7,8 +7,9 @@ Create a node that represents a typst function call.
 ]]
 ---@param name string Name of function
 ---@param params table<string, any> Array of {param, value} pairs
+---@param keep_scaffold? boolean If true, the result will be wrapped in a typst block.
 ---@return pandoc.Div 
-function quarto.format.typst.function_call(name, params) end
+function quarto.format.typst.function_call(name, params, keep_scaffold) end
 
 --[[
 Create a node that represents typst content (`[Hello, world]`). Use