slreportgen.report.DocBlock.createTemplate

Class: slreportgen.report.DocBlock
Package: slreportgen.report

Create DocBlock reporter template

Since R2019b

Syntax

template = slreportgen.report.DocBlock.createTemplate(templatePath,type)


Description

template = slreportgen.report.DocBlock.createTemplate(templatePath,type) creates a copy of the DocBlock reporter template specified by type at the templatePath location. You can use the copied template as a starting point to design a custom DocBlock 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 a DocBlock Reporter Template

Create a copy of the HTML template for the DocBlock reporter and save it with the name myDocBlockTemplate in the mytemplates folder.

template = slreportgen.report.DocBlock.createTemplate...
     ('mytemplates/myDocBlockTemplate','html');

After you modify the template, you can use it by setting the TemplateSrc property of the reporter.

Version History

Introduced in R2019b