home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 December / simtel1292_SIMTEL_1292_Walnut_Creek.iso / msdos / editor / gal210a1.arc / MAKEHELP.HLP < prev    next >
Text File  |  1988-07-01  |  5KB  |  155 lines
  1. How To Write A File
  2. Setting Window Margins
  3. Format For Text
  4. Tips
  5. Example
  6.  
  7. :How To Write A File
  8.  
  9.      You may find it useful to write your own Reference Files
  10. for the User's Menu help windows.  These files are simple to
  11. make and extremely handy to have.
  12.  
  13.      Before you begin to write these files, you must first
  14. change the right hand margin of the editor.  The screen on
  15. the Gal2 editor is 80 characters long.  The windows in the
  16. help screens are only 62 characters long.  If the editor's
  17. margin is not changed to match the help screen's margin, the
  18. text from your file will not fit properly into the window.
  19. Changing this margin is simple.  Please refer to &d"Setting
  20. &dWindow &dMargins".
  21.  
  22.      There is also a special format you must follow when
  23. writing Reference Files.  This format is explained in
  24. &d"Format &dFor &dText".
  25.  
  26.      The most important points of writing a Reference File
  27. are highlighted in &d"Tips".  Please look at this file.
  28.  
  29.      Finally, there is an example to refer to if extra help
  30. is needed.  This example is under &d"Example".
  31. :
  32.  
  33. :Setting Window Margins
  34.  
  35.      The first thing you must do when writing Reference Files
  36. for User's Menu is set the margins for the windows.  Once you
  37. are in Gal2, follow these easy steps:
  38.  
  39.      1) Go to the Command mode. (CTRL C)
  40.  
  41.      2) Enter an O (for Options -- not a zero).  Press
  42.            RETURN.
  43.  
  44.      3) "Printer Left Margin Width[10]:" will appear in the
  45.            lower left hand cornor of the screen.  Press
  46.            RETURN.
  47.  
  48.      4) Now "Text Line Length[80]:" will appear.  Enter:
  49.            62       (RETURN)
  50.  
  51.      5) Press RETURN until you are back in the editing mode.
  52.  
  53.      6) You may use sF2 to format your help file as you
  54.            normally would.
  55. :
  56.  
  57. :Format For Text
  58.  
  59.      The format for writing Reference Files is simple.
  60.  There are only a few things to remember.
  61.  
  62.  
  63.      1) All Reference Files must have the extension
  64.            &d=.hlp.
  65.  
  66.      2) The windows are 62 characters wide and 13 lines long.
  67.            It is important to set the edetior's right-hand
  68.            margin to 62 so the text will fit properly into
  69.            the window.  Refer to &dSetting &dWindow
  70.            &dMargins.
  71.  
  72.      3) Make sure that your cursor is in the home position
  73.            (top left hand side of the screen) when you begin
  74.            to create your file.  If your text does not start
  75.            here, the window will be blank.
  76.  
  77.      4) Starting in this home position, make a dirictory for
  78.            the window. This is done by listing the titles of
  79.            the specific sections that will be in your file.
  80.            Each title will be a separate window.  There can
  81.            be only one title per line.  You may have any
  82.            number of titles.
  83.  
  84.      5) Skip a line.  Now you must type a colon (":").  It
  85.            &dmust be in the first column.  Next type the
  86.            first title EXACTLY as it appears at the top.
  87.  
  88.      6) Now you may write the text for that title.
  89.  
  90.      7) When you are through, type another colon  in the
  91.            first column and press RETURN.
  92.  
  93.      8) Repeat steps  3 - 6  for the rest of the titles.
  94.  
  95.      9) There may be spaces between your sections if you
  96.            wish.
  97.  
  98.     10) If you wish to have text printed in a new window
  99.            before the 13 lines in the previous window are
  100.            filled, type a double colon ("::").
  101.  
  102.     Please refer to &d"Example" to see an actual Reference
  103. File.
  104. :
  105.  
  106. :Tips
  107.      There are 5 helpful hints to remember when writing
  108. Reference Files.  Keep these in mind.
  109.  
  110.      1) Always use the extension =.hlp to label your files.
  111.            ex:  filename.hlp
  112.  
  113.      2) Make sure your cursor is in the home position when
  114.            you begin to list the titles of your files.
  115.  
  116.      3) Make sure when you write the actual text for the file
  117.            that you begin and end each file with a colon in
  118.            the first column.  If this colon is not in the
  119.            first column, it will appear in your text and the
  120.            sections of your text will not be separated
  121.            correctly.
  122.  
  123.      4) It also very important to type the title exactly as
  124.            it appears in the title list.
  125.  
  126.      5) If you wish to have text printed in a new window
  127.            before the previous window is filled, type a
  128.            double colon ("::").
  129. :
  130.  
  131. :Example
  132.  
  133.  Here is an example of a Reference File.
  134.  
  135.  misspelled
  136.  problems
  137.  
  138.  :misspelled
  139.  
  140.    Here are words I recently mispelled.
  141.       conceive, receive, misspell
  142.  :
  143.  
  144.  :problems
  145.  
  146.    Here are common problem words.
  147.       separate, occurred, accommodate, cemetery,
  148.       medieval, symmetry
  149.  ::
  150.  
  151.   Place Names
  152.       Poughkeepsie, Schenectady, Albuquerque
  153.  :
  154. :
  155.