quarto-dev / quarto-dev/quarto-cli

Allow styled figure notes using the new 1.4 crossref figure syntax

Open
#7,514 21 comments 5 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

crossref enhancement figures tables
Dominant language
JavaScript
Stars
6k
Forks
458
Avg merge
1d 9h
Merged PRs (30d)
41

Description

From discussion https://github.com/quarto-dev/quarto-cli/discussions/6103

New 1.4 crossref syntax allow to add text under a figure as shown: https://github.com/quarto-dev/quarto-cli/discussions/6103#discussioncomment-7296412

---
title: "Reproducible Quarto Document"
format: pdf
fig-cap-location: top
---

::: {#fig-1}

```{r}
#| echo: false
plot(1:10)
```

Source: My source

My figure caption.

:::

See @fig-1.

Suggestion by @danielvartan is to have a way to consider the content below the figure that is not a caption as some figures notes properly identified.

  • In LaTeX this could be using a command like \legend{} that could be redefined the the user,
  • In HTML, it could be using a new div that would allow targeted styling

Use case are from academic and others conventions where Figures' Note are required.

FWIW, this is a long standing feature request in knitr

Current workaround:

The 1.4 syntax allow any paragraph to be added below the figure content, and separated from the Caption. It could be styled as needed as shown in this exemple: https://github.com/quarto-dev/quarto-cli/discussions/6103#discussioncomment-7503264

Related issues

This FR could be seen as related to

Put it could happen that Figure caption are located at the top and Notes below the figures, while having different style. Example:

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked discussion 6103 and related issue 645, then compare the documented 1.4 syntax and current workaround. The issue names no repository files or tests; done would mean figure notes can be distinguished from captions and styled appropriately in both LaTeX and HTML.

Written by the indexing model from the issue text.

Assessment

Tech stack
html, latex, markdown
Domain
backend, content
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.