home *** CD-ROM | disk | FTP | other *** search
/ Monster Media 1994 #1 / monster.zip / monster / WP / ARES1A.ZIP / QCARD.FRM < prev    next >
Text File  |  1994-01-01  |  4KB  |  114 lines
  1.  
  2.  
  3.  
  4.  
  5.      ARES QUICK REFERENCE
  6.      ====================
  7.  
  8.      Overview
  9.      --------
  10.      Ares is a hypertext authoring system, distributed by UserWare.
  11.      Authoring an Ares hypertext is a two-step process:
  12.  
  13.      (1) Create a hypertext script using any text editor. The script must
  14.      be in Borland's HelpFile format.
  15.  
  16.      (2) Compile your script with the Help Compiler (UWHC).
  17.  
  18.      You can then launch Ares and view your hypertext by entering
  19.  
  20.       ARES myfile
  21.  
  22.      from any DOS command prompt (C>).
  23.  
  24.      HelpFile Format
  25.      ---------------
  26.      Each topic is given a name (i.e HelpFile). The text following the
  27.      topic name is put into the help file. Since some of the lines may
  28.      contain cross-references, the script will need to be wrapped to fit
  29.      nicely in the text window. If a line of text is flush left with no
  30.      preceding white space, the line will be wrapped. All adjacent
  31.      wrappable lines are wrapped as a paragraph. If a line begins with a
  32.      space it will not be wrapped.
  33.  
  34.      The syntax for a ".TOPIC" line is:
  35.  
  36.       .TOPIC name[, name][..]
  37.  
  38.      Cross-references can be placed within the text so that the reader can
  39.      quickly flip to related topics. There are two ways of formatting a
  40.      cross-reference:
  41.  
  42.       {HelpFile}
  43.  
  44.      If the cross-reference is the same as the topic's name, or
  45.  
  46.       {help script:Helpfile}
  47.  
  48.      if you want to display something other than the topic's name.
  49.  
  50.      If you need to use braces in your text, you can insert a pair of
  51.      opening braces, like this: {{put this text in braces}. This is how we
  52.      were able to display these instructions without making the examples
  53.      cross references.
  54.  
  55.      If you would like to insert comment lines in your script, simply begin
  56.      each line with a semi-colon (;).
  57.  
  58.  
  59.  
  60.      Files needed for distribution
  61.      -----------------------------
  62.      When distributing your text with Ares, it is necessary to include only
  63.      the Ares.EXE and Ares.RCS files. If you are packaging your text for
  64.      mass distribution, you might also want to include a FILE_ID.DIZ,
  65.      GO.BAT, PACKING.LST, and REGISTER.FRM file with your text. These are
  66.      "convenience" files, though, and not required by the Ares system.
  67.  
  68.      FILE_ID.DIZ
  69.      -----------
  70.      This is a specially formatted text file that can be used by many
  71.      bulletin board systems to provide a description of your text. It can
  72.      be up to ten lines longs, with up to 45 characters on each line. It
  73.      should simply be a short, catalog-type description of your hypertext.
  74.  
  75.      REGISTER.FRM
  76.      ------------
  77.      If your text is shareware, you will of course want to include a
  78.      registration form. Feel free to crib our "mailer" format, if you like.
  79.  
  80.      GO.BAT
  81.      ------
  82.      Generally, it's a good idea to include a "MYTEXT.BAT" or "GO.BAT" file
  83.      with your text, which would load the Ares program together with your
  84.      text. Or, if your readers will be using DOS 3.0 or better, you can
  85.      rename Ares.EXE and Ares.RCS to MyText.EXE and MyText.RCS. This will
  86.      cause Ares to automatically load MyText.HLP when launched. Of course,
  87.      you can use any name you want in place of "MyText".
  88.  
  89.      PACKING.LST
  90.      -----------
  91.      It is also a good idea to provide a directory of the files that are
  92.      supposed to be on your distribution disk. An easy way to do this is to
  93.      "pipe" the DOS DIR list to a file, and then edit the output with a
  94.      text editor:
  95.  
  96.       DIR *.*>PACKING.LST
  97.  
  98.      Note the use of the (>) character, which tells DOS to send the output
  99.      of the DIR command to a disk file.
  100.  
  101.  
  102.      USERWARE
  103.      ========
  104.      For more information, contact UserWare via any of these methods:
  105.  
  106.      Service     Address
  107.      ----------- -----------------------------------------
  108.      CompuServe  71540,3660
  109.      Facsimile   716 262-5185
  110.      Genie       T.HUSTED
  111.      Internet    71540.3660@cis.com
  112.      Telephone   716 425-3463
  113.      Mail        4 FALCON LN E, FAIRPORT NY 14450-3312 USA 
  114.