CSE HTML Validator Std/Pro v7.00 BETA 1 Documentation

[ Home | Download | Buy Now | Support | Search Local | Search Online ]

[ Table of Contents ]

Batch Wizard Target List File Format

The Batch Wizard is able to load target lists from files. In normal operation, you can create these lists and save them to a file using the Batch Wizard. However, there may be situations where you will want to manually create the target list file. You can do this if you know the correct format of a target list file.

Formats

There are three formats, the first two are old formats. The Batch Wizard never saves target lists using the old formats but it can still load them. The third format is the normal, standard format, which is based on XML. All formats are ASCII files and can be made using a text editor like CSE HTML Validator or Microsoft Notepad. All formats should also end in an ".lst" extension.

New Format

This format is basically the second old format, but is reformatted based on XML. Information about this format is listed below.

To add a URL target, include a "target" tag like this in "csebatchwizardtargetlist":

<target flags="20" target="http://www.htmlvalidator.com/">
<fiec agent="CSE HTML Validator" flags="0" password="mypassword" url="http://www.htmlvalidator.com/" username="myusername" />
</target>

To add a file target, include a "target" tag like this in "csebatchwizardtargetlist":

<target flags="17" target="c:\html\index.html" />

To add a folder target, include a "target" tag like this in "csebatchwizardtargetlist":

<target flags="18" target="c:\html\family" />

Example file (example.lst):

<?xml version="1.0"?>
<csebatchwizardtargetlist version="8">
<options />
<target flags="20" target="http://www.htmlvalidator.com/">
<fiec version="1" agent="CSE HTML Validator" flags="0" url="http://www.htmlvalidator.com/" username="myusername" />
</target>
<target flags="18" target="c:\html\family" />
<target flags="17" target="c:\html\index.html" />
</csebatchwizardtargetlist>

The "flags" attribute for the "target" element (but not for the "fiec" tag) is a bitmapped value:

The "flags" attribute for the "fiec" element is a bitmapped value:

Other options:

Options Tag

A single "options" tag may be contained in the "csebatchwizardtargetlist" tag. The "options" tag may have the following attributes:

htmlreportfilename="filename"

Where "htmlreportfilename" specifies the filename to save the HTML report to. This overrides the HTML report filename set in the Batch Wizard Options if it specifies anything other than an empty string. The value of the "htmlreportfilename" attribute should contain the full path to the filename.

htmlreportcssfilename="filename"

Where "htmlreportcssfilename" specifies the external CSS style sheet to use for the report. This overrides the default external style sheet if "htmlreportcssfilename" specifies anything other than an empty string. The external CSS style sheet specified here will be copied to the report folder and renamed appropriately when a report is generated. The value of the "htmlreportcssfilename" attribute should contain the full path to the filename.

htmlreportfooterfilename="filename"

Where "htmlreportfooterfilename" specifies the filename of the HTML footer to use for HTML report footers. This overrides the default HTML footer if "htmlreportfooterfilename" specifies anything other than an empty string. The value of the "htmlreportfooterfilename" attribute should contain the full path to the filename.

excludestrings="strings"

Where "excludestrings" specifies a list of strings, separated by semicolons. If a target matches one of these strings then it is not processed. This allows you to exclude certain folders from being processed.

excludelinkstrings="strings"

Where "excludelinkstrings" specifies a list of strings, separated by semicolons. If a link matches one of these strings then it is not checked. This allows you to exclude certain links from being link checked and reported in the link check report.

cistrings="strings"

Where "cistrings" specifies a list of strings, separated by semicolons. This overrides the default value if "cistrings" is anything other than an empty string. If a target matches one of these strings then it is compared to other targets with a case insensitive compare. This allows you to specify servers that are case insensitive. For example, if the server "www.domain.com" is a Microsoft Windows server and is case insensitive, then specify cistrings="http://www.domain.com*" so that the Batch Wizard knows that http://www.domain.com/page.html is the same document as http://www.domain.com/PAGE.HTML. This will prevent the Batch Wizard from checking the same document twice. Specify cistrings="*" to compare all targets case insensitively.

First Old Format (The Oldest and Simplest)

This format is very simple and is the oldest of all the formats. A file in this format contains a one target per line. Different target types can be mixed throughout the file. For example, you do not need to have all URLs, files, or folder targets in one section of the file. Each line in the target list file should begin with "URL : ", "File: ", or "Dir : " (not case sensitive). Note the spaces around the colon. There must be a space after the colon. For "URL" and "Dir" there must also be a space before the colon.

