Category : Network Files
Archive   : LANWATCH.ZIP
Filename : README.DOC

tm
Hyper_Word Readme Documentation
Copyright 1990 by Ed Zaron
All Rights Reserved.







Introduction . . . . . . . . . . . . . . . 2

Command Line Parameters. . . . . . . . . . 4

Filename . . . . . . . . . . . . . . . 4
Video Mode . . . . . . . . . . . . . . 5
Window Color . . . . . . . . . . . . . 5
Scroll Enable. . . . . . . . . . . . . 5
Window Size. . . . . . . . . . . . . . 6

Default Command Line Parameters. . . . . . 6

Using a Batch file to Run Readme . . . . . 7

Mouse Support. . . . . . . . . . . . . . . 7

Keyword Files. . . . . . . . . . . . . . . 8

Printer Initialization File. . . . . . . . 8

Limitations. . . . . . . . . . . . . . . . 9

Disclaimer . . . . . . . . . . . . . . . . 9





















1





Introduction
--------------

The Hyper-Word Readme program is a read only, single window,
run time version of our Hyper-Word(tm) word processing
program.

You are free to copy and distribute Hyper-Word Readme (file
README.EXE) so long as you do not change any of Readme's
internal code or messages.



The Gray + and Gray - keys.
---------------------------

Within Readme files created with our Hyper-Word word
processor, the gray + and gray - keys serve a special
function.

Pressing the gray + key over a highlighted word will get
additional information.

Pressing the gray - key will backup to the the point where
the previous gray + was pressed.



Linking with the Gray + key.
----------------------------

In Hyper-Word, a highlighted string of text is called a
'link origin' or more simply a 'link'.

Pressing the gray + key while the cursor is at a link origin
will jump to the link destination that further defines or
explains the highlighted word.

Pressing the gray - key will backup to the prior link
origin.




















2





The Recent Reference list.
--------------------------

In addition to the gray + key for jumping, and the gray - key
for returning, there is one more key for navigating through
Hyper-Word documents.

Pressing the Alt = key (hold down Alt and press =) will
display a recent reference list.

Each line of the recent reference list displays the file name
and text of every location that you have recently viewed.

You can press the Enter key over a desired line to jump
directly to the named file and location.



Standard Ascii Text Readme Files.
---------------------------------

The Readme program may use standard ascii text files in
addition to files produced with our Hyper-Word word
processing program.

When used with standard text files the text window can be
scrolled with the cursor keys.

Scrolling in either direction is stopped at a Ctrl N
character in the readme file, indicating the end of the
page.

The ability to scroll the readme window can be enabled or
disabled by setting the '/S=' parameter in the Hyper-Word
Readme command line.


























3





Readme Command Line Parameters
------------------------------

The Hyper-Word Readme program uses parameters from the
command line to decide what file to load, the window size,
color and location, and other program variables.

When you ran Readme you probably typed the following line.

README

You could have added a parameter to the command line to
select a different file.

For example, entering;

README MYFILE

will load the file MYFILE.

Other parameters may follow the file name on the command
line.

For example,

README MYFILE/C=4

will load MYFILE and set the window color to 4 (blue).

Parameters following the file name start with a slash '/'
followed by a key letter and an equal sign '='.


Valid command line parameters
-----------------------------

/V= Video mode, Direct or Bios.

/C= Window color, 1=white/black, 2=black/white
3=green/black, 4=white/blue, 5=white/cyan

/S= Scroll enable, Yes or No.

/W= Window size; top,left,bottom,right.


Any or all of the command line parameters may be entered.
The command line should not contain any imbedded spaces.

Command line parameters that are not entered remain in their
default condition.

The following example sets the window size and window color
(3 = green letters on black).

README /W=1,40,20,80/C=3




4





Video Mode parameter /V=
------------------------

The video mode parameter controls the software method that
Readme uses to write to the screen.

The video mode may be set to /V=BIOS or /V=DIRECT.

The /V=DIRECT mode is slightly faster but may not be
compatible with some PC clones.

Set the video mode to /V=DIRECT unless you experience display
problems.

For example,

README MYFILE/V=DIRECT

will cause Readme to load 'MYFILE' and to use the direct
video mode.



Readme Window Color parameter /C=
---------------------------------

The /C= parameter selects the colors to be used when
displaying the Readme window.

/C=1 will display white characters on a black background.

/C=2 will display black characters on a white background.

/C=3 will display green characters on a black background.

/C=4 will display white characters on a blue background.

/C=5 will display white characters on a cyan background.



Scroll Enable parameter /S=
---------------------------

The /S= parameter controls whether or not the Readme window
can be scrolled.

If /S=YES then the Readme window can be scrolled.

