HypTEXT - An Hypertext-System for the Atari-ST, V1.1
====================================================

Dear English speaking community,
I am sorry, but ...
        ... the documentation is German.
The german manual is the example hypertext document. A very
short description of HypTEXT can be found in this READ.ME file.

PUBLIC DOMAIN:
    HypTEXT is the implementation-part of a MA-Degree in
    Computer Science at the 'Technischen Universit�t M�nchen'.
    The Program Hyptext Version 1.1 and its related data files
    are free to copy and use.

FILES:
    hyptext.prg*            - This program
    hyptext.rsc             - needs a resource
    lies.das
    read.me
    hypdata\                - Dir for hypertext document
    hypdata\c_000.hyp       - Table
    hypdata\hyptext.inf     - HypTEXT-Desk-Info
    hypdata\hyptext.tbl     - Table
    hypdata\n_0001.hyp      - Node 1
        ...
    hypdata\n_0056.hyp      - Node 56

DETAILS:
    The hypertext document will be searched in dir .\HYPDATA, that
    is not created automatically! To get a blank hypertext document
    remove all files in .\HYPDATA. To maintain several hypertext
    documents, rename the directory that contains the actual document
    to HYPDATA (TOS1.4 or use a mvdir tool). The nodes of the
    hypertext document are stored in files in HYPDATA. The Resource
    File is searched in current dir. The program requires not much
    memory and runs on SM124 or SM194, maybe on color (never tested).
    
LIMITS of this Version:
    HISTORY_SIZE        99
    MAX_NODES       250+1
    MAX_LINKS       2500+1
    
SHORT DESCRIPTION:
    All messages and menu entries are English, the user interface is
    easy to handle. The following gives a sketch on the main
    functionality of HypTEXT, not all options and menu entries 
    with obvious functions are described.
    
0. Concepts
    The Hypertext is a graph of nodes and links. A Node contains
    text, keywords, a name. Links are a directed relation of
    Node x Node. A link has a name and a origin in the source node.
    There are operations to maintain the graph and its objects,
    Create/Destroy/Edit Nodes and Links.

1. The HypTEXT User Interface

    The user interface is GEM-based with the extension of Pop-Up
    menus. HypTEXT has an HypTEXT desktop that consists of
    - Icons, that represent the HypTEXT-Tools Node-Editor, Link-Lists,
      Tags, History, Index and Finder, that are described later,
    - Windows and Dialog-Boxes for in- and output,
    - DropDown- and PopUp-Menus to select options and operations.

    A PopUp-Menu PM pops up at mouse position when you single-press
    the left mouse button and is movable like a window (press left
    and move), it disappears if you leave it. Sometimes it is
    scrollable. The first entry is the default operation, if you
    double-click then no menu pops and the operation is selected
    immediately. The PM ist context sensitve depending on the
    object you are pointing to with your mouse.

    1.1 The Drop Down Menu offers the expected operations.
    One interesting operation is to import an ASCII-File into a
    new node.

2.  The Node Editor

    The node editor has three modes:
    
    2.1 The browse or read mode. This is the default mode to 
    read the hypertext document and to travell along the links
    from node to node. An actual node is displayed in the window,
    links are boldfaced and underlined. A double-click onto a link
    follows the link to its target node and the target node becomes
    the actual node and is displayed. This is the default operation
    of a PM that occurs by a single click onto a link.
    A double click onto the node text activates the history tool
    and steps back one node of the dynamic node-path.

    2.2 The edit text mode. The text editor allows entering and
    editing the text contents of a node. Control-I toggles insert
    mode.  The position of links is displayed by underlines and is
    not affected by editing commands, unless Control-L is pressed.
    This toggles the Link/Text-mode and the links become part of
    the text and keep their logical text positions. This is useful
    if the link is a keyword within the text, than the link is
    edited like text.

    To leave the text edit mode double click and a PM occurs.

    There is a block/mark mechanism. Hold right and press left, drag
    along the text. When you release the left button a PM
    occurs to copy or move the marked text into a buffer.
    To get the text out of the buffer hold down right and press
    left shortly.

    2.3 The edit link mode. This mode allows repositioning and
    editing links. Double click on a link to changes link-label.
    You can use '_' for linktext to get a transparent link.
    Single Click on a link pops a PM with some options.
    Press left and move the link.
    To start a new link select a position and click, a PM appears:
        - Start a link to an existing node, enter link-label, the
          link is now pending and has to be finished.
        - Start link to a new node.
    - Select other mode.

3.  In/Out-Link Lists

    The Icons In/Out-Link represent the lists of incomming and
    outgoing links. Click on this icons.

4.  Tags

    Tags are used to store entry nodes. The special start tag
    is the default node displayed by startup.

5.  History

    The path along the hypertext you are travelled is stored in
    a node-list. You can scroll the node list and jump back to a
    previously visited node. In browse mode the double click onto
    the node steps back to the last visited node. Back steps
    are not added to the history.
    
6.  Index

    The Index is a directory of nodes, select one node by double
    click.

7.  Finder

    Incremental search utility, searches keywords or node contents
    combines searches by logical operators.




Have Fun
    Thomas Weiske, Technical University Munich, (W.) Germany
    weiske@lan.informatik.tu-muenchen.dbp.de