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