Report Format Options
Include Document Source Lines in Report For
| • | Errors, Warnings, Messages Checkboxes - The document source lines that cause an error, warning, or message to be generated in a validation report can be included in the report. To see these source lines in the report, make sure the appropriate boxes are checked. All boxes are checked by default. |
| • | "Spread" for source document lines - When displaying a source line, this option specifies how many source line characters to display before and after the highlighted portion of the source line in the reports (the highlighted portion is the specific part of the line that the validator message is about). Because some source documents contain very long lines, this option is useful in limiting the amount of source document text shown for a validator message when the source line is very long. The default is 150. (New v9.00) |
Multiple Page Report Options
NOTE: Single page reports are not recommended except for very small jobs.
| • | Generate a multiple HTML page report (recommended) - Check this box to generate an HTML report that is divided into multiple pages. This is most useful if your target list is large and a single page report file would be too large and inefficient. If this option is checked, then "page 0" will be a summary report regardless of whether Include summary reports is checked or not. This option is enabled by default. |
| • | "Spread" for report navigation links - How many report page navigation links to link to before and after the current report page on the "navigation bar". This option is only used when a multiple page report is being generated. This option is useful in limiting the number of navigation links for multiple page reports that contain many pages. For example, before this feature was added, a 100 page report would generate a "navigation bar" with at least 100 links in it to navigate between each of the 100 report pages. With this feature, the number of navigation links is greatly reduced. For example, if this option is set to 3 and page 57 of a 100 page report is being viewed, then the navigation links will include direct links to 3 pages before page 57 (54, 55, and 56) and 3 pages after (58, 59, 60) (as well as some additional navigation links). Note that navigation links to the summary page, first page, last page, previous page, and next page are always provided. To use the old behavior that links to every report page, then set this option to a very large value like 9999. The default is 3. (New v9.00) |
| • | Reports per page - The maximum number of reports per page when generating a multiple page report. For fewer but larger report pages, increase this number so that more reports are contained per page. For more but smaller report pages, decrease this number so that fewer reports are contained per page. The default is 10. |
Include in Report
| • | Grand Totals Report - Check this box to include a grand total report. This report may include such items as the total number of documents with errors, the total number of errors, the total number of documents with warnings, the total number of warnings, the total number of documents with no errors or warnings, the total number of documents with one or more bad links, the total number of bad links, the total number of documents processed, the total processing time, and the report creation date. The information displayed may vary depending on the tool that is used. This option is enabled by default. |
| • | Summary Report - Check this box to include a summary report at the beginning of each and every report page. The summary report will have three sections listing 1) documents that have errors, 2) documents that have warnings (but no errors), 3) documents that have no errors or warnings, and (if checking links) 4) documents that have bad links. Except for page 0 of the report (which contains a complete summary report), the summary reports may only be a partial summary report that is only for reports contained on that specific page. Targets listed in the summary report will be linked to their individual reports so that you can click on the target and go directly to a target's report. Documents listed as having no errors or warnings will not be linked to their individual reports if Include reports only for documents containing errors or warnings is checked because no report will be generated for that document. This option is enabled by default. |
| • | List of documents containing no errors or warnings or no bad links in the summary report - Check this box to include a list of documents that contain no errors and no warnings in the summary report when the validator tool is used. If this box is unchecked, then the number of documents that would have been listed will be displayed instead. Note that on the complete summary report page ("page 0" which is also known as the complete summary page), documents with no errors and no warnings are not listed at all if this option is not checked. On partial summary reports (pages greater than 0), documents with no errors and no warnings are not listed if this option is not checked AND the document does not have any report on the page, whether it be a validation message report or a link report. This means that the document will still be listed in the partial summary report if there is a report for it on the page. This option works similarly for the link check tool, causing documents to be listed in the "no bad links" section if checked, or not listed if unchecked and there is no link report. This option is useful to uncheck if there is a long list of documents with no errors and no warnings and you don't care to know what they are or you want to minimize the size of the report. This option is enabled by default. |
| • | Important Messages/Errors From Job Run Report - Check this box to report the important messages and error messages that were generated during the job run (these messages are usually highlighted in red). This option is enabled by default. (New v10.0120) |
| • | Message reports only for documents containing errors or warnings - Check this box to remove message reports that don't contain errors or warnings. This decreases the size of the complete report if any targets do not have errors or warnings. If this box is checked, then reports for targets that have messages and comments but no errors or warnings will still not cause a message report to be generated. Therefore, you will not see the messages and comments generated by a target that does not have any errors or warnings if this option is checked. This option will not prevent link reports from being displayed if link checking is enabled and bad links are found. This option is enabled by default. |