Batch Wizard Target List File Format
(tick_24Pro, cross_24Std, cross_24Lite)

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.

TIP: If you are considering creating your own target lists, consider the possibility of creating a "master" HTML document with links to all the documents that you want to check. You can then tell the Batch Wizard to check that "master" document and to follow the links in it.

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 text files and can be made using a text editor like CSE HTML Validator or Microsoft Notepad. All formats should be saved to a filename that ends with an ".lst" extension.

New Format (Current)

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

In order to be recognized, this format must start with an XML declaration.

The first tag in a target list in this format should be <csebatchwizardtargetlist>

The last line should be </csebatchwizardtargetlist>

All tags and attributes are case-sensitive and should all be in lowercase characters.

An "fiec" tag may be contained in a URL "target" tag.

Extra attributes, elements, and comments added-to/contained-in the "options" tag or a "target" tag will be preserved when loading and saving a target list.

This format is used in CSE HTML Validator v7.0x and above.

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:

1 - target is a file

2 - target is a folder/directory

4 - target is a URL

8 - include subfolders (for folder targets only)

16 - process is set to 'Yes'

64 - never validate this target

128 - follow links

256 - used internally (do not use)

4194304 - when including subfolders, exclude folders that begin with an underscore (_) or that are named "CVS"

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

1 - use username and password when requesting URL (if set, a username and password should be provided with "USERNAME=" and "PASSWORD=").

Other options:

Use the "fllimitto" attribute in a "target" tag to limit the links that are followed to those that begin with the specific string. Example: fllimitto="http://www.htmlvalidator.com/".

Use the "flextnofollow" attribute in a "target" tag to limit the links that are followed by excluding the specified file extensions. Example: flextnofollow="exe,zip". (New v12.00)

Use the "flextensions" attribute in a "target" tag to limit the links that are followed to the specified file extensions. Example: flextensions="htm,html,php".

Use the "flmimetypes" attribute in a "target" tag to limit the links that are followed to the specified MIME types (for links that are not explicitly included or excluded by file extension). Example: flmimetypes="text/html,text/css". (New v12.00)

Use the "fldepthlimit" attribute in a "target" tag to limit the depth to which links are followed. Set to "-1" for no limit. A limit of "0" does not follow any links even if link following is enabled.

Use the "acceptlanguage" attribute in a "fiec" tag to specify an 'Accept-Language' header. (New v9.02)

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.