mlreportgen.dom.TOC class

Package: mlreportgen.dom
Superclasses:

Create placeholder for generating table of contents

Description

Create a placeholder for a document table of contents. When a generated Word document opens, Word replaces the placeholder with a TOC that it generates. Similarly, when a generated HTML document opens in an HTML browser, the browser replaces the placeholder with a TOC that it generates. For PDF, the DOM API replaces the placeholder with a TOC that it generates when outputting the document.

In all cases, the TOC entries consist of the content of paragraphs using the number of heading levels that you specify. For PDF and Word, the TOC placeholder also specifies a leader that fills the space between the content and the page number in the TOC entry.

Construction

toc = TOC() generates a three-level TOC that uses a dot leader.

toc = TOC(levels) uses the specified number of heading levels.

toc = TOC(levels,leader) uses the specified leader.

Input Arguments

levels — Number of heading levels to use in TOC

positive integer

Number of heading levels to use in TOC, specified as a positive integer.

leader — Type of leader to use between title and page number

'.' (default) | ' ' (space)

Type of leader to use between title and page number, specified as '.' (i.e., period or dot) or ' ' (a space).

Output Arguments

toc — Table of contents

mlreportgen.dom.TOC object

Table of contents, returned as an mlreportgen.dom.TOC object.

Properties

Children — Children of document element

array of DOM objects

Children of this document element, specified as an array of DOM objects. This property is read-only.

CustomAttributes — Custom attributes of this element

array of mlreportgen.dom.CustomAttribute objects

Custom attributes of this element, specified as an array of mlreportgen.dom.CustomAttribute objects. Use custom attributes supported by the output format.

Id — ID for this document element

character vector | string scalar

ID for this document element, specified as a character vector or string scalar. The DOM generates a session-unique ID when it creates the document element. You can specify your own ID.

LeaderPattern — Leader type for TOC

'.' (default) | ' ' (space)

Type of leader to use between title and page number, specified as '.' (i.e., period or dot) or .' ' (a space).

NumberOfLevels — Number of heading levels to use in TOC

positive integer

Number of heading levels to use in the TOC, specified as a positive integer.

Parent — Parent of document element

DOM object

Parent of this document element, specified as a DOM object. This property is read-only.

Style — Format specification

array of format objects

Format objects that specify the format of a document element.

StyleName — Style to apply from style sheet

character vector

Name of the style to apply from the style sheet, specified as a character vector.

Tag — Tag for this document element

character vector | string scalar

Tag for this document element, specified as a character vector or string scalar.

The DOM generates a session-unique tag as part of the creation of this object. The generated tag has the form CLASS:ID, where CLASS is the object class and ID is the value of the Id property of the object. Specifying your own tag value can help you to identify where an issue occurred during document generation.

Examples

Insert a Table of Contents into a Document

This example adds a table of contents to a document using a TOC object. This document contains three levels of heads—|Heading1|, Heading2, and Heading3. Because the TOC object specifies only two heading levels, Heading3 is not included in the TOC. The leader is a space.

import mlreportgen.dom.*;
d = Document('mydoc','pdf');
open(d);

title = append(d, Paragraph('My TOC Document'));
title.Bold = true;
title.FontSize = '28pt';

toc = append(d,TOC(2,' '));
toc.Style = {PageBreakBefore(true)};

h1 = append(d,Heading1('Chapter 1'));
h1.Style = {PageBreakBefore(true)};
p1 = append(d,Paragraph('Hello World'));

h2 = append(d,Heading2('Section 1.1'));
h2.Style = {PageBreakBefore(true)};
p2 = append(d,Paragraph('Another page'));

h3 = append(d,Heading3('My Subsection 1.1.a'));
p3 = append(d, Paragraph('My Level 3 Heading Text'));

close(d);
rptview(d.OutputPath);