You can load a file in this format but if you save it, it will be converted to the standard format.

To add a URL target, include a line like this:

URL : http://www.htmlvalidator.com/

To add a file target, include a line like this:

File: c:\html\index.html

To add a folder target, include a line like this:

Dir : c:\html\family

Example file (example.lst):

URL : http://www.htmlvalidator.com/
File: c:\html\index.html
Dir : c:\html\family

Second Old Format

This format is more complex but more flexible and powerful. The first line in a target list in this format should be "<CSEBATCHWIZARDTARGETLIST>". The last line should be "</CSEBATCHWIZARDTARGETLIST>" (without the quotes). CSEBATCHWIZARDTARGETLIST, FLAGS, TARGET, AGENT, PASSWORD, etc. are all case sensitive and should all be in uppercase characters. The FIEC section is only used for URL targets. This format was used in newer CSE HTML Validator versions up to v6.53.

To add a URL target, include a section like this:

<TARGET>
<FIEC>
AGENT=CSE HTML Validator
FLAGS=0
PASSWORD=mypassword
URL=http://www.htmlvalidator.com/
USERNAME=myusername
</FIEC>
FLAGS=20
TARGET=http://www.htmlvalidator.com/
</TARGET>

To add a file target, include a section like this:

<TARGET>
FLAGS=17
TARGET=c:\html\index.html
</TARGET>

To add a folder target, include a section like this:

<TARGET>
FLAGS=18
TARGET=c:\html\family
</TARGET>

Example file (example.lst):

<CSEBATCHWIZARDTARGETLIST>
VERSION=2
<TARGET>
FLAGS=20
TARGET=http://www.htmlvalidator.com/
<FIEC>
AGENT=CSE HTML Validator
FLAGS=0
PASSWORD=mypassword
URL=http://www.htmlvalidator.com/
USERNAME=myusername
</FIEC>
</TARGET>
<TARGET>
FLAGS=17
TARGET=c:\html\index.html
</TARGET>
<TARGET>
FLAGS=18
TARGET=c:\html\family
</TARGET>
</CSEBATCHWIZARDTARGETLIST>

The "FLAGS=" line in the TARGET section (but not in the FIEC section) is a bitmapped value:

The "FLAGS=" line in the FIEC section is a bitmapped value:

Other options:

OPTIONS Section (New v5.00)

An OPTIONS section can be added in the CSEBATCHWIZARDTARGETLIST section. This section can contain:

HTMLREPORTFILENAME=filename

Where HTMLREPORTFILENAME is the filename to save the HTML report to. This overrides the HTML report filename set in the Batch Wizard Options if it is anything other than an empty string. HTMLREPORTFILENAME should contain the full path to the filename.

HTMLREPORTCSSFILENAME=filename

Where HTMLREPORTCSSFILENAME is the external CSS style sheet to use for the report. This overrides the default external style sheet if HTMLREPORTCSSFILENAME is anything other than an empty string. The external CSS style sheet specified here will be copied to the report folder and renamed appropriately when a report is generated. HTMLREPORTCSSFILENAME should contain the full path to the filename. (New v5.50)

HTMLREPORTFOOTERFILENAME=filename

Where HTMLREPORTFOOTERFILENAME is the filename of the HTML footer to use for HTML report footers. This overrides the default HTML footer if HTMLREPORTFOOTERFILENAME is anything other than an empty string. HTMLREPORTFOOTERFILENAME should contain the full path to the filename. (New v6.00)

EXCLUDEBEGINSTRINGS=strings

Where EXCLUDEBEGINSTRINGS specifies a list of strings, separated by semicolons. If a target begins with one of these strings then it is not processed. This allows you to exclude certain folders from being processed. (New v5.50)

CIBEGINSTRINGS=strings

Where CIBEGINSTRINGS specifies a list of strings, separated by semicolons. This overrides the default value if CIBEGINSTRINGS is anything other than an empty string. If a target begins with one of these strings then it is compared to other targets with a case insensitive compare. This allows you to specify servers that are case insensitive. For example, if the server "www.domain.com" is a Microsoft Windows server and is case insensitive, then specify CIBEGINSTRINGS=http://www.domain.com so that the Batch Wizard knows that http://www.domain.com/page.html is the same document as http://www.domain.com/PAGE.HTML. This will prevent the Batch Wizard from checking the same document twice. Specify CIBEGINSTRINGS=* to compare all targets case insensitively. (New v6.50)

[ Table of Contents ]