Same shape as rtf_titles(): a list with one block per page (or length 1,
common to all). Each block is a character vector or a list of rows (a string
or list(text=, align=, bold=, italic=, underline=, color=, border=)).
Footnote rows default to left-aligned, and the first row carries a top rule
(the separator) unless that row sets its own border. NULL per element
suppresses the footnote for that page.
Usage
rtf_footnotes(
doc,
footnotes,
font_size_half_points = NULL,
row_height_twips = NULL,
markup = NULL,
font = NULL,
align = NULL,
border = NULL
)Arguments
- doc
An rtf_document object.
- footnotes
A list of length = number of pages, or length 1 (common). Each page's element is a list of rows. A row is a single string, or a named vector
c(l = , c = , r = )giving up to three cells positioned left / centre / right – the same row modelrtf_footer()uses. A bare string lands in whichever slotalignselects.- font_size_half_points, row_height_twips, markup, align, font
Style for this block, overriding the document default from
rtf_default_format().fontnames a family (e.g."Arial"); one not already in the document'sfont_tableis added to it automatically, the way a colour is. Anything leftNULLis inherited. Font size and row height resolve together: a size given without a height recomputes the height from that size rather than inheriting one chosen for a different size, and an explicit height always wins.alignsets the block's default row alignment; a per-rowalignstill beats it.- border
NULL(default) for no rule – unlike the page footer, the footnote draws none unless asked. Anrtf_border()puts one on the first row, e.g.border = rtf_border(top = TRUE).
Examples
df <- data.frame(A = 1:2, B = c("x", "y"))
doc <- rtf_document() |>
rtf_tables(df) |>
rtf_footnotes(list(c("Source: ADaM ADSL")))