HyperTxt

HyperTxt is a package that allows you to display large amounts of text. This is especially useful when you wish to allow the user to access a user's manual online. Any document can be put online using the HyperTxt package. The code required to perform this is very simple; the processing needed to allow HyperTxt to work on your document is somewhat complex. There are four WordPerfect macros included on the installation diskettes that will assist you in this process.

Find all table of contents marks in the document. Put a ^B at the beginning and a ^b at the end of each heading. FINDMARK is the WordPerfect macro that performs this task.

Build the rest of the structure that HyperTxt needs. The ^B and ^b can be used as reference points. The result should be the following:

      INPUT LINE:  ^BThis is a Sample Title^b
      OUTPUT LINES: @This_is_a_Sample Title[This is a Sample Title]
      |This_is_a_Sample Title
      ^BThis is a Sample Title^b

These three lines should be grouped one after the other at the location of the heading. The text in each of the four copies of the heading should match exactly, including spaces. HYPER is the WordPerfect macro that performs this task.

Move headings to the top of the document. Using the example above, the following line would be moved:

      @This_is_a_Sample Title[This is a Sample Title]

MOVETEXT is the WordPerfect macro that performs this task.

Remove any extraneous codes including bold, underline, center, large, very large, text box options, and page numbers. Set the following parameters as indicated:

      Left margin    -   .1
      Right margin    -  2.1
      Top margin    -  zero
      Bottom margin   -  zero
      Justification    -  Left only

Text box options should be set as follows:

        Borders   - none
        Outside border space - zero
        Inside border space - zero

CLEANUP is the WordPerfect macro that performs this task.

Write the document out to an ASCII file.

Using an editor - load the file from step 5.

a. Remove all form feeds " " (Alt 12).

b. Replace all "|" with " ".

c. Do any other editing necessary to match the Multi-Edit hypertext format. You will probably want to remove the title page, table of contents, and preface-type text. Additionally, you must add a line at the very top of the file that looks like this:

        * ^BTITLE OF THE DOCUMENT^b

The ^B's are optional, but they improve the appearance of the title.

d. Save this file in ASCII format. The final file should look something like this:

        * ^BTITLE OF THE DOCUMENT^b
        @This_is_a_Sample Title[This is a Sample Title]
        @Also_a_Sample[Also a Sample]
        @Another_Sample[Another Sample]
        @The_last_Sample[The last Sample]
        This_is_a_Sample Title
        ^BThis is a Sample Title^b
        This is the text that follows the Sample section. The text can be up
        to 1000 lines long. You can scroll or "hot key" to locate specific text
        within the body of the documentation. "Hot key" also works when
        in the table of contents.
        Also_a_Sample
        ^BAlso a Sample^b
        etc.

Test the file from 6 using Multi Edit Help or a program with the HyperTxt procedures from Sage-ST ^TM .

Go Back To Sage-ST TABLE OF CONTENTS