home *** CD-ROM | disk | FTP | other *** search
/ Shareware Overload / ShartewareOverload.cdr / wp / bb725.zip / BBF.DOC < prev    next >
Text File  |  1987-03-10  |  12KB  |  348 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 FORMATTER
  28.  
  29.      version  remarks
  30.      ------------------------------------------------------------------
  31.      2.3      C compiler compatible version. 3-87
  32.  
  33.      2.2      Latest BB 6.45 distribution version.  2-9-87.
  34.           Multi-line footer commands
  35.  
  36.      2.1      Bold start & end sequences added.
  37.  
  38.      2.0      New C Compiler used. Output command added.
  39.  
  40.      1.7      Bold function to insert special bold sequences
  41.  
  42.      1.6      Require function added to allow merging of files.
  43.  
  44.      1.5      Title does not skip spaces when using multi-line titles.
  45.  
  46.      1.4      File terminated with FF CR LF
  47.  
  48.      1.3      Fixed bug that truncated first line to the length of the
  49.           title.
  50.  
  51.      1.2      Multi-line titles (upto 10)
  52.  
  53.      1.1      Added sections and table of contents feature and include
  54.           file.
  55.  
  56.      1.0      First release version of the formatter.
  57.  
  58.      INTRODUCTION
  59.  
  60.         Printing out documents is an essential associated task of a
  61.      text processing system. Blackbeard performs the editing tasks
  62.      very well. An available text formatter/printer was not
  63.      available. Programs like Microsoft Word (R) are so word
  64.      processing oriented that simplicity is often compromised. The
  65.      Blackbeard formatter is a simple to use, do what I tell you, text
  66.      processor.  It takes any text file and produce a cleaned up
  67.      printed output.  It is also a powerful formatter for producing
  68.      technical documents.  A design constraint was that the initial
  69.      version be compatible with DEC's DSR (R) as much as possible.
  70.  
  71.         This manual describes how to use the formatter.
  72.  
  73.      RUNNING BLACKBEARD FORMATTER
  74.  
  75.         To run Blackbeard formatter type:
  76.  
  77.            BBF
  78.  
  79.         or
  80.  
  81.            BBF {filename}
  82.  
  83.         BBF does not include a pop-up directory of files to format
  84.      yet (available real soon now). BBF will then format your
  85.      document and write it to the standard output device (the
  86.      screen). To send the output to the printer run Blackbeard with
  87.      the command:
  88.  
  89.            BBF {filename} >prn
  90.  
  91.         This redirects output to the printer. You could also
  92.      redirect the output to a filename if you want by substituting a
  93.      filename for prn.
  94.  
  95.      The default format is to print 2 blank lines at the top of the
  96.      page, the filename (used for the title), 2 more blank lines,
  97.      text lines as they appear in the file (no formatting is done,
  98.      except for tabs are converted to spaces, fonts are replaced if
  99.      enabled and spaces are insert if a left margin is used), 2 blank
  100.      lines, a page number, and a form feed.
  101.  
  102.      COMMANDS
  103.  
  104.         The nature of the format can be altered by embedding
  105.      formatter commands (often known as dot commands) in your text.
  106.      The general format is:
  107.  
  108.      .command parameter1 parameter2 text
  109.  
  110.      The following is a description of the available commands.
  111.  
  112.      .bold c string
  113.         Sets up a bold charater indicator.  When the bold
  114.         character is first encountered in the text, all subsequent
  115.         characters are duplicated and the string is inserted between
  116.         the duplicated characters until a terminating bold character
  117.         is encountered.  Example:
  118.  
  119.         .bold @ &a+
  120.         abc@def@ghi
  121.  
  122.         formats to:
  123.  
  124.         abcd&a+de&a+ef&a+fghi
  125.  
  126.      .bs c string
  127.      .be c string
  128.         Sets up a bold charater indicator.  When the bold character is
  129.         first encountered in the text, all subsequent characters are
  130.         duplicated and the string designated with .bs is inserted
  131.         between the duplicated characters and the string designated
  132.         with .be is inserted after the duplicated character until a
  133.         terminating bold character is encountered.  Example:
  134.  
  135.      .bs  &a-67H
  136.      .be  &a-5H
  137.  
  138.      is the sequence to perform bolding on the HP Laserjet+ with the
  139.      standard 10CPI font. For:
  140.  
  141.         XYZ
  142.  
  143.         the string:
  144.  
  145.         X&a-67HX&a-5HY&a-67HY&a-5HZ&a-67HZ&a-5H
  146.  
  147.         is produced.  The HP laserjet+ perform the following
  148.      operations when receiving this sequence.  An X is printed then
  149.      the jet is moved "horizontally backward" 67 decipoints (i.e.,
  150.      just less than the character width of 72 decipoints), the
  151.      character X is printed again, and the jet is moved "horizontally
  152.      backward" 5 decipoints, which is the compensation for not having
  153.      moved back 72 originally.  So the character appears bold having
  154.      been printed once and the offset printed again.
  155.         This formatting command can cause your document to become
  156.      uneditable since lines can get very long.  Essentially each
  157.      bolded charater becomes equivalent to 15 characters (in this
  158.      example).  So if you have a line of 20 bolded characters, that
  159.      line is now 300 characters long! The max line length the
  160.      Blackbeard formatter can currently accomodate is 4096
  161.      characters.  So for this example that is a line of 273
  162.      characters.
  163.  
  164.      .dump string
  165.         Dumps a string to the file designated by the file command.
  166.  
  167.      .enable c
  168.         Set the font character as the character c. For example:
  169.  
  170.         .enable 
  171.  
  172.      .file filename
  173.         This command causes the formatter to place all header numbers
  174.         and titles in the specified file.  This functions as a table
  175.         of contents.
  176.  
  177.      .fm before-title after-title before-footer after-footer
  178.         Specify the page layout:
  179.  
  180.        ┌─────────────────────────────────┐
  181.        │        before-title            │
  182.        │    Title line                   │
  183.        │       after-title              │
  184.        │    This is a sample text line.  │
  185.        │    This is a sample text line.  │
  186.        │<-> This is a sample text line.  │
  187.        │lm  This is a sample text line.  │
  188.        │    This is a sample text line.  │
  189.        │    This is a sample text line.  │
  190.        │    This is a sample text line.  │
  191.        │    This is a sample text line.  │
  192.        │    This is a sample text line.  │
  193.        │    This is a sample text line.  │
  194.        │    This is a sample text line.  │
  195.        │    This is a sample text line.  │
  196.        │       before-footer            │
  197.        │    Footer line                  │
  198.        │       after-footer             │
  199.        └─────────────────────────────────┘
  200.  
  201.        The number of blank spaces at the top and bottom of the text.
  202.      Default is 2 2 2 2.
  203.  
  204.      .fo [n] text
  205.         Running footer at the bottom of page.  A # in the footer text
  206.         represents the page number.  Multiple line footers can be
  207.         designated by preceding the footer with a number between 0 and
  208.         9.  For example to get a two line footer use the commands:
  209.  
  210.         .fo 0 First footer line
  211.         .fo 1 Second footer line
  212.  
  213.         To create a blank header line you must set "display tabs" on
  214.         in Blackbeard (using the options menu) and put a few spaces
  215.         after the .fo command. This tells BBF that you still want
  216.         the header but that it is clear. This anomoly will be
  217.         changed in version 2.3 when it becomes available.
  218.  
  219.      .hl n
  220.         This is the header level command. It allows you to create
  221.         relocatable sections and produce automatic numbering like
  222.         1.2.4.6.
  223.  
  224.         Example:
  225.  
  226.         .hl 1 Section 1
  227.         .hl 2 Section 1.1
  228.         .hl 3 Section 1.1.1
  229.         .hl 2 Section 1.2
  230.         .hl 1 Section 2
  231.  
  232.      .include filename
  233.         This will emplace a file -- as is -- in the file you are
  234.         currently formatting.  This command includes graphics as well
  235.         as ASCII files.
  236.  
  237.      .le
  238.         This is a list element. It allows you to create a numbered
  239.         list.
  240.  
  241.      .ls
  242.         List start. Starts (and ends) an itemized list.
  243.  
  244.      .lm n
  245.         Left margin. Default is 0.
  246.  
  247.      .nmlv header-level number
  248.         Reset header level numbering.
  249.  
  250.      .nmpg n
  251.         Reset page number.
  252.  
  253.      .output s
  254.         Outputs the string s without considering it as text. This can
  255.         be used to reset the printer, e.g., landscape to portrait
  256.         mode.
  257.      .pg
  258.         New page.
  259.  
  260.      .ps n
  261.         Page size with n in lines per page. Default is 66.
  262.  
  263.      .req filename
  264.         This will emplace a file and reformat as required in the file
  265.         you are currently formatting.  This command can be nested, but
  266.         only ten files can be required at any one time.
  267.  
  268.      .ti [n] text
  269.         Running title on top of page.  A # in the title text
  270.         represents the page number.  Multiple line titles can be
  271.         designated by preceding the title with a number between 0 and
  272.         9.  For example to get a two line title use the commands:
  273.  
  274.         .ti 0 First title line
  275.         .ti 1 Second title line
  276.  
  277.         To create a blank header line you must set "display tabs" on
  278.         in Blackbeard (using the options menu) and put a few spaces
  279.         after the .ti command. This tells BBF that you still want
  280.         the header but that it is clear. This anomoly will be
  281.         changed in version 2.3 when it becomes available.
  282.  
  283.  
  284.      FONTS
  285.  
  286.         The formatter can also perform font translation.  It does
  287.      this by recognizing font designators in your text file.  A
  288.      font designator begins with the ASCII font character such as
  289.       followed by another ASCII character for the font number
  290.      such as  for the first font.
  291.  
  292.         When fonts are enabled (see the .enable command) the font
  293.      designations are replaced by the escape sequenced required for
  294.      the printer defined in the Blackbeard font file. When the
  295.      formatter starts up it looks for a font file. Blackbeard looks
  296.      in the current subdirectory for a file named BB.FNT.  This file
  297.      defines the font to escape sequence relationship.  If there is
  298.      not a file named BB.CFG in the current subdirectory, Blackbeard
  299.      will look in the DOS environment for the symbol BBFNT, if it is
  300.      found it will use the filename supplied with the symbol.  This
  301.      will let you keep one font file and use Blackbeard from any disk
  302.      or directory.  To set BBFNT place this command or one similar in
  303.      your autoexec.bat file
  304.  
  305.           SET BBFNT=C:\BB.FNT
  306.  
  307.      The font file looks like the following:
  308.  
  309.      0  18             18       ( normal = 10 CPI)
  310.      1  27,45,1        27,45,0  ( underline)
  311.      2  27,69          27,70    ( bold )
  312.      3  27,69          27,70    ( italic)
  313.      4  27,69          27,70    ( subscript)
  314.      5  27,69          27,70    ( superscript)
  315.      6  15             18       ( compressed)
  316.      7  14             20       ( double)
  317.      8  27,58          27,58    ( 12 CPI)
  318.  
  319.      The first number is the font number. The second set of numbers
  320.      define the "ON" sequence for that font number. The third set of
  321.      numbers define the "OFF" sequence for that font number. The
  322.      rest of the line is ignored and can be used for comments.
  323.      A comma separates numbers of a set. Spaces separates sets from sets.
  324.  
  325.      To use a font enclose your text between font designators as
  326.      follows:
  327.  
  328.            "127""1"abcdef"127""1"
  329.  
  330.         "127" and "1" stand for the ASCII characters 127 and 01.
  331.      This can be done using the insert special character feature of
  332.      Blackbeard. When this file is formatted, these font designators
  333.      will be replaced so they will look like (using the sample font
  334.      file):
  335.  
  336.            "27""45""1"abcdef"27""45""0"
  337.  
  338.         There are several font files included on your Blackbeard
  339.      distribution diskette. The following is a descriptive list of
  340.      these files.
  341.  
  342.      Filename    Description
  343.      ----------  ----------------------------------------------------
  344.      TP351.FNT   Fonts for the TOSHIBA P351
  345.      BB.FNT      The Blackbeard standard font file (≈ TP351.FNT)
  346.      EMX80.FNT   Epson MX 80 font file
  347.  
  348.