home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 301.lha / hyperhelp / help / create < prev    next >
Encoding:
Text File  |  1980-12-03  |  1.8 KB  |  48 lines
  1. (@title Creating a HyperHelp Set@)When you invoke HyperHelp
  2. -- either by pressing the (@ref help:help/hotkeys@)Hot key(@unref@) or by
  3. running it from the Workbench -- the first text HyperHelp displays is the
  4. contents of the file (@bold@)Help:toplevel(@bold@).  The
  5. (@bold@)toplevel(@bold@)
  6. file is actually the only file you need to have in the Help: disk or
  7. directory.  You can have HyperHelp link (or (@bold@)refer(@bold@)) to files
  8. in any directory, as long as you specify the complete path name in the
  9. reference.  See (@ref help:help/commands@)Commands(@unref@) for more details.
  10.  
  11.  
  12.  
  13. Help files are standard ASCII text files, with special embedded codes
  14. for formatting text and setting up links to other files. The embedded codes
  15. are placed in between (@bold@)(@(@bold@) and (@bold@)@)(@bold@) marks.
  16. In order for this commands to be interpreted, the first two characters
  17. in a file must be (@bold@)(@(@bold@). If not, then HyperHelp will
  18. not recognise any other commands in the file. Usually the first command
  19. in a file would be to set the windows (@ref title, help:help/misc_cmds@)
  20. title(@unref@), so this is not a problem.
  21.  
  22.  
  23.  
  24. HyperHelp uses two consecutive linefeeds to determine the end of a
  25. paragraph.  HyperHelp replaces one linefeed character with a
  26. space. It formats paragraphs to fit within the current
  27. width of the window.  This lets you compose help files with
  28. simple text editors, or with complex word processors that can save
  29. in plain ASCII format. In order to put a blank line between two paragraphs,
  30. you would need to put 4 consecutive linefeeds in the file. In a normal
  31. text editor, this will look like 3 blank lines.
  32.  
  33.  
  34.  
  35. Click on any of the topics below for details on that topic.
  36.  
  37.  
  38.  
  39. (@ref help:help/commands@)Commands(@unref@)
  40.  
  41.  
  42.  
  43. (@ref help:help/environment@)Environment Variables(@unref@)
  44.  
  45.  
  46.  
  47. (@ref help:help/tips@)Style Considerations for On-Line Documentation(@unref@)
  48.