Table and figure captions not working in AsciiDoc

[jeroenjanssens]

Bug description

The latest pre-release of Quarto (v1.4.533) produces AsciiDoc syntax that causes figure and table captions to be disconnected. The captions appear as a numbered list with a single item. This problem does not exist for HTML and PDF outputs.

Steps to reproduce

Save the following code to caption.qmd.

---
title: Caption
---

@tbl-fruit shows just how expensive fruit is these days.

fruit| price
-----|-----:
apple|2.05
pear|1.37
orange|3.09

: Various fruits and their prices {#tbl-fruit}


And if that's not convincing, consider @fig-fruit.

```{mermaid}
%%| label: fig-fruit
%%| fig-cap: Pretty convincing
flowchart LR
  A[Hard edge] --> B(Round edge)
  B --> C{Decision}
  C --> D[Result one]
  C --> E[Result two]
```

Fin.

Expected behavior

I'm not exactly sure what the correct AsciiDoc syntax is, but the latest Quarto release (v1.3.450) produces:

= Caption

<<tbl-fruit>> shows just how expensive fruit is these days.

[[tbl-fruit]]
.Various fruits and their prices
[cols=",>",options="header",]
|===
|fruit |price
|apple |2.05
|pear |1.37
|orange |3.09
|===

And if that’s not convincing, consider <<fig-fruit>>.

.Pretty convincing
[#fig-fruit]
image:caption_files/figure-asciidoctor/mermaid-figure-1.png[caption_files/figure-asciidoctor/mermaid-figure-1,width=550,height=133]

Fin.

Actual behavior

The command:

$ quarto render caption.qmd --quiet --to asciidoc --output -

Produces:

= Caption

<<tbl-fruit>> shows just how expensive fruit is these days.

. Various fruits and their prices
[[tbl-fruit]]
====

[cols=",>",options="header",]
|===
|fruit |price
|apple |2.05
|pear |1.37
|orange |3.09
|===

====

And if that’s not convincing, consider <<fig-fruit>>.

. Pretty convincing
[[fig-fruit]]
====

image:caption_files/figure-asciidoc/mermaid-figure-1.png[caption_files/figure-asciidoc/mermaid-figure-1,width=550,height=133]

====

Fin.

Your environment

OS: macOS Monterey 12.5

Quarto check output

Quarto 1.4.533
[✓] Checking versions of quarto binary dependencies...
      Pandoc version 3.1.11: OK
      Dart Sass version 1.69.5: OK
      Deno version 1.37.2: OK
[✓] Checking versions of quarto dependencies......OK
[✓] Checking Quarto installation......OK
      Version: 1.4.533
      Path: /Applications/quarto/bin

[✓] Checking tools....................OK
      TinyTeX: v2023.12
      Chromium: (not installed)

[✓] Checking LaTeX....................OK
      Using: TinyTex
      Path: /Users/jeroen/Library/TinyTeX/bin/universal-darwin
      Version: 2023

[✓] Checking basic markdown render....OK

[✓] Checking Python 3 installation....OK
      Version: 3.11.1
      Path: /Users/jeroen/.pyenv/versions/3.11.1/bin/python3
      Jupyter: 5.3.1
      Kernels: python3

[✓] Checking Jupyter engine render....OK

[✓] Checking R installation...........OK
      Version: 4.3.2
      Path: /Library/Frameworks/R.framework/Resources
      LibPaths:
        - /Library/Frameworks/R.framework/Versions/4.3-arm64/Resources/library
      knitr: 1.44
      rmarkdown: 2.25

[✓] Checking Knitr engine render......OK

[jeroenjanssens]

I was wondering, which AsciiDoc implementation do you use as reference? Is it https://docs.asciidoctor.org/ by any chance?

[cderv]

I was wondering, which AsciiDoc implementation do you use as reference? Is it docs.asciidoctor.org by any chance?

We should produce asciidoc based on --to asciidoc. Per: https://pandoc.org/MANUAL.html#option--to

(modern AsciiDoc as interpreted by AsciiDoctor)

So we do handle Tables caption as part of new float ref, and not producing right syntax it seems. Thanks for the report!

[cderv]

Currently the 1.4 version produced asciidoc shows this (in https://asciidoclive.com/)

I believe there are first is several issues here:

. Various fruits and their prices

There should not be a space after the . here.

image:caption_files/figure-asciidoc/mermaid-figure-1.png[caption_files/figure-asciidoc/mermaid-figure-1,width=550,height=133]

There should be probably two colons after image i.e image:: for block image (https://docs.asciidoctor.org/asciidoc/latest/macros/images/#block-image-macro) - image: is for inline image only (https://docs.asciidoctor.org/asciidoc/latest/macros/images/#inline-image-macro) 🤔

but even changing this does get only thus far

So get the caption outside of Figure and Table blocks, which leads to having them numbered by asciidoc differently.

But let's note that Quarto 1.3 produces this

the image: issue is present in 1.3. Fixing it get us this

So definitely some problems:

• Wrong syntax produced for figures in 1.3 and 1.4
• Wrong caption placement causing wrong labelling and numbering in 1.4

[cderv]

This was modified in #6620 where previous function for figures asciidocFigure and asciidocDivFigure from asciidoc.lua are no more used now. (we should probably document that in note in code that they are unused now... 🤔 )

Asciidoc generation is done here I believe:

quarto-cli/src/resources/filters/customnodes/floatreftarget.lua

Lines 780 to 798 in 27b29d9

	_quarto.ast.add_renderer("FloatRefTarget", function(_)
	return _quarto.format.isAsciiDocOutput()
	end, function(float)
	if float.content.t == "Plain" and #float.content.content == 1 and float.content.content[1].t == "Image" then
	return pandoc.Figure(
	{float.content},
	{float.caption_long},
	float.identifier)
	end
	float.caption_long.content:insert(1, pandoc.RawInline("asciidoc", ". "))
	float.caption_long.content:insert(pandoc.RawInline("asciidoc", "\n[[" .. float.identifier .. "]]\n===="))
	return pandoc.Div({
	float.caption_long,
	-- pandoc.RawBlock("asciidoc", "[[" .. float.identifier .. "]]\n====\n"),
	float.content,
	pandoc.RawBlock("asciidoc", "====\n\n")
	})

Space after dot is there at least.

quarto-cli/src/resources/filters/customnodes/floatreftarget.lua

Line 790 in 27b29d9

float.caption_long.content:insert(1, pandoc.RawInline("asciidoc", ". "))

For the image: , I believe this is due to the float content generation, that produce inline image due to Div [ Para [ Image

Intermediate md is

:::{.cell layout-align="default"}

:::{.cell-output-display}

:::{#fig-fruit}

:::{}

![](index_files\figure-asciidoc\mermaid-figure-1.png){width="5.74in" height="1.4in"}
:::


Pretty convincing
:::
:::
:::

So it seems the mermaid output is producing a Div around the image, which leads to the asciidoc output - Without this div the figure would be ok. This works fine for example

---
title: Caption
format: asciidoc
keep-md: true
---

::: {#fig-elephant}

![](elephant.png)

This is a a caption

:::

So overall, several issues / questions here with asciidoc generation - we may need to handle them one by one ... 🤔

• Remove space after the . when creating caption
• Fix floatreftarget generation for table that seems to put the caption outside the asciidoc table env
• Fix mermaid output that adds an empty div around the inserted image

[cscheid]

I'm going to add the immediate fixes to 1.4, but we definitely need to get asciidoc in that "features x formats" table we've been talking about. I'm sure there's going to be other bugs lurking..

[cscheid]

PR is up. @jeroenjanssens Would you mind doing a spot check on the output we're generating in that branch? Thank you!

[jeroenjanssens]

Looks good to me. Thanks!

Generated AsciiDoc:

= Caption

<<tbl-fruit>> shows just how expensive fruit is these days.

[[tbl-fruit]]
.Various fruits and their prices
[cols=",>",options="header",]
|===
|fruit |price
|apple |2.05
|pear |1.37
|orange |3.09
|===

And if that’s not convincing, consider <<fig-fruit>>.

.Pretty convincing
[#fig-fruit]
image::caption_files/figure-asciidoc/mermaid-figure-1.png[Pretty convincing,width=550,height=133]

Fin.

PDF generated with asciidoctor-pdf: