Requirements and Implementation
|
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. Please note!! The location
of your Perl's executable code (i.e., "/usr/local/bin/perl") can be installed differently
than that which is indicated in the first line of the ".pl" source files of WebSAT.
-
reads the input files generated by the shareware, LinkLint, when performing
an analysis of a whole site. Therefore, a copy of its executable should be
stored in the "bin" directory discussed below.
-
makes use of the default web browser for interacting with the user.
-
makes use of the installed web server software.
|
Download
|
WebSAT's source files and its associated directory files are stored in a "tar
file" named WebSAT.tar. To begin downloading, visit our
NIST Web Metrics download page.
|
Administrative Requirements
|
In "root privileges mode", perform the following steps:
-
cd WebTools/WebSAT,
chmod -R a+rw page_results results results_ieee
-
Edit your httpd configuration file so that the server can find
the files and CGI programs it will need for WebSAT.
e.g., for apache server we added the following to the srm.config
file in this order:
- ScriptAlias /WebTools/WebSAT/bin/ /<directory you selected>/WebTools/WebSAT/bin/
- Alias /WebTools/ /<directory you selected>/WebTools/
-
restart httpd
-
In order to invoke WebSAT from your server, start your web browser and
go to:
http://<hostname>/<alias path>/
where: "hostname" is your server
where: "alias path" is WebTools/WebSAT/overview.html
|
Directory Structure
|
WebSAT's directory tree contains all the application-specific code
(except that for LinkLint);
its subdirectory structure is:
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.
- 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.
- websat.pl
- performs an analysis (using WebSAT rules) of a single web page.
- 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.
- websat_whole_site.pl
- initiates the analysis of a whole site using WebSAT rules.
|