File: resolve_refs_html.Rd

package info (click to toggle)
r-cran-bookdown 0.42%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 3,752 kB
  • sloc: javascript: 11,343; makefile: 21; sh: 20
file content (31 lines) | stat: -rw-r--r-- 1,112 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/html.R
\name{resolve_refs_html}
\alias{resolve_refs_html}
\title{Resolve figure/table/section references in HTML}
\usage{
resolve_refs_html(content, global = FALSE)
}
\arguments{
\item{content}{A character vector of the HTML content.}

\item{global}{Whether to number the elements incrementally throughout the
whole document, or number them by the first-level headers. For an R
Markdown output format, \code{global = !number_sections} is likely to be a
reasonable default (i.e., when the sections are numbered, you number
figures/tables by sections; otherwise just number them incrementally).}
}
\value{
A post-processed character vector of the HTML character.
}
\description{
Post-process the HTML content to resolve references of figures, tables, and
sections, etc. The references are written in the form \code{\@ref(key)} in
the R Markdown source document.
}
\examples{
library(bookdown)
resolve_refs_html(c("<caption>(#tab:foo) A nice table.</caption>",
    "<p>See Table @ref(tab:foo).</p>"), global = TRUE)
}
\keyword{internal}