CODEWITHSUNDEEP
r-markdowncaptioncross-referencebookdown
QuantIbex
QuantIbex

Reputation: 2384

How to insert a reference in a table caption in a bookdown document that works for both pdf and html output

I use bookdown to generate a document in both html and pdf. How could I insert a reference to a section of the document in the caption of a table?

Using \\ref{sec:FirstSection} works fine with pdf_book (but not gitbook):

---
title: "Test"
output: bookdown::pdf_book
---

# A section {#sec:FirstSection}
The dataset in Table \@ref(tab:aTable) contains some data.

# Another section
```{r, aTable, echo = FALSE}
knitr::kable(
  cars[1:5, ],
  caption  = "See Section \\ref{sec:FirstSection}."
)
```

whilst using \\@ref(sec:FirstSection) works fine with gitbook (but not pdf_book)

---
title: "Test"
output: bookdown::gitbook
---

# A section {#sec:FirstSection}
The dataset in Table \@ref(tab:aTable) contains some data.

# Another section
```{r, aTable, echo = FALSE}
knitr::kable(
  cars[1:5, ],
  caption  = "See Section \\@ref(sec:FirstSection)."
)
    ```

Upvotes: 3

Views: 1753

Answers (2)

Yihui Xie
Yihui Xie

Reputation: 30114

You can use text references, a Markdown extension provided by bookdown.

---
title: "Test"
output: bookdown::gitbook
---

# A section {#sec:FirstSection}

The dataset in Table \@ref(tab:aTable) contains some data.

# Another section

(ref:aTable-caption) See Section \@ref(sec:FirstSection).

```{r, aTable, echo = FALSE}
knitr::kable(
  cars[1:5, ],
  caption  = "(ref:aTable-caption)"
)
```

Upvotes: 9

QuantIbex
QuantIbex

Reputation: 2384

This works for both pdf and html but there might be an easier way.

---
title: "Test"
output: bookdown::gitbook
---

# A section {#sec:FirstSection}
The dataset in Table \@ref(tab:aTable) contains some data.

# Another section
```{r, aTable, echo = FALSE}
txt <- ifelse(knitr:::is_latex_output(), "\\ref{sec:FirstSection}",     
              "\\@ref(sec:FirstSection)")

knitr::kable(
  cars[1:5, ],
  caption  = paste0("See Section ", txt, ".")
)
```

Upvotes: 1

Related Questions