home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Monster Media 1994 #1
/
monster.zip
/
monster
/
WP
/
ARES1A.ZIP
/
QCARD.FRM
< prev
next >
Wrap
Text File
|
1994-01-01
|
4KB
|
114 lines
ARES QUICK REFERENCE
====================
Overview
--------
Ares is a hypertext authoring system, distributed by UserWare.
Authoring an Ares hypertext is a two-step process:
(1) Create a hypertext script using any text editor. The script must
be in Borland's HelpFile format.
(2) Compile your script with the Help Compiler (UWHC).
You can then launch Ares and view your hypertext by entering
ARES myfile
from any DOS command prompt (C>).
HelpFile Format
---------------
Each topic is given a name (i.e HelpFile). The text following the
topic name is put into the help file. Since some of the lines may
contain cross-references, the script will need to be wrapped to fit
nicely in the text window. If a line of text is flush left with no
preceding white space, the line will be wrapped. All adjacent
wrappable lines are wrapped as a paragraph. If a line begins with a
space it will not be wrapped.
The syntax for a ".TOPIC" line is:
.TOPIC name[, name][..]
Cross-references can be placed within the text so that the reader can
quickly flip to related topics. There are two ways of formatting a
cross-reference:
{HelpFile}
If the cross-reference is the same as the topic's name, or
{help script:Helpfile}
if you want to display something other than the topic's name.
If you need to use braces in your text, you can insert a pair of
opening braces, like this: {{put this text in braces}. This is how we
were able to display these instructions without making the examples
cross references.
If you would like to insert comment lines in your script, simply begin
each line with a semi-colon (;).
Files needed for distribution
-----------------------------
When distributing your text with Ares, it is necessary to include only
the Ares.EXE and Ares.RCS files. If you are packaging your text for
mass distribution, you might also want to include a FILE_ID.DIZ,
GO.BAT, PACKING.LST, and REGISTER.FRM file with your text. These are
"convenience" files, though, and not required by the Ares system.
FILE_ID.DIZ
-----------
This is a specially formatted text file that can be used by many
bulletin board systems to provide a description of your text. It can
be up to ten lines longs, with up to 45 characters on each line. It
should simply be a short, catalog-type description of your hypertext.
REGISTER.FRM
------------
If your text is shareware, you will of course want to include a
registration form. Feel free to crib our "mailer" format, if you like.
GO.BAT
------
Generally, it's a good idea to include a "MYTEXT.BAT" or "GO.BAT" file
with your text, which would load the Ares program together with your
text. Or, if your readers will be using DOS 3.0 or better, you can
rename Ares.EXE and Ares.RCS to MyText.EXE and MyText.RCS. This will
cause Ares to automatically load MyText.HLP when launched. Of course,
you can use any name you want in place of "MyText".
PACKING.LST
-----------
It is also a good idea to provide a directory of the files that are
supposed to be on your distribution disk. An easy way to do this is to
"pipe" the DOS DIR list to a file, and then edit the output with a
text editor:
DIR *.*>PACKING.LST
Note the use of the (>) character, which tells DOS to send the output
of the DIR command to a disk file.
USERWARE
========
For more information, contact UserWare via any of these methods:
Service Address
----------- -----------------------------------------
CompuServe 71540,3660
Facsimile 716 262-5185
Genie T.HUSTED
Internet 71540.3660@cis.com
Telephone 716 425-3463
Mail 4 FALCON LN E, FAIRPORT NY 14450-3312 USA