Read Me Page Accessibility, HTML, CSS, Broken Links, Spell Checking

Embedded version

Total Validator Embedded runs from the command line for use within an automated testing system, such as continuous integration. Note: The licence prevents using it within any product or service you may provide to third parties, and within any product or service which may be used to avoid purchasing Total Validator Basic or Pro licences.

An example Windows batch file for running from the command line is provided called TotalValidatorEmb.bat. This may be found in the application folder, for example; C:\Program Files\TotalValidatorEmb. An equivalent shell script called TotalValidatorEmb.sh is provided for Linux. You must run these batch/script files from the folder where they reside so that Total Validator can find all the resources needed, otherwise an error will occur.

Options

The following options may be used when running from the command line. Note that whenever you use Total Validator Pro it automatically creates a properties file in the results folder. This is done to help you to convert what you select in Total Validator Pro into the command line properties below.

Detailed descriptions of each option are provided in the Total Validator Pro documentation for the corresponding option.

  • -help : displays the list of command line options and exits.
  • -properties Path_To_File : Where Path_To_File is a properties file containing the command line options.

Main options equivalents:

  • -url URL : Where URL is the start page, e.g. https://mywebpage.com/index.html
  • -file Path_To_File : Where Path_To_File is the local start web page, e.g. c:\mysite\index.html. You must use this or -url to test something.
  • -dtd DTD : Where DTD represents the HTML specification. See below for valid values.
  • -accessibility 508|A2|AA2|AAA2|508-OLD|A|AA|AAA : Supply one of the values 508|A2|AA2|AAA2|508-OLD|A|AA|AAA to represent the WAI or Section 508 specification you wish to test against.
  • -ignorecsspages : Ignore CSS pages with WCAG2.
  • -css 1|2.1|3 : Supply one of the CSS levels you wish to test against.
  • -ignorevendor : Ignore CSS vendor extensions.
  • -brokenlinks : Test for and report any broken links.
  • -spellcheck : Perform a spell check.
  • -listenport Port : Where Port is the port Total Validator Pro listens on for spell check additions to a personal dictionary. This must be an integer in the range (1-65535). Defaults to 9889.

Include options equivalents:

  • -pages Pages : Where Pages is the number of pages to test. By default it will only test one page. Set this to zero to test all pages.
  • -stopafterpg Pages : Where Pages is the maximum number of pages with issues to report before stopping.
  • -stopafter Issues : Where Issues is the maximum number of issues to report before stopping.
  • -depth Depth : Where Depth is the directory depth below the start page.
  • -excludepath Path_To_Exclude : Where Path_To_Exclude is a path within the starting URL to exclude when testing more than one page (must start with a '/'). Regular expressions may be used, and you can use this option more than once.
  • -includepath Path_To_Include : Where Path_To_Include is a path within the starting URL to include when testing more than one page (must start with a '/'). Regular expressions may be used, and you can use this option more than once.
  • -userobots : Exclude/include paths specified in robots.txt
  • -ignoreidentical : Ignore duplicate pages and style sheets.
  • -followlinks : Follow all links on the start page.
  • -followbelow : Follow links below the start page only.
  • -validateerrors : Test error pages when HTTP error codes are returned.
  • -ignorecase : Ignore case when deciding whether to follow links.
  • -noquery : Strip off query parameters from links before testing or following them.
  • -nosession : Strip off session ids from links before testing or following them, e.g. http://yourdomain/page.html;session_id

Issues options equivalents:

  • -ignoreprob : Ignore probable errors.
  • -ignorewarn : Ignore warnings.
  • -ignoreinfo : Ignore extra information messages.
  • -issuesbyitem Item_Definition : Ignore issues by id/class/element. Where Item_Definition is in the format: #id|.class|element=<comma-separated list of issue codes>. Use an empty list to ignore all issues. You can use this option more than once.
  • -ignoreissues Issues_List : Ignore these issues. Where Issues_List is a comma-separated list of issue codes to ignore.
  • -includeissues Issues_List : Only test these issues. Where Issues_List is a comma-separated list of issue codes to include.

