Skip to content

Commit c1b51bc

Browse files
committed
Doc update for #407
1 parent 4776f3b commit c1b51bc

12 files changed

Lines changed: 87 additions & 22 deletions

NEWS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
* Added `report_options()` function to control various features of the report.
44
This function has the following parameters:
5-
- "allow_code" to insert RTF codes directly into RTF documents.
5+
- "allow_code" to insert codes directly into documents. Works for RTF and HTML.
66
- "line_break" to turn off automatic insertion of line breaks.
77
- "line_count" to set the number of lines on a page.
88
- "page_wrap" to turn off automatic page wrapping.

R/report_spec.r

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -840,11 +840,12 @@ set_margins <- function(x, top=NULL, bottom=NULL,
840840
#' A function to set some options for the report.
841841
#' The options include the ability to control features such as auto line breaking,
842842
#' auto pagination, and auto page wrapping. These features are normally on by default,
843-
#' but sometimes it is desirable to turn them off. For RTF, it provides options for allowing
844-
#' users to insert RTF code and decide the structure of titles.
843+
#' but sometimes it is desirable to turn them off. It also
844+
#' provides options for allowing users to insert custom code and decide the
845+
#' structure of titles.
845846
#' @param x The report spec object.
846847
#' @param allow_code Whether to allow the user to insert custom code into the report.
847-
#' Currently applies only to RTF outputs. Default is FALSE. When TRUE, users can
848+
#' Currently applies to RTF and HTML outputs. Default is FALSE. When TRUE, users can
848849
#' insert code in the data, titles, or footnotes. To insert curly braces,
849850
#' double them so as to not interfere with the glue functionality, which uses
850851
#' single curly braces as an escape.

docs/articles/reporter-codeinsert.html

Lines changed: 2 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/articles/reporter-faq.html

Lines changed: 20 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/news/index.html

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/pkgdown.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ articles:
2323
reporter-title_header: reporter-title_header.html
2424
reporter-wrap: reporter-wrap.html
2525
reporter: reporter.html
26-
last_built: 2026-07-16T12:25Z
26+
last_built: 2026-07-16T20:17Z
2727
urls:
2828
reference: https://reporter.r-sassy.org/reference
2929
article: https://reporter.r-sassy.org/articles

docs/reference/report_options.html

Lines changed: 7 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/report_options.Rd

Lines changed: 4 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

vignettes/reporter-codeinsert.Rmd

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,8 @@ knitr::opts_chunk$set(
1515
```
1616
The **reporter** package allows users to insert code directly with
1717
`report_options(allow_code = TRUE)`. This feature is currently available only
18-
for RTF output.
18+
for RTF and HTML outputs. This example will focus on RTF. HTML
19+
code insertion works similarly.
1920

2021
## Insert Code
2122

vignettes/reporter-codeinsert.html

Lines changed: 4 additions & 3 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)