PitStopReport

This is an overview of the tags that can be used in the PitStopReport section in the config file (.prefs) of a regular or annotated report template.

Note:

This is the only section that is shared between regular and annotated reports.
ReportLayoutName and ReportLayoutVersion are mandatory tags. They must be present in your .prefs file.
The two last tags are only relevant for regular reports.

Tag	Description and values
ReportLayoutName	Name of the report template, which will be shown in the list of templates to choose from. Below is an example of this list in PitStop Pro. Note: If you want to use this Report in other languages, simply add the language code and enter a value in the corresponding language. For example: "ReportLayoutNameitIT" "Il mio modello" "ReportLayoutNamenlNL" "Mijn persoonlijke sjabloon" You can do this for other tags as well. Refer to The config file (.prefs) of a regular report.
ReportLayoutVersion	Specifies the version of the report. 1 = Regular report 2 = Annotated report
ReportLayoutType	Specifies the type of report. Use this value for annotated reports only and set it to AnnotatedReport. Otherwise, you will not see the new report in the list of reports in PitStop Pro.

Tag

Description and values

ReportLayoutName

Name of the report template, which will be shown in the list of templates to choose from. Below is an example of this list in PitStop Pro.

Note: If you want to use this Report in other languages, simply add the language code and enter a value in the corresponding language. For example:

"ReportLayoutNameitIT" "Il mio modello"
"ReportLayoutNamenlNL" "Mijn persoonlijke sjabloon"
You can do this for other tags as well. Refer to The config file (.prefs) of a regular report.

ReportLayoutVersion

Specifies the version of the report.

1 = Regular report
2 = Annotated report

ReportLayoutType

Specifies the type of report. Use this value for annotated reports only and set it to AnnotatedReport. Otherwise, you will not see the new report in the list of reports in PitStop Pro.

The following tags apply to regular reports only:

Tag	Description and values
IncludeWebHelpLinks	Displays or hides icons with hyperlinks to the website set in the WebHelpURLTemplate tag. true = Displays info icons next to each topic in the report (default). false = Hides info icons. Note: You can use a different icon as required; just add it to the content file and make sure to enter the page number in the "WebHelpLinkIconPage" tag (PitStopReportPDFTemplates).
WebHelpURLTemplate	A custom product help URL, which will be opened when users click the info icon. Note: Only applies if IncludeWebHelpLinks is set to "true". No value specified = the Enfocus Preflight Report Help is displayed. (default) Custom URL with “%1” and “%2” markers, which at runtime will be replaced with a webhelp ID and a language code. Example: http://www.mypdfsite.net/help.php?helpid=%1&lang=%2

Tag

Description and values

IncludeWebHelpLinks

Displays or hides icons with hyperlinks to the website set in the WebHelpURLTemplate tag.

true = Displays info icons next to each topic in the report (default).
false = Hides info icons.

Note: You can use a different icon as required; just add it to the content file and make sure to enter the page number in the "WebHelpLinkIconPage" tag (PitStopReportPDFTemplates).

WebHelpURLTemplate

A custom product help URL, which will be opened when users click the info icon.

Note: Only applies if IncludeWebHelpLinks is set to "true".

No value specified = the Enfocus Preflight Report Help is displayed. (default)
Custom URL with “%1” and “%2” markers, which at runtime will be replaced with a webhelp ID and a language code.
Example: http://www.mypdfsite.net/help.php?helpid=%1&lang=%2