Links options equivalents:

  • -timeout Seconds : If testing for broken links or more than one page, then Seconds is the time to wait before declaring a link broken. This must be a value between 10 and 120. It defaults to 20.
  • -concurrency Maximum : If testing for broken links or more than one page, then Maximum is the maximum number of links to test simultaneously. This must be a positive integer. Set to 0 to test all links simultaneously. It defaults to 100.
  • -lpause MilliSeconds : If concurrency is set to 1, then MilliSeconds is the time to pause in milliseconds before testing each link. This must be an integer, greater than 0.
  • -reportredirects : If testing for broken links, report all 301/302/303 redirection warnings.
  • -ignoreotherdomains : Will ignore links to domains different to the start page.
  • -ignoreotherhosts : Will ignore links to hosts different to the start page.

Spell Check options equivalents. These must all appear after -spellcheck:

  • -uppercase : Spell check words that are all in upper case.
  • -mixedcase : Spell check words that are in mixed case.
  • -wordswithdigits : Spell check words with digits in.
  • -includecode : Spell check words within <samp>, <code>, and <kbd> tags.
  • -checkattrs : Spell check text in these attributes: 'alt', 'title', 'summary', 'label', 'prompt', 'standby'.
  • -punctuated : Spell check words surrounded by characters other than quote marks.
  • -ignoresuggestions : Don't display alternative words when a word cannot be found in the dictionary.
  • -checkforrepeats : Display repeated words e.g. 'the the'.
  • -showlangcodes : Display the language code next to each unrecognised word.
  • -savebadwords : Save all the unrecognised words to the personal dictionaries folder.
  • -saveforeign : Save all words with unknown language codes to the personal dictionaries folder.
  • -usebritish : Use British instead of American as the default English language code.
  • -correctionsfolder Path_To_Folder : Where Path_To_Folder is the folder used for personal dictionaries.
  • -owndics Paths_To_Files : Where Paths_To_Files is a comma-separated list of paths to one or more external dictionaries.
  • -ignorelangs Language_Codes : Where Language_Codes is a comma-separated list of language codes to ignore.
  • -defaultlangcode Language_Code : Where Language_Code is the default to use when a page doesn't specify one.

Network options equivalents:

  • -cookiepolicy ACCEPT_ALL|ACCEPT_SERVER|ACCEPT_SESSION|ACCEPT_NONE : Use this option to specify how you wish to deal with cookies. Defaults to ACCEPT_SERVER.
  • -cookie Cookie : Where Cookie is a standard set-cookie HTTP header. This cookie will be treated like a normal cookie received from the server for the start page and subject to the policies defined above.
  • -identity identity : Where identity is the name of a user agent as displayed on the Network tab of Total Validator Pro.
  • -ppause MilliSeconds : Where MilliSeconds is the time to pause in milliseconds before retrieving each page. This must be an integer, greater than 0.
  • -user UserName : Where UserName is required for HTTP authentication.
  • -password Password : Where Password is required for HTTP authentication.

Proxy Server options equivalents:

  • -ignoreproxy : Ignore any operating system proxy settings, e.g. those set in the 'Internet Options' control panel applet in Windows.
  • -proxyhost Host : Where Host is the name of the proxy server you need to go through to access the start page.
  • -proxyport Port : Where Port is the port the proxy server listens on. This must be an integer in the range (1-65535).
  • -proxysocks : Use the SOCKS protocol to talk to the proxy server.
  • -puser UserName : Where UserName is required by an authenticating proxy server.
  • -ppassword Password : Where Password is required by an authenticating proxy server.
  • -noproxyfor Hosts : Where Hosts is a comma-separated list of hosts which bypass the proxy server.

Forms options equivalents: (Also see Notes below)

  • -actionX Action : Where Action is the value of the 'action' attribute value to match for form submission. X is a number greater than zero to allow more than one form to be specified.
  • -actionregexX : Treat the -action option as a regular expression. X is used to match with the correct -action.
  • -submitX Name : Where Name is the name of the submit button to use if there is more than one. X is used to match with the correct -action.
  • -paramX Name=Value : Where Name is the name of a parameter to submit when sending a form, and Value is its value, e.g. -param userid=julie, or -param userid= to send a blank value. X is used to match with the correct -action.
  • -sso : Use SAML authentication.

