Main Content

mlreportgen.report.TableOfContents.customizeReporter

Class: mlreportgen.report.TableOfContents
Package: mlreportgen.report

Create custom table of contents reporter class

expand all in page

Syntax

reporter = mlreportgen.report.TableOfContents.customizeReporter(classpath)

Description

reporter = mlreportgen.report.TableOfContents.customizeReporter(classpath) creates a table of contents (TOC) class definition file that is a subclass of mlreportgen.report.TableOfContents. The file is created at the specified classpath location. The TableOfContents.customizeReporter method also copies the default TOC templates to the <classpath>/resources/template folder. You can use the class definition file as a starting point to design a custom table of contents class for your report.

Input Arguments

expand all

Location of custom TOC section class, specified as a string or character array. The classpath argument also supports specifying a folder with @ before the class name.

Output Arguments

expand all

TOC Section reporter path, returned as the string specifying the path to the derived report class file.

Examples

Create Custom TOC Reporter

Create a custom TOC reporter and its associated default templates. The derived class file is created at the specified path relative to the current working folder. In this case, the path to the MyTOC.m class file is <current working folder>/newTOC/@MyTOC/myTOC.m. The default title page templates are in the <current working folder>/newTOC/@MyTOC/resources/templates folder.

import mlreportgen.report.*
TableOfContents.customizeReporter('newTOC/@MyTOC');

After editing this new class file, you can use it as your TOC section reporter.

toc = MyTOC();

Version History

Introduced in R2017b

See Also

| |