home *** CD-ROM | disk | FTP | other *** search
/ ARM Club 3 / TheARMClub_PDCD3.iso / programs / comms_networking / irclient / !IRClient / Scripts / Docs / Prog / Help < prev    next >
Encoding:
Text File  |  1996-08-13  |  1.2 KB  |  31 lines
  1. Help file structure
  2. ===================
  3. Help files are quite simple to put together, but need quite a bit of work
  4. doing to the current interface - suggestions please...
  5.  
  6. Basically you should include a header line like :
  7.   <subject>
  8.   =========
  9.  
  10. at the top of all index files, and :
  11.   Syntax: <generic syntax>
  12.  
  13. at the top of all the specific files. If you could settype the specific files
  14. as Text and index and support files as Data it will make life easier (though
  15. it won't affect the program).
  16.  
  17. The files themselves should be formatted to 68 characters wide (off the
  18. Edit.Word Wrap option in Zap) so that they don't wrap strangely, and should
  19. NOT begin with a colon (:). Colons at the start of a line introduce an
  20. embedded command to the displayer. The character following the colon is the
  21. command type.
  22.  
  23. Currently only one command type is supported - the > link command. This is in
  24. the form :
  25.   :>text to show>linkfile
  26. And consecutive lines of lines will be joined together in a form of table -
  27. this looks nasty sometimes, but I may fix it soon.
  28.  
  29. Other than that, the only read thing you need to know is that the command
  30. line :END is reserved for the last line of the file and MUST be followed by a
  31. return.