Results options equivalents:

  • -resultsfolder Path_To_Folder : Where Path_To_Folder is the folder you wish to store the results in. This defaults to the documents folder.
  • -uniquereport : Output the results into a unique folder.
  • -detailsdefault HOVER|SHOW_ALL|HIDE_ALL : The default value for the 'Display issues details' option on the results pages. Defaults to HOVER.
  • -sortbydefault LINKS|PATH|MOST|LEAST : The default value for the 'Sort by' option on the results pages. Defaults to LINKS.
  • -showsuccess : Use this option to list pages that had no reported issues.
  • -shortreport : Select the 'Short report' checkbox on the results pages.
  • -hidecontent : Select the 'Hide content' checkbox on the results pages.

Additional results options:

  • -shortestreport : Display a short form of the results.
  • -showresultspath : Output to stdout the path to the results file.
  • -stdout : Output the results file to stdout. Only works if a single page is being tested.
  • -suppressresults : Do not save the results to disk. If you have -stdout set then the results may still be captured. Useful with -extendedstatus to check how successful testing was.
  • -extendedstatus : Output an exit status which is the sum of the values: 4 if any test errors, 2 if any test warnings, 1 if any program errors, and 0 if all okay.

DTD values

Valid values for use with the -dtd option above are listed below. Note that these are case-sensitive and you must include the double quotes where shown:

Form options

With the -action, -actionregex, -submit, -param form options you may wish to supply information for more than one form. If so then add a unique number greater than zero to the option name to distinguish between each form.

For example, with just one form you can pass the options like this:

-action authenticate/login -param userid=julie -param password=test

With two forms you need to identify which parameters to use with which form action:

-action1 authenticate/login -param1 userid=julie -param1 password=test
-action2 purchase -submit2 buy -param2 item=SDCard -param2 type=32GB

Properties file

In place of a long command line with lots of options as described above, you can place these options into a properties file instead, and then use the -properties option to refer to this file. You can also specify other command line options to supplement or to override those in the properties file.

Here's an example properties file to help. Note that comments are prefixed with a #, each option must be on its own line, and you must add '=' between properties and their values. Blank lines are ignored.

To help you to create this file, whenever you use Total Validator Pro it automatically creates a file called commandline.props for you in the results folder. This contains all the command line equivalents of the Total Validator Pro settings you have just used.

Changes to User Agent identities or HTML5 Meta Names

Total Validator Pro may be used to change the default lists of User Agent identities and HTML5 Meta Names. If Total Validator Pro and Total Validator Embedded are on the same computer, and being run by the same user, these will be automatically picked up by Total Validator Embedded as they share the same <data> folder:

  • On Windows the <data> folder is <user_home>\AppData\Roaming\TotalValidatorTool
  • On Linux the <data> folder is ~/.totalvalidatortool
  • On macOS the <data> folder is <user_home>/Library/Application Support/TotalValidatorTool

However, if you have made changes to either of these lists and Total Validator Embedded is running on a different computer, or as a different user, you will need to copy the appropriate files from the <data> folder of Total Validator Pro to the equivalent <data> folder of Total Validator Embedded (you will need to manually create this folder for the Embedded version).

The User Agent identities are stored in a file called identities.props and the Meta Names stored in a file called metanames within the <data> folder.

Examples

The examples below show how to modify the batch/scripts provided to do different things. You must run these batch/script files from the folder where they reside so that Total Validator can find all the resource files needed, otherwise an error will occur.

The following command will test all the pages on a website for compliance against XHTML 1.1, with W3C WCAG21 AAA accessibility, spell checking, and broken link checking:

$tv -url http://www.your_web_site.com/index.html -pages 0 -dtd "XHTML 1.1" -accessibility AAA2 -spellcheck -brokenlinks

The following example prompts for a single local web page, then tests it for compliance against the latest HTML5, with Section 508 accessibility, and saves the results in a unique folder:

$tv -uniquereport -dtd HTML5 -accessibility 508

The next example tests a local web site for broken links, reports all redirects but suppresses the reporting of 302 and 303 warnings. It does not save the results, so the exit status will be used to see if it was successful or not:

$tv -suppressresults -extendedstatus -pages 0 -file c:\mysite\index.html -brokenlinks -reportredirects -ignoreissues W302,W303

To supply the command line options in a properties file, use:

$tv -properties myprops.props