If /S=NO then the Readme window cannot be scrolled but can
only be moved by pressing the gray + key over highlighted
text.

The window zoom key (Alt 0), the text find feature (F2), and
the file load (F7) only work when the scroll is enabled.





5





Readme Window Size parameter /W=
--------------------------------

The /W= parameter is used to set the Readme window size and
location.

The /W= should be followed by the window top, left, bottom
and right coordinates.

For example, to set the Readme window to full screen you
would enter the following command line.

README /W=1,1,25,80


If you want to eliminate the left and right side frames of
the readme window enter;

README /W=1,0,25,81

The top and bottom frames of the readme window cannot be
eliminated and will always be displayed.

Note that the bottom frame of the Readme window displays an
up arrow and a down arrow if window scrolling is enabled.


Default command line parameters
-------------------------------

Unless entered through the command line, the command
parameters will have the following default values.

Filename README.TXT
Video Mode /V=BIOS
Window Color /C=1 (white on black)
Scroll Enable /S=YES (scroll works)
Window Size /W=1,0,25,81






















6





Using a Batch file (.BAT) to run Readme
---------------------------------------

Rather than entering the command line parameters each time
you run Readme, you can enter them into a batch file and then
run the batch file which will run Readme.

For example, if you enter the following line into a batch
file named 'README.BAT' you can then type 'README' at the DOS
prompt to run the program with these preset parameters.

Contents of README.BAT file;

README %1/V=Direct/C=4

The '%1' above is a special DOS replacement parameter. The
%1 in the command line will be automatically replaced with
the first word (if any) that you enter after typing 'README'
at the DOS prompt.

If, after creating batch file README.BAT, you
enter 'README FILENAME' at the DOS prompt, the %1 symbol in
the batch file will be replaced by FILENAME before it is sent
to the command processor. The Readme program will then
automatically load and display the file named FILENAME.

The README.BAT file described above is included on the Readme
program disk but it is stored with the name 'RBLUE.BAT'. To
use this file simply copy it to a file named 'README.BAT'.


Mouse Support
-------------

While in the text window the mouse buttons function as
follows;

Left button - Same as gray + key (link jump)

Right button - Same as gray - key (link return)


While in a menu or list the mouse buttons function as
follows;

Left button - Same as Enter key (select)

Right button - Same as Esc key (exit)












7





Keyword Files
-------------

Readme has additional command line parameters for setting the
names of the optional keyword files as used in our Hyper-Word
word processor.


Keyword File Names /1..4=
-------------------------

The /1=, /2=, /3= and /4= parameters are used to set the
names of the keyword files that the Readme system will use.

Keyword files are used to allow 'many to one' link
connections in Hyper-Word Readme. Keyword files are standard
Hyper-Word files that contain link origins.

When doing a keyword search (F8) or when pressing gray + over
an unlinked word, Readme searches the keyword link files for
a link origin that matches the keyword for which you are
searching.

If a match is found, Readme jumps to the link destination
that is defined for the matching link origin.

For example,

README /1=KEYWORDS


Will set the name of keyword file 1 to KEYWORDS.

Refer to the documentation for our Hyper-Word word processing
program for more information about keyword files.



The Printer Initialization File
-------------------------------

There is one more file used by Readme.

The file PRT_INIT.TXT contains decimal control codes that
will be sent to your printer prior to printing.

If your printer needs any special codes for initialization,
enter them into the PRT_INIT.TXT file.













8





Limitations.
------------

Hyper-Word Readme accepts all of the dot commands and
functions of our Hyper-Word word processor except as noted
below.

Ctrl Z does not work as a repeat key.

None of the merge file dot commands operate.

Only one window opens. (window 1)

The linked find does not operate.

No document printing. Use F9 to print the contents of the
Readme window.

Readme files may not contain the Ctrl A or Ctrl B characters
except as defined in our Hyper-Word word processor.

Hyper-Word Readme is read only.

If you want Readme to use any keyboard macros that you have
created with our Hyper-Word word processing program, you must
copy them from directory \EZHWD\ to the directory that you
have loaded the Readme program on. Keyboard macros are the
files on directory \EZHWD\ that are named '_A.MAC' through
'_Z.MAC'.



DISCLAIMER OF ALL WARRANTIES AND LIABILITY
------------------------------------------

Zaron Software, Inc. makes no warranties, either express or
implied, with respect to this software, its quality,
performance, merchantability, or fitness for any particular
purpose.

Zaron Software, Inc. and program author shall have no
liability or responsibility to purchaser or to any other
person or entity with respect to any liability, loss or
damage caused or alleged to be caused by this software,
including but not limited to any interruption of service,
loss of business or anticipatory profits or consequential
damages resulting from the use or operation of this
software.












9