mlreportgen.report.TableOfContents.createTemplate

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

Create table of contents section template

Syntax

template = mlreportgen.report.TableOfContents.createTemplate(templatePath,type)


Description

template = mlreportgen.report.TableOfContents.createTemplate(templatePath,type) creates a copy of the table of contents (TOC) reporter template specified by type at the location specified by templatePath. You can use the copied template as a starting point to design a custom TOC template for your report.

Input Arguments

templatePath — Path and file name of new template

character vector | string scalar

Path and file name of the new template, specified as a character vector or string scalar.

type — Type of template

"html" | "html-file" | "docx" | "pdf"

Type of template, specified as "html", "html-file", "docx", or "pdf".

Output Arguments

template — Path and file name of template copy

string scalar

Path and file name of the template copy, returned as a string scalar. The specified template type determines the file name extension of the template. For example, if the type argument is 'pdf', the file name extension is .pdftx.

Examples

Create TOC Template

Before you run this example, create a copy of the default HTML TableOfContents template in the mytemplates folder. Name the copied template myTOC.htmtx. Edit the template as desired. To use the new template for the TOC, assign its path to the TableOfContents TemplateSrc property.

import mlreportgen.report.*
rpt = Report('My Report','html');
toc = TableOfContents();
template = TableOfContents.createTemplate('mytemplates\myTOC','html');
toc.TemplateSrc = template;

Version History

Introduced in R2017b