How can I number all callouts by default

[normansimonr]

Description

I know that if I add an identifier to a callout, it will be numbered and referenceable (as per the docs).

I have a document with an extremely large number of callouts, but only some of them are actually referenced (linked to) in other parts of the document. I want all of the callouts, however, including those that are referenced and those that aren't, to be numbered by default. How can I achieve this without having to manually add identifiers to all of the callouts?

Thanks.

[mcanouil]

You're gonna need to write a LUA filter that will add the identifiers.

[cscheid]

This filter will be slightly tricky to write because a Callout is a custom AST. So here's how you do it:

doc.qmd

---
format: html
filters:
  - addcalloutid.lua
---

::: {#nte-1 .callout-note}

This is note 1.

:::

::: {.callout-note}

This is note 2.

:::

::: {.callout-note}

This is note 3.

:::

::: {.callout-note}

This is note 4.

:::

addcalloutid.lua

local id = 1
function Callout(callout)
  if callout.attr.identifier ~= "" then
    -- callout already has an id
    return nil
  end
  callout.attr.identifier = "nte-unique" .. tostring(id)
  id = id + 1
  return quarto.Callout(callout)
end

This will add ids nte-unique1, nte-unique2, and nte-unique3 to the last three callouts of the document, producing this output:

[cscheid]

Can we follow up offline? I think it would be easier to clarify all of this over email and then post the results here, rather than attempt to diagnose/fix everything online and potentially confusing everyone else. Shoot me an email and I'd be happy to chat. Thanks!

[coatless]

@cscheid reach out via the gmail address listed on your website?

[cscheid]

I thought I had my posit email on my github account, but I don't. The gmail one works, but [email protected] is my work address.

[coatless]

Okidokies.

[coatless]

@cscheid was anything ever codified regarding setting up custom ast references? I had an inquiry come over:

coatless-quarto/custom-callout#10

My github search-fu indicates no change; but, I know a new parser is in the works so...

[normansimonr]

Thanks so much @cscheid and @mcanouil! I'm new to extensions, so I'm following the docs to get started, but apparently I was able to make it work. The problem I'm getting is that all the notes have the same number, namely 'Note 92'. I copied the code verbatim. I'm working on a LaTeX doc.

I'm guessing the id needs to be updated at some point in a loop or something like that?

[cscheid]

@normansimonr Huh. No, that's a Quarto bug. Thanks for reporting, I can repro on that very example I shared with you. I'll follow up.

[cscheid]

For completeness, the example I shared produces this in format: pdf:

[cscheid]

Oh, I'm sorry, it's not a Quarto bug (whew!), it's a simple copy-paste mistake I made. The correct filter is this, it just needs to increment that counter:

local id = 1
function Callout(callout)
  if callout.attr.identifier ~= "" then
    -- callout already has an id
    return nil
  end
  callout.attr.identifier = "nte-unique" .. tostring(id)
  id = id + 1
  return quarto.Callout(callout)
end

[cscheid]

[pglpm]

local id = 1
function Callout(callout)
  if callout.attr.identifier ~= "" then
    -- callout already has an id
    return nil
  end
  callout.attr.identifier = "nte-unique" .. tostring(id)
  id = id + 1
  return quarto.Callout(callout)
end

This is very useful for me too! One question: is it possible to change it so that it only applies to one type of callout, say the "caution" one? I've tried inserting an if with callout.type, but probably it doesn't exist.

[mcanouil]

Yes, test the type which should work, if not please share a small but fully reproducible example.

https://quarto.org/docs/prerelease/1.3/custom-ast-nodes/callout.html

---

Edit

It does exist and works:

function Callout(callout)
  quarto.log.output(callout.type)
end

---
format: html
filters:
  - path: callout.lua
    at: post-quarto
---

::: {.callout-important}
Whatever
:::

[pglpm]

My bad, I was using = instead of == for matching. Thank you so much!

For other users who are interested in numbering only a certain type of callouts, say "caution":

local id = 1
function Callout(callout)
  if callout.type == "caution" then
    if callout.attr.identifier ~= "" then
      -- callout already has an id
      return nil
    end
    callout.attr.identifier = "cau-unique" .. tostring(id)
    id = id + 1
  end
  return quarto.Callout(callout)
end

[normansimonr]

Got it, thanks a ton! It works!