home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 June / SIMTEL_0692.cdr / msdos / editor / blkbd746.arc / BBMAN.DOC < prev    next >
Text File  |  1988-01-20  |  3KB  |  101 lines
  1.                 ██████████
  2.               ██████████████
  3.              ███ · ████ · ███
  4.               ██████████████
  5.               ██████  ██████
  6.                ████████████
  7.                  ████████
  8.                 ██││││││██
  9.                  ████████
  10.              ██▄          ▄██
  11.               ▀██▄      ▄██▀
  12.                 ▀██▄  ▄██▀
  13.                   ▀████▀
  14.                   ▄████▄
  15.                 ▄██▀  ▀██▄
  16.               ▄██▀      ▀██▄
  17.              ██▀          ▀██
  18.  
  19.               ┌────────────┐
  20.               │ BLACKBEARD │
  21.               └────────────┘
  22.  
  23.               User Supported Software
  24.  
  25.  
  26.                VERSION LOG
  27.           BLACKBEARD DOCUMENT GENERATOR
  28.  
  29. version  remarks
  30. ----------------------------------------------------------------
  31. 1.2      Fixes bug so that BBMAN looks for the help file in
  32.      current directory, if BBDIR symbol is not defined.
  33.  
  34. 1.1      Version for BB 7.35. Pretty good initial version
  35.  
  36. 1.0      First version.
  37.  
  38.    The Blackbeard Document Generator (BBMAN) generates a
  39. context-sensitive Blackbeard manual. We created it to
  40. satisfy the original design goals of the Blackbeard product.
  41. These goals include:
  42.  
  43.    o  An excellent text editing system.
  44.    o  An easy to use, does what you expect paradigm.
  45.    o  No external documentation required.
  46.  
  47.    We created the bb.doc file after many requests for a
  48. Blackbeard user manual.  This meet some needs, but we still
  49. wanted to achieve our third design goal -- no documentation.
  50. With the Blackbeard Document Generator, we have done it.  This
  51. documentation method is superior to printed material because it
  52. is:
  53.  
  54.    o  always up to date;
  55.    o  distributed on the same medium as the program;
  56.    o  tailored to each user.
  57.  
  58.    The Blackbeard Document Generator generates the Blackbeard
  59. manual -- it contains all the information in the previous
  60. BB.DOC file -- from BB.HLP and your key bindings. This means
  61. that if you have redefined any keys to other functions, the
  62. manual will contain the proper reference to your key. This
  63. later feature is a first in the industry (as far as I know).
  64. Not only will your manual be up to date (straight from the help
  65. file), but it will be customized for your use of the product.
  66.  
  67. Running BBMAN
  68.  
  69. To run BBMAN, enter the following
  70.  
  71. BBMAN >filename
  72.  
  73. where filename is the name of the output document file (e.g.,
  74. BB.DOC).
  75.  
  76. BBMAN will prompt your for the manual skeleton file. We have
  77. included one to produce a close replica of the original BB.DOC
  78. file, called BB.MAN.
  79.  
  80. Skeleton File
  81.  
  82. When you look at BB.MAN you will see two types of lines.  The
  83. first type is a period (.) followed by some text.  BBMAN will
  84. copy this line not counting the first .  directly to the output.
  85. This type of line can be used to include any comments of
  86. formatting features you may desire.  The second type of line is a
  87. number.  This number represents a help number.  Each help message
  88. in Blackbeard has a number.  BBMAN looks up the help message
  89. corresponding to the number and writes it to the output.  The
  90. first 200 (0-199) help numbers are reserved for Blackbeard
  91. functions.  When the number is less than 200, the function is
  92. looked up to see which, if any, keys perform that function.  This
  93. information is written out to the output file.  Help messages 200
  94. to 249 are reserved for special Blackbeard messages.  Your own
  95. help messages can be placed in 250 or greater. The help
  96. facility and BBMAN are both new, so be patient with them.
  97. (For example, it can take quite a long time for the help
  98. facility to display a list of help topics, but we will be
  99. speeding it up.)
  100.  
  101.