11% File src / library / tools / man / Rd2HTML.Rd
22% Part of the R package , https : // www.R - project.org
3- % Copyright 2008 - 2022 R Core Team
3+ % Copyright 2008 - 2025 R Core Team
44% Distributed under GPL 2 or later
55
66\name {Rd2HTML }
@@ -34,7 +34,7 @@ Rd2txt(Rd, out = "", package = "", defines = .Platform$OS.type,
3434
3535Rd2latex(Rd , out = " " , defines = .Platform $ OS.type ,
3636 stages = " render" , outputEncoding = " UTF-8" ,
37- fragment = FALSE , ... , writeEncoding = TRUE ,
37+ fragment = FALSE , ... , writeEncoding = outputEncoding != " UTF-8 " ,
3838 concordance = FALSE )
3939
4040Rd2ex(Rd , out = " " , defines = .Platform $ OS.type ,
@@ -75,7 +75,7 @@ Rd2ex(Rd, out = "", defines = .Platform$OS.type,
7575 standalone HTML file. If \code {FALSE }, the header and footer are
7676 omitted , so that the output can be combined with other fragments.
7777 }
78- \item {hooks }{A list of functions controlling details of
78+ \item {hooks }{a list of functions controlling details of
7979 output. Currently the only component used is \code {pkg_href }, which
8080 is used by \code {pkg2HTML } to determine the output HTML file path
8181 given a package name as input. }
@@ -86,15 +86,16 @@ Rd2ex(Rd, out = "", defines = .Platform$OS.type,
8686 examples section is wrapped inside a \code {rcode } block. }
8787 \item {Links , Links2 }{\code {NULL } or a named (by topics ) character vector of
8888 links , as returned by \code {\link {findHTMLlinks }}. }
89- \item {options }{An optional named list of options to pass to
89+ \item {options }{an optional named list of options to pass to
9090 \code {\link {Rd2txt_options }}. }
9191 \item {... }{ additional parameters to pass to \code {\link {parse_Rd }} when
9292 \code {Rd } is a filename. }
93- \item {writeEncoding }{should \verb {\inputencoding } lines be written in
94- the file for non - ASCII encodings ?}
95- \item {commentDontrun }{should \verb {\dontrun } sections be commented
93+ \item {writeEncoding }{logical : should an \verb {\inputencoding } line be written
94+ for non - ASCII encodings ? \LaTeX release 2018 - 04 - 01 and later
95+ default to UTF - 8 ; the declaration is obsolete in that case. }
96+ \item {commentDontrun }{logical : should \verb {\dontrun } sections be commented
9697 out ?}
97- \item {commentDonttest }{should \verb {\donttest } sections be commented out ?}
98+ \item {commentDonttest }{logical : should \verb {\donttest } sections be commented out ?}
9899}
99100\details {
100101 These functions convert help documents : \code {Rd2HTML } produces HTML ,
0 commit comments