Hmisc (version 5.2-1)

hidingTOC: Moving and Hiding Table of Contents

Description

Moving and hiding table of contents for Rmd HTML documents

Usage

hidingTOC(
  buttonLabel = "Contents",
  levels = 3,
  tocSide = c("right", "left"),
  buttonSide = c("right", "left"),
  posCollapse = c("margin", "top", "bottom"),
  hidden = FALSE
)

Value

a HTML formated text string to be inserted into an markdown document

Arguments

buttonLabel

the text on the button that hides and unhides the table of contents. Defaults to Contents.

levels

the max depth of the table of contents that it is desired to have control over the display of. (defaults to 3)

tocSide

which side of the page should the table of contents be placed on. Can be either 'right' or 'left'. Defaults to 'right'

buttonSide

which side of the page should the button that hides the TOC be placed on. Can be either 'right' or 'left'. Defaults to 'right'

posCollapse

if 'margin' then display the depth select buttons vertically along the side of the page choosen by buttonSide. If 'top' then display the depth select buttons horizontally under the button that hides the TOC. Defaults to 'margin'. 'bottom' is currently unimplemented.

hidden

Logical should the table of contents be hidden at page load Defaults to FALSE

Author

Thomas Dupont

Details

hidingTOC creates a table of contents in a Rmd document that can be hidden at the press of a button. It also generate buttons that allow the hiding or unhiding of the diffrent level depths of the table of contents.

Examples

if (FALSE) {
hidingTOC()
}