Requirements and Implementation
|
WebSAT is designed to work on any 32-bit MS Windows platform, and has been
tested on Windows 95, 98, NT 4, and 2000. WebSAT requires certain supporting
software when performing an analysis of a whole site. WebSAT -
-
is written in PERL. Thus, you will need to be able to run Perl on your system. We used ActivePerl
5.6 (Note: Please see release notes) and found it contain all the modules needed by WebSAT; however, you might just
verify that your Perl installation contains the LWP and SendMail modules. Use Perl's ppm facility to install
the LWP or SendMail modules if they are not available.
Note!! The location
of your Perl's executable code (i.e., "/usr/local/bin/perl") might be installed differently
than that which is indicated in the first line of the ".pl" source files of WebSAT. Also, if your Perl installation did not add ".pl" to the Registy Editor so that Perl programs are recognized as executalbe CGI scripts, you will
need to perform the following steps to make changes to the Registry Editor:
- On the Start menu, click Run.
- In the Open box, type Regedit and click OK.
- Open the following registry key: HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W3SVC\Parameters\ScriptMap
- On the Edit menu, point to New, and click String Value.
- Name the value .pl and press ENTER.
- Select .pl, and click Modify on the Edit menu.
- In the Value Data box, type <the full path to perl.exe>\perl.exe %s %s -- NOTE: The "%s %s" is case sensitive (for example, "%S %S" will not work).
- Close the Registry Editor, and restart your computer.
-
reads the input files generated by the shareware, LinkLint, when performing
an analysis of a whole site.
-
makes use of the default web browser for interacting with the user.
-
makes use of the Windows' web server software. NOTE: We successfully
installed WebSAT using Microsoft's Personal Web Server in the Windows NT 4, and 2000 environments; however, we were not successful in getting WebSAT to
evaluate whole sites using Microsoft's Personal Web Server for Windows 95,
and 98. We were successful, however, in getting WebSAT to evaluate whole sites
in the Windows 95 and 98 environments using the
Apache web server software.
|
Download
|
The Windows implementation of WebSAT is distributed as a self
installing executable file created with Inno Setup.
This executable file can be downloaded from our
NIST Web Metrics download page.
It is suggested that the file be downloaded to
an arbitrary location on your Windows computer, for example, C:\temp.
Execute the downloaded file to install WebSAT. It will allow you to
use the default location C:\WebTools or specify another
location to install the WebSAT files. It also installs in the start menu
an option to uninstall WebSAT.
|
Administrative Requirements
|
Create virtual directories so that your web server interprets the following:
- http://xxx.xxx.xx.xx/WebTools as the location where WebSAT was installed.
- http://xxx.xxx.xx.xx/WebTools/WebSAT
- http://xxx.xxx.xx.xx/WebTools/WebSAT/bin is "Executable"
- http://xxx.xxx.xx.xx/WebTools/WebSAT/bin/data is "readable"
- http://xxx.xxx.xx.xx/WebTools/WebSAT/bin/data/llresults is "readable and writeable"
- http://xxx.xxx.xx.xx/WebTools/WebSAT/bin/data/llresults_ieee is "readable and writeable"
- http://xxx.xxx.xx.xx/WebTools/WebSAT/bin/ll is "readable"
- http://xxx.xxx.xx.xx/WebTools/WebSAT/bin/ll/tmp-results is "readable and writeable"
- http://xxx.xxx.xx.xx/WebTools/WebSAT/bin/ll/tmp-results_ieee is "readable and writeable"
- http://xxx.xxx.xx.xx/WebTools/WebSAT/gls is "readable"
- http://xxx.xxx.xx.xx/WebTools/WebSAT/page_results is "readable and writeable"
- http://xxx.xxx.xx.xx/WebTools/WebSAT/results is "readable and writeable"
- http://xxx.xxx.xx.xx/WebTools/WebSAT/results_ieee is "readable and writeable"
|
Directory Structure and Files
|
The executable setup file installs itself, by default, in C:\WebTools.
Upon completion, the following file structure is generated:
WebTools : parent directory for WebSAT
WebSAT : main WebSAT directory
bin : directory of executable source files and data
subdirectories
ll : holds files related to linklint
tmp-results : holds immediate output of linklint analysis
per user
tmp-results_ieee : holds immediate output of linklint analysis
per user
data : parent directory for data sets
llresults : holds user data sets from tmp-results
llresults_ieee : holds user data sets from tmp-results_ieee
gls : holds WebSAT's documentation of analysis rules
ieee : holds documentation specific to IEEE Std
2001-1999 guidelines
page_results : holds line numbered copies of analyzed pages
for single page analyses
results : holds the user analysis files for whole site
analyses
results_ieee : holds the user analysis files for whole site
analyses
images : directory of graphical images
|
WebSAT Files
|
The following explains the purpose of the various files in the
WebSAT directory. These files can be used as is within the directory
structure described above.
- WebSAT subdirectory
-
contains the main HTML files needed for interacting with WebSAT
- README.txt
- Detailed installation instructions.
- access.sites.html
- Contains references to other guidelines on accessibility
- accessibility.html
- Contains a detailed discussion of the rules used by WebSAT to test
for accessibilty.
- form_rule.html
- Contains references to other guidelines on using forms.
- form_use.html
- Contains a detailed discussion of the rules used by WebSAT to test
form use.
- ieee.html
- This is the user interface page for performing single page analyses
using IEEE Std 2001-1999 guidelines.
- ieee_bodyinfo.html
- Contains a detailed discussion of the IEEE Std 2001-1999 guidelines
used by WebSAT to test for the required BODY information in web page
design.
- ieee_headinfo.html
- Contains a detailed discussion of the IEEE Std 2001-1999 guidelines
used by WebSAT to test for the required HEAD information in web page
design.
- ieee_wsite.html
- This is the user interface page for performing whole site analyses
using IEEE Std 2001-1999 guidelines.
- installation.html
- This web page interfaces the reader to the different distributions
of WebSAT.
- maintain_rule.html
- Contains references to other guidelines on maintainability.
- maintenance.html
- Contains a detailed discussion of the rules used by WebSAT to test
for maintainabilty.
- navigation.html
- Contains a detailed discussion of the rules used by WebSAT to test
for navigation.
- navigation_rule.html
- Contains references to other guidelines on navigation.
- operation.html
- This web page interfaces the user to the different execution modes
of WebSAT.
- overview.html
- This web page discusses the purpose and functional features
of WebSAT.
- perform_rule.html
- Contains references to other guidelines on performance.
- performance.html
- Contains a detailed discussion of the rules used by WebSAT to test
for performance.
- readability.html
- Contains a detailed discussion of the rules used by WebSAT to test
for readability.
- readability_rule.html
- Contains references to other guidelines on readability.
- results.html
- This web page discusses in general terms what happens when executing
one of the operative modes of WebSAT.
- unix.html
- This is a copy of this web page.
- websat-run.html
- This is the user interface page for performing single page analyses
using the WebSAT rules.
- windows.html
- This web page discusses the installation procedures for installing WebSAT
in the Windows environment.
- wsite.html
- This is the user interface page for performing whole site analyses
using the WebSAT rules.
- bin subdirectory
-
contains the executable PERL scripts that are necessary for running WebSAT.
**Note**: It is in this subdirectory that the LinkLint source code
should be stored. Also, the first line in each file (which identifies the
location of the Perl compiler for an installation) might need to be changed
to reflect the location for your installed Perl compiler.
- analfiles.pl
- generates an index page for whole site analyses.
- cgi-lib.pl
- contains PERL routines needed to manipulate CGI input. This source is
freeware developed by Steven E. Brenner in 1996.
- convert-ll.pl
- parses the file, "fileF.txt", which contains the topography of a web
site and is generated by LinkLint.
- htmlanal.pl
- performs an analysis (using WebSAT rules) of the web pages identified
in the topography of a whole site. Modify file: 1) You will need to search for the
character string, "yyy.yyy.yyyyy", and change it to the proper IP address
of your SMTP mail server. 2) Additionally,
you will need to search for the
character string, "xxx.xxx.xxxxx", and change it to the proper IP address
of your web server as it pertains to the installed location for WebSAT.
- htmlanal_ieee.pl
- performs an analysis (using the IEEE Std 2001-1999 guidelines) of the
web pages identified in the topography of a whole site. Modify file:
1) You will need to search for the
character string, "yyy.yyy.yyyyy", and change it to the proper IP address
of your SMTP mail server. 2) Additionally,
you will need to search for the
character string, "xxx.xxx.xxxxx", and change it to the proper IP address
of your web server as it pertains to the installed location for WebSAT.
- websat.pl
- performs an analysis (using WebSAT rules) of a single web page.
Edit notice: In Windows 2000 and NT 4 environments, you might
want to uncomment the four lines containing the "flock" command for the
purpose of handling accesses by multiple users.
- websat_p2001_single.pl
- performs an analysis (using the IEEE Std 2001-1999 guidelines) of a
single web page.
- websat_p2001_whole.pl
- initiates the analysis of a whole site using the IEEE Std 2001-1999
guidelines. Edit notice: In Windows 2000 and NT 4 environments, you might
want to uncomment the four lines containing the "flock" command for the
purpose of handling accesses by multiple users.
- websat_whole_site.pl
- initiates the analysis of a whole site using WebSAT rules.
Edit notice: In Windows 2000 and NT 4 environments, you might
want to uncomment the four lines containing the "flock" command for the
purpose of handling accesses by multiple users.
|