R Rd2txt_options 設置文本幫助的格式選項

說明

此函數設置用於顯示文本幫助的各種選項。

用法

Rd2txt_options(...)

參數

...	包含命名選項或作為單獨命名參數傳遞的選項的列表。有關當前定義的內容，請參閱下文。

細節

此函數為 Rd2txt 函數持久設置各種格式選項，該函數用於顯示文本格式幫助。當前定義的選項有：

寬度

(默認80)：輸出頁麵的寬度。

最小縮進量

(默認 10)：列表中使用的最小縮進。

額外縮進

(默認值 4)：在每一層嵌套列表中使用的額外縮進。

節縮進

(默認值 5)：節的縮進級別。

額外部分

(默認值 2)：每個嵌套節級別的額外縮進。

項目項目符號

(默認 "* " ，星號在 UTF-8 和大多數 Windows 語言環境中替換為 Unicode 項目符號)：在逐項列表中用作項目符號的符號。

枚舉格式

：格式化枚舉列表中的項目編號的函數。

顯示網址

(默認 FALSE )：展開 ⁠\href⁠ 標簽時是否顯示 URL。

code_quote

(默認 TRUE )：是否渲染 ⁠\code⁠ 以及類似的單引號。

underline_titles

(默認 TRUE )：是否使用下劃線渲染節標題(通過退格)。

值

如果不帶參數調用，則返回列表中的所有選項設置。否則，它會更改指定的設置並以不可見的方式返回其先前的值。

例子

# The itemBullet is locale-specific
saveOpts <- Rd2txt_options()
saveOpts
Rd2txt_options(minIndent = 4)
Rd2txt_options()
Rd2txt_options(saveOpts)
Rd2txt_options()

作者

Duncan Murdoch

也可以看看

Rd2txt