Worksheet/TableOfContents - Help

Online Help

All Products    Maple    MapleSim


Home : Support : Online Help : Worksheet/TableOfContents

Worksheet

  

TableOfContents

  

create a table of contents at the beginning of a Maple document

 

Calling Sequence

Parameters

Description

Examples

Compatibility

Calling Sequence

TableOfContents( target )

TableOfContents( target , opts )

TableOfContents( target , destination )

TableOfContents( target , destination , opts )

Parameters

target

-

string; name of file to read in .mw format

destination

-

sting; name of file to write in .mw format

opts

-

options; any number of options for the formatting of the table of contents

Description

• 

The command TableOfContents adds a table of contents of the section headings to the beginning of a Maple document (.mw). All headings in the table of contents are links to the corresponding section in the Maple document.

• 

If the second argument destination is omitted then the generated file with a table of contents is opened in the Maple GUI. Otherwise, the generated file is written with a table of contents to the destination file in .mw format.

• 

The opts argument can be one or more options to TableOfContents which are as follows:

• 

The option depth indicates the number of subsections (including the first level) that are included in the table of contents. The default value is 2.

• 

The option startingsize indicates the size of font of headings of the first level sections in the table of contents. The default value is 12.

• 

The option sizeincrement indicates the decrease in font size between each level of section title in the table of contents. The default value is 2.

• 

When the option bullets is specified the table of contents is created with indented bullet points instead of nested sections.

• 

When the option nosection is specified the table is not contained in section titled Table of contents and instead has a header of the same title.

• 

The option columns specifies the number of columns (as a positive integer) the table containing section titles has. The default is 0 which creates the table of contents without a table surrounding it. A value of columns 2 or greater splits the information across multiple columns to make the table of contents take less vertical space. A value of 1 creates the same table of contents as a value of 0 except contained within a table.

• 

The option color changes the color of the text of all the section titles of the table of contents. The default is the color of hyperlinks. The value can be specified in any form that ColorTools can recognize.

• 

When the option nounderline is specified all the hyperlink titles in the table of contents are formatted without underlines.

Examples

filecatkerneloptsdatadir,/help/Worksheet/SimpleSectionDocument.mw:

Worksheet:-TableOfContentsfile:

Worksheet:-TableOfContentsfile,depth=3,columns=3,color=Black,bullets,nounderline,startingsize=14,sizeincrement=3,nosection:

Compatibility

• 

The Worksheet:-TableOfContents command was introduced in Maple 2020.

• 

For more information on Maple 2020 changes, see Updates in Maple 2020.

See Also

Worksheet

XMLTools