mlreportgen.report.TitlePage.createTemplate

Class: mlreportgen.report.TitlePage
Package: mlreportgen.report

Create title page template

Syntax

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


Description

template = mlreportgen.report.TitlePage.createTemplate(templatePath,type) creates a copy of the default title page 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 title page 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 copy of the template, returned as a string scalar. The file name extension of the template is assigned based on the specified template type. For example, if the type argument is 'pdf', the file name extension is .pdftx.

Examples

Create Title Page Template

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

import mlreportgen.report.*
rpt = Report('My Report','html');
tp = TitlePage();
tp.Title = 'Data Summary';
template = TitlePage.createTemplate('mytemplates\myTitlePg','html');
tp.TemplateSrc = template;