|
Tools for BaBar web authors
- Microsoft bookmarks<->favourites conversion tool on NT machines.
- Testhtml to correct html syntax.
- CheckLinks to check the links in BaBar web pages.
- WEBwrap to insert headers, make links relative and insert location information into html files.
 WEBmove to move files and directories and update a
locations database with the changes.- FixBookmarks converts bookmarks to new BaBar web.
- FixIMG inserts size information into html files for images.
- ChangeLinks to change the links in BaBar web pages for
viewing pages offline.
- CheckVolumes to check how full all the AFS volumes are in the BaBar web.
- Web Layout graphical program to design a BaBar web tree.
- Tree creates a directory tree of html files - another type of `sitemap'.
testhtml is a wrapper for Tidy - a program which analyses html for correct syntax. It can be used to produce a report or automatically correct the syntax of an html file. testhtml will insert body and /body tags if they don't exist, make sure tables are
defined correctly etc... It also has a host of other features.
Documentation can be found here.
Tidy is written in C and can be downloaded here.
Typical usage: testhtml -e Marsupials.html
The -e flag tells testhtml to report any html errors.
testhtml can also correct some errors (e.g. missing head tags etc...) when used with the -m (modify) flag.
It is important that your page contains no errors before attempting to wrap BaBar headers into your page
since testhtml is run with the -e flag within the wrapping tool and if errors are reported the wrapping tool
will not wrap the page.
Tidy is a binary and has been compiled for AIX, SunOS (Solaris), HP-UX, DEC Unix 4.x (OSF1) and Linux (Red Hat 5.1, egcs compiler).
Tidy has been tested on vesta, flora, morgan and percheron.
CheckLinks is a perl script used to check links in BaBar web pages. It looks in local file
directories using AFS for internal files but checks over the web for
external files using HTTP and a virtual web server. It can deal with web pages individually, in
lists, or starting from a directory ($RootDir) downwards.
Usage for checking links in files or a list of files:
CheckLinks [-help] <file.html>
-help Display help file
<file.html> The name of the html file you wish to wrap.
Usage for checking links in a directory and its subdirectories:
CheckLinks [-help] -d <$RootDir>
-help Display help file
-d Operate on all html files in <ROOTDIR> and below
<ROOTDIR> The name of the root directory containing files you wish to wrap.
WEBwrap adds(wraps)/removes standard BaBar navigation headers to your web page or to whole directories of web pages.
The Add Header option will only work if you have a header.inc
file in the same directory as the given filename. So
if you create a new directory somewhere under $BFROOT/www/ you will
have to copy a header file from the directory above.
Usage for wrapping files or a list of files:
WEBwrap [-ah] [-rh] [-help] <filename>
-ah Add Header (replace existing header)
-rh Remove Header
-help Display this help file
<filename> The name of the html file you wish to wrap.
Usage for wrapping all html files in a directory and all its subdirectories:
WEBwrap -d [-ah] [-rh] [-help] <ROOTDIR>
-d Operate on all html files from specified Directory <ROOTDIR> and below
-ah Add Header (replace existing header)
-rh Remove Header
-help Display this help file
<ROOTDIR> The name of the root directory containing files you wish to wrap.
WEBmove moves files and directories while updating a locations database.
(The format of the database lines is "old_location->new_location".)
If a file or directory has been moved once before then the appropriate
line in the database is updated keeping the original "old_location" but
changing the "new_location". Files are moved one at a time and new
directories are created where necessary while a new version of the
database is written out line by line. When whole directories are moved
all their files and subdirectories are moved one by one. On completion,
all the original directories are deleted in reverse order, beginning with
their deepest lying subdirectories.
Usage for move files directories or a list of files and directories :
WEBmove <files to be moved> <new location>
-- <files to be moved> can be the name of a single file, a list
of files (e.g. *.html), or a directory.
-- <new location< can be a file name or a directory name.
N.B. You will need to copy the script to your area and edit the line which
defines your locations database e.g. $DB="mydatabase.txt". When you have
finished, e-mail the WEBmaster your locations database and he will use this
file to update the links throughout the web.
A tool for converting bookmarks from the old web to the new web. The script can be run in two modes:
- query mode : You can type in an old location and it will search for a new location
usage: FixBookmarks -q
- update mode: This will update your bookmarks (making a backup first)
usage: FixBookmarks ./.netscape/bookmarks.html (remember to quit netscape before you do this!)
*** Please note: The databases for old symbolic links and the new WWW file locations have not yet been merged. Currently, FixBookmarks uses the new file locations database only, so you may have broken links even after updating your bookmarks file.
ChangeLinks ($BFROOT/www/Computing/WebTeamPages/tools/bin/ChangeLinks)
ChangeLinks is a perl script used to change links in BaBar web pages. It is useful
if you wish to make your own copy of a section of the BaBar web for viewing offline.
It changes all relative links to whatever path you specify. To use it:
- Copy a section of the BaBar web to wherever you want to view it from.
- Copy the script
to your bin directory and edit it to meet your specific needs by changing the
$RootDir variable to be the location of
the top directory of the copied BaBar section in your filespace, and changing the
$ReplaceText variable to be the path with which you wish to replace /BFROOT/ with.
- Make the edited script executable by typing "chmod +x ChangeLinks" (you may have
to type "rehash" too) and then run it by typing "ChangeLinks".
CheckVolumes ($BFROOT/www/Computing/WebTeamPages/tools/bin/CheckVolumes)
CheckVolumes which uses "fs lq" to check how full all the AFS volumes in the
BaBar web are.
Usage: $BFROOT/www/Computing/WebTeamPages/tools/bin/CheckVolumes
FixIMG examines HTML files and changes IMG tags to hold the WIDTH and HEIGHT sizes. Putting the size in IMG tags will speed up loading the page with Netscape. When HTML files are edited manually,
putting in the sizes is quite a hassle. Fiximg will try to locate each indicated image, and determine its size if it is a GIF or JPG or XBM image. If it changes a html file it produces a back-up copy of the original file.
Usage: fiximg [-h] [-l] [-v] <Directory> or <file name>
-h Displays manual page.
-l Treat symbolic links as well. The default is not to treat
symbolic links, because the original file should be treated
instead of the link to it.
-v Display the version of fiximg.pl
The "Web Layout" program was released to selected BaBar collaborators on the
2nd of September 1998. It was designed to record multiple visions of how the
new web should be
arranged; where the main sections should be located and how the various
sections connect to each other and to the main homepage. The idea for this
program was inspired by the
card sorting
method employed by SUN. The program itself was written by Paul Raines.
To run it, change directory to $BFROOT/www/Computing/WebTeamPages/tools/bin/,
type "weblayout.tk" and click on "help" for more info.
Tree
Creates a structured HTML list ('sitemap') of your HTML files.
It does not follow symbolic links. It has been adapted
so it can convert BaBar AFS directory names into URLs.
Usage: tree <htmldir> > <[output.html]>
[htmldir] The directory which will be top of the tree
[output.html] The output html file containing the tree sitemap.
|
