slreportgen.report.DocBlock.createTemplate

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

Create DocBlock reporter template

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

expand all

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

Format of the output, specified as 'html', 'html-file', 'docx', or 'pdf'.

Output Arguments

expand all

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 output type. For example, if type is 'pdf', the file name extension is .pdftx.

Examples

expand all

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.

Introduced in R2019b