rptconvert

Convert DocBook XML files generated by Report Explorer to formatted reports

collapse all in page

Syntax

rptconvert
formatList = rptconvert("-domformatlist")
templateList = rptconvert("-templatelist",domFormat)
templateList = rptconvert("-templatelist")
formatList = rptconvert("-formatlist")
stylesheetList = rptconvert("-stylesheetlist",legacyFormat)
stylesheetList = rptconvert("-stylesheetlist")
rptPath = rptconvert(srcDocBook)
rptPath = rptconvert(srcDocBook,outFormat)
rptPath = rptconvert(srcDocBook,outFormat,outTemplate)
rptPath = rptconvert(srcDocBook,outFormat,outStylesheet)
___ = rptconvert(___,addOpts)

Description

rptconvert opens the DocBook XML converter in the Report Explorer.

formatList = rptconvert("-domformatlist") returns a list of valid DOM formats.

templateList = rptconvert("-templatelist",domFormat) returns a list of valid templates for the specified DOM format.

templateList = rptconvert("-templatelist") returns a list of all valid template identifiers and descriptions.

formatList = rptconvert("-formatlist") returns a table of valid legacy formats that are not DOM formats.

stylesheetList = rptconvert("-stylesheetlist",legacyFormat) returns a list of valid style sheets for the specified legacy formats that are not DOM formats.

example

stylesheetList = rptconvert("-stylesheetlist") returns a list of all valid style sheet identifiers and descriptions.

rptPath = rptconvert(srcDocBook) converts the specified DocBook XML file, generated by the Report Explorer, to a report in the default format, HTML.

rptPath = rptconvert(srcDocBook,outFormat) converts the DocBook to the specified format with the default style sheet or default template of outFormat.

rptPath = rptconvert(srcDocBook,outFormat,outTemplate) uses the specific template of outFormat.

rptPath = rptconvert(srcDocBook,outFormat,outStylesheet) uses the specific style sheet of outFormat.

___ = rptconvert(___,addOpts) specifies additional options for the function.

Examples

collapse all

Retrieve a list of available HTML style sheets:

rptconvert("-stylesheetlist","html");

Input Arguments

collapse all

DOM format for which to retrieve the template list, specified as a character vector or string scalar. Legacy formats do not have templates. All DOM formats have templates.

Legacy format for which to retrieve the style sheet list, specified as a character vector or string scalar. All legacy formats except db have style sheets. DOM formats do not have style sheets.

Name or path of the DocBook to convert, specified as a character vector or string scalar.

Target output report format, specified as a character vector or string scalar.

Target output format template, specified as a character vector or string scalar. outTemplate must be a valid template of outFormat.

Note

Legacy formats do not have templates. All DOM formats have templates.

Target output format style sheet, specified as a character vector or string scalar. outStylesheet must be a valid template of outFormat.

Note

DOM formats do not have style sheets. All other formats, except db, have style sheets.

One or more additional options to control the running of the function, specified as these values.

ValueDescription
"-view"

Displays the converted document

"-quiet"

Suppresses status messages

"-verbose"

Shows detailed status messages

Output Arguments

collapse all

List of valid formats, returned as a two-column cell matrix of format identifiers and descriptions.

List of valid templates, returned as a two-column cell matrix of template identifiers and descriptions.

List of valid style sheets, returned as a two-column cell matrix of style sheet identifiers and descriptions.

Full path of the generated report file, returned as a character vector.

Version History

Introduced before R2006a

See Also

| | |

Topics