ReporteRs (version 0.8.2)

addTOC.bsdoc: Insert a table of contents into a bsdoc object

Description

Insert a table of contents into a bsdoc object.

Usage

# S3 method for bsdoc
addTOC(doc, ...)

Arguments

doc

Object of class bsdoc where table of content has to be added

...

further arguments, not used.

Value

an object of class bsdoc.

Details

The function do specify to add a table of contents on the right side of the content.

See Also

bsdoc, addTOC.bsdoc , docx, addTOC.docx

Examples

# NOT RUN {
#START_TAG_TEST
doc.filename = "addTOC_example/example.html"

# set default font size to 11
options( "ReporteRs-fontsize" = 11 )

doc = bsdoc( )
doc = addTitle( doc, 'Title 1', level = 1 )

doc = addTitle( doc, 'Title 2', level = 1 )

doc = addTitle( doc, 'Title 3', level = 1 )

doc = addTitle( doc, 'Title A', level = 2 )

doc = addTitle( doc, 'Title B', level = 2 )

doc = addTOC( doc )

# Write the object
writeDoc( doc, file = doc.filename )
#STOP_TAG_TEST
# }