home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 5 Edit / 05-Edit.zip / BB2-120.ZIP / SGMAN.DOC < prev   
Text File  |  1989-02-24  |  2KB  |  64 lines
  1.                VERSION LOG
  2.           SPYGLASS DOCUMENT GENERATOR
  3.  
  4. version  remarks
  5. ----------------------------------------------------------------
  6. 1.1      Bug fix to recognize key files.
  7.  
  8. 1.0      First version.
  9.  
  10. To generate Captain Blackbeard output use the command:
  11.  
  12. SGMAN CB.MAN >CB.DOC
  13.  
  14.    The Spyglass Document Generator (SGMAN) generates a
  15. context-sensitive manual.  We created it to satisfy the original
  16. design goals of the Blackbeard product.  These goals include:
  17.  
  18.    o  An excellent text editing system.
  19.    o  An easy to use, does what you expect paradigm.
  20.    o  No external documentation required.
  21.  
  22.    We created the bb.doc file after many requests for a
  23. Blackbeard user manual.  This met some needs, but we still
  24. wanted to achieve our third design goal -- no documentation.
  25. With the Spyglass Document Generator, we have done it.  This
  26. documentation method is superior to printed material because it
  27. is:
  28.  
  29.    o  always up to date;
  30.    o  distributed on the same medium as the program;
  31.    o  tailored to each user.
  32.  
  33.    The Spyglass Document Generator generates the Captain Blackbeard
  34. manual.  This means that if you have redefined any keys to other
  35. functions, the manual will contain the proper reference to your
  36. key.  This later feature is a first in the industry (as far as I
  37. know).  Not only will your manual be up to date (straight from
  38. the help file), but it will be customized for your use of the
  39. product.
  40.  
  41. Running SGMAN
  42.  
  43. To run SGMAN, enter the following
  44.  
  45. SGMAN textFile >filename
  46.  
  47. where textFile is the name of a document directive filename, and
  48. filename is the name of the output document file (e.g., CB.DOC).
  49.  
  50. Document Directive File
  51.  
  52. CB.MAN is distributed as a good start for a document directive
  53. file for Captain Blackbeard.  When you look at CB.MAN you will
  54. see two types of lines.  The first type is a period (.) followed
  55. by some text.  SGMAN will copy this line not counting the
  56. first .  directly to the output.  This type of line can be used
  57. to include any comments of formatting features you may desire.
  58. The second type of line is a number, or string.  This number
  59. represents a help number.  The text represents a help message
  60. title.  Each help message in Blackbeard has a number and title.
  61. SGMAN looks up the help message corresponding to the number or
  62. title and writes it to the output.
  63.  
  64.