home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
The Datafile PD-CD 5
/
DATAFILE_PDCD5.iso
/
utilities
/
s
/
strongtest
/
ReadMe
next >
Wrap
Text File
|
1996-01-14
|
7KB
|
146 lines
ReadMe file for StrongTest 1.00 (13-Jan-1996)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
What is StrongTest?
~~~~~~~~~~~~~~~~~~~
Well, put simply, StrongTest is a simple utility that
attempts to test whether a stronghelp manual is internally
'consistent'. By 'consistent' I mean that all the links to pages
can actually get to the pages they're supposed to, and that there
are no pages that can't be reached.
The StrongTest distribution consists of the following
files/applications:
StrongTest the executable
c.strongtest the ANSI C source code
!strongtst a DDE frontend for the executable
I (Musus Umbra) retain copyright in the program at all
times. Permission is granted for unrestricted use. Permission is
granted for distribution provided that no profit is made and that
the distribution is supplied whole and unaltered.
But what if I patch a bug?
~~~~~~~~~~~~~~~~~~~~~~~~~~
Then send me a bug report (with your patch if possible) and
I'll fix the master version & re-release it.
How does it work?
~~~~~~~~~~~~~~~~~
Basically, it scans a stronghelp manual and records the full
filename and pagename of each page the manual contains. The code
then runs through all the pages, scanning each for links. When a
link is found, the list of pages is consulted to see if the page
the link refers to actually exists. If the page doesn't exist, an
error is reported. If the page does exist, then it is marked as
'reachable'.
When all the pages have been scanned, each page's
'reachable' status is examined, and any that are unreachable are
reported.
How do I use it?
~~~~~~~~~~~~~~~~
Either with the DDE front end supplied, or from the command line
or in a taskwindow, or whatever.
The syntax is:
*strongtest [-t] [-v] <manual>
The -t flag enables throwback (you'll need the DDEutils module & a
text editor that supports throwback, DDEUtils is supplied with both
DDE & Beebug's Easy C (& C++); any decent editor supports throwback).
The -v flag enables 'verbose' operation. Normally, very little output
is genrated, just the diagnostic messages. With the -v option, all
errors are detailed and warnings displayed.
There is also a -d option that enables debugging mode. In debugging mode,
lots (and I mean *lots*) of output is generated. Some of it may be useful
if you're trying to modify my code :-)
Oh, the options are all independent. If you use -t, you'll get all the
warnings & errors thrownback, even if you don't use -v.
What *can't* it do?
~~~~~~~~~~~~~~~~~~~
At the moment, there are a number of restrictions (some more
serious than others). For my purposes none of these restrictions
matter, but if you want me to update the code, let me know and
I'll see what I can do.
Currently StrongTest can't cope with:
Subpages sub pages are ignored. This is quite
easy to implement, but I don't think
anyone uses subpages, so there :-)
Links to other manuals Links to other manuals (eg.
<OS_File=>SWI:OS_File> will always fail.
Again, this is probably quite easy to
implement, but lies outside my current
requirements. Currently external links
are raised as warnings.
Simple Links the #prefix & #postfix directives are
ignored. This is a little harder to
implement, but, guess what, I don't need
it so I haven't provided it.
Directory_ eg. in the SWI manual. This is badly handled
at the moment. Links of the form <a=>a_b> where
b is a page in a subdirectory a_ will be tested
properly, but the full subdirectory facilities
aren't tested (eg. <a=>Wimp_Poll8a> where the page
is Wimp_.Poll.8a).
probably all sorts of other stuff. Let me know...
So, why did you write it?
~~~~~~~~~~~~~~~~~~~~~~~~~
Well, 'Two Witches & A Moogle' are working on a manual on
aromatherapy, and the 'Moogle' thought that he'd knock up a
little proggy to make sure that we don't leave any links
'dangling' in our manual. So, I knocked up some beautiful C one
night (resisting the urge to hack it together in ½hour in BASIC)
and tried it. Didn't work - stronghelp's image filing system
doesn't support OS_GBPB 9. I deleted evrything in a fit of pique.
Then, to my utter embarassment, I found out that it does support
OS_GBPB 10, so I had to re-write the whole **&%*#&$(* thing. From
scratch. Bastard.
However, re-write it I did, and the result is that which is
sat before thee. The reason that the features above are missing
is that I simply don't need them, and for a simple manual they're
certainly extraneous.
So why did you release it?
~~~~~~~~~~~~~~~~~~~~~~~~~~
Just in case anyone might find it useful. Hey, for all it's
limited, it is still quite good at what it does. And anyway, it's
free - what have you lost? And if it's that bad, let me know, or
better yet, patch it and let me know :-)
About the author
~~~~~~~~~~~~~~~~
StrongTest was written by The Musus Umbra, known in slightly
more real life as Andy. e-mail to A.J.Holdsworth@ncl.ac.uk, or
snail mail c/o 23 Baronsway, Whitkirk, Leeds, LS15 7AW, ENGLAND.
Although this is 'freeware', don't be put off if you want to
send me a donation!
Disclaimer & Licence
~~~~~~~~~~~~~~~~~~~~
Use of this software is completely at your own risk. The author can accept no
responsibility for any damage/loss arising from the use, or inability to use
this software. No warranty, express or implied, applies to this software.
This is not PD: the Copyright in this software belongs at all times to the
author. However, permission is granted for unrestricted distribution
prodividing that *no* charge is made for the distribution [a charge may be made
for handling/media] and that the whole of the software is supplied intact and
unaltered. Permission is also granted for unrestricted use and alteration of
the software [but if you fix a bug / add anything nice, let me know so I can
patch the 'master' version].
Bug reports / comments / etc to:
Musus Umbra c/o 23 Baronsway, Whitkirk, Leeds, LS15 7AW, England.
(until Sept-ish '96: A.J.Holdsworth@ncl.ac.uk)