Hypertext View of a Development

The Hypertext Tool is invoked from the TopBar Browse menu and invokes the Hypertext Viewer set in the Editor/Viewer/Shell Options with a selection of currently-available hypertext constructs (which will change dynamically depending on the current state of the development).

Hypertext Versions of AMN Documents

Each is a hypertext version of the corresponding AMN file in the CFG and is automatically created (in the HTX directory) for each of the following:

analysis of a user-introduced machines, refinements or implementations
analysis of a base-generated machines or implementations
analysis of an interface-generated machines or implementations
introduction of an SLIB construct
enumeration

Hypertext Versions of Code Modules

Each is a hypertext version of the corresponding code file in the subdirectory of CDE, and is automatically created (in the HTX directory) for each of the following:

introduction of an SLIB construct having predefined code modules
enumeration
translation (of a user-introduced or generated construct)

Referencing constructs

In each referencing construct, a hypertext link is created to the relevant subsidiary construct for the appearance of each of the following:

a machine, refinement or implementation name
a set name
a constant name
a variable name
an operation name

Referenced constructs

Every construct construct_name.ext in the HTX directory has the filename construct_name.ext.html; destination hypertext links are constructed using the following convention:

for the construct itself:
- <A NAME="MACHINE">MACHINE</A>
- <A NAME="REFINEMENT">REFINEMENT</A>
- <A NAME="IMPLEMENTATION">IMPLEMENTATION</A>
for its sets:
- <A NAME="SETS">SETS</A>
for its constants:
- <A NAME="CONSTANTS">CONSTANTS</A>
for its properties:
- <A NAME="PROPERTIES">PROPERTIES</A>
for its variables:
- <A NAME="VARIABLES">VARIABLES</A>
for its definitions:
- <A NAME="DEFINITIONS">DEFINITIONS</A>
for its invariant:
- <A NAME="INVARIANT">INVARIANT</A>
for its assertions:
- <A NAME="ASSERTIONS">ASSERTIONS</A>
for its includes:
- <A NAME="INCLUDES">INCLUDES</A>
for its imports:
- <A NAME="IMPORTS">IMPORTS</A>
for its extends:
- <A NAME="EXTENDS">EXTENDS</A>
for its promoted operations:
- <A NAME="PROMOTES">PROMOTES</A>
for each of its own operations:
- <A NAME="OPNAME!op_name">op_name</A>

Thus it is possible to link other documents (for example informal requirements) to these HTX documents by reference to the above convention. For example the variable var1 of fifi.mch would be referenced:

     <A HREF="fifi.mch.html#VARIABLES">var1</A>

assuming that the referencing construct also resides in the HTX directory.

A full on-line help listing is available in the Contents Page Also available in the form of a complete Index. Blogo