PAL CARD CATALOG ENTRY

SHORT DESCRIPTION

Online documentation system


MOVEMENT WITHIN THE PAL CARD CATALOG
Move to top-level taxonomy
Move to keyword list

ASSET PROFILE

UNIT NAME
HELP System
VERSION
1.3
REVIEW CODE
AR; C1 1.0 A
INET ADDRESS
RCONN at SIMTEL20
AUTHOR
Richard Conn
Echelon, Inc
RIGHTS
PUBLIC DOMAIN
COPYRIGHT
Not documented in PAL database
DATE CREATED
1 Dec 85
DATE RELEASED
2 Mar 86
DATE LAST UPDATED
2 Mar 86
LOCATION
C2MUG
PC-BLUE
ASR
PAL
AdaNET
ENVIRONMENT
VAX 11/785 (VMS 4.2), DEC Ada
LIMITATIONS
Not documented in PAL database
CERTIFICATION
Ada System Certifier_1 1.0
Date/Time of Processing: Thursday  26 May       1994 01:45:03Pm
Overall Assessment of System: OK
Classification of System: A
Basis of Classification --
Syntax Errors                               PASS
Completeness                                PASS
Independence from External Libraries        PASS
Independence from a Specific Ada Compiler   PASS

Number of ...
Files               4
Library Units       5
Lines            1352
Statements        553
Comments          425

FILE LISTING

Directory Display


languages/ada/asr/online/help:
  File Name                 Size
  ---------                 ----
  help.zip                79,086


Totals
  ==============  ==============
    1 Files               79,086

ABSTRACT

        The HELP System is a collection of programs which  provide  an
interactive  online  documentation facility.  Data for the facility is
prepared as a conventional text file which is formatted in an  outline
form, as follows:

	0 Topic-Name
		
	1 1st-Level-Subtopic
		
	...
	9 9th-Level-Subtopic
		
	1 2nd-1st-Level-Subtopic
		
	...
	1 3rd-1st-Level-Subtopic
	...
	0 Next-Topic
	...

        The level numbers do not have to be consecutive, and the lower
the  level  number  is,  the higher its entry appears in the hierarchy
(level 4 elements appear before level 6).  There may be as many topics
at each level as desired.  A line containing only a dot (.)  character
causes a break between screens when the help file is displayed to  the
user:

	this line appears on one screen
	.
	this line appears on the next screen (at the top)

        The HELP System consists of three programs:  HELP, HELP_BUILD,
and HELP_ANALYZE.

        The HELP program is used to display information contained in a
help  file.   This  information is in the form of a direct-access file
created by the HELP_BUILD program.  Briefly:

		text of help file 
			V
		    HELP_BUILD
			V
		direct-access help file
			V
		HELP displays info to user

        The HELP_ANALYZE program displays the structure hierarchy of a
direct access file which is created by HELP_BUILD.


REVISION HISTORY

DATE         VERSION	AUTHOR                  HISTORY
31 Dec 85	1.2	Richard Conn		Production Release
 2 Mar 86    1.3     Richard Conn            Minor Revisions


RELEASE NOTICE

This prologue must be included in all copies of this software.

This software is released to the Ada community.
This software is released to the Public Domain (note:
  software released to the Public Domain is not subject
  to copyright protection).
Restrictions on use or distribution:  NONE


DISCLAIMER

	This software and its documentation are provided "AS IS" and
without any expressed or implied warranties whatsoever.  No warranties
as to performance, merchantability, or fitness for a particular
purpose exist.
	The user is advised to test the software thoroughly before
relying on it.  The user must assume the entire risk and liability of
using this software.  In no event shall any person or organization of
people be held responsible for any direct, indirect, consequential or
inconsequential damages or lost profits.