Batch Wizard Target List 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 files.

Formats

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

Old Format

This format is very simple. 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 directory 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 directory 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

Standard 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.

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 directory 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:

1 - target is a file
2 - target is a directory
4 - target is a URL
8 - include subdirectories (for directory targets only)
16 - process is set to 'Yes'
64 - never validate this target
128 - follow links (New v4.50)
256 - used internally (do not use) (New v4.50)
4194304 - when including subdirectories, exclude directories that begin with an underscore (_) or that are named "CVS" (New v4.51)

The "FLAGS=" line in the FIEC section 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 "FLEXTENSIONS=(extensions)" in a TARGET section to limit the links that are followed to the specified file extensions. Example: "FLEXTENSIONS=HTM,HTML". (New v4.50)
Use "FLLIMITTO=(string)" in a TARGET section to limit the links that are followed to those that begin with the specific string. Example: "FLLIMITTO=http://www.htmlvalidator.com/". (New v4.50)
Use "FLDEPTHLIMIT=(limit)" in a TARGET section 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. (New v4.50)

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 directory 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 directories from being processed. (New v5.50)

[ Table of Contents ]