home *** CD-ROM | disk | FTP | other *** search
/ Tools en Utilities / CDASS_5.ISO / shell / file / docmkr33.arj / DOCMAKER.DOC next >
Encoding:
Text File  |  1992-11-12  |  38.4 KB  |  796 lines

  1.  
  2.  
  3.              ---------------------------------------------------
  4.              --                                               --
  5.              --             DOCMAKER Version 3.0              --
  6.              --                                               --
  7.              --                 (C) 1991, 1992                --
  8.              --        Prometheus Systems Incorporated        --
  9.              --                                               --
  10.              --            DOCMAKER User's manual             --
  11.              --                                               --
  12.              ---------------------------------------------------
  13.  
  14.  
  15.  
  16.      For Starters.
  17.      -------------
  18.      First of all, I'd like to state that this text is written by the
  19.        author of the program, I'm Belgian and my English isn't perfect.
  20.        I did my best on this manual, don't blame me if you find any
  21.        grammatical/spelling errors.  I would appreciate it if you would
  22.        point out any.
  23.  
  24.  
  25.      Introduction.
  26.      -------------
  27.      The DOCMAKER is a program which provides you with an easy to use
  28.        system to show texts and pictures, in a nice user-friendly
  29.        interface.  All texts and pictures are incorporated in a single
  30.        file.
  31.  
  32.  
  33.      What's the purpose.
  34.      -------------------
  35.      Originally, the DOCMAKER & DOC-Interpreter were developed to fill
  36.        up a hole in the PC software market. The idea comes from the
  37.        Amiga, where a lot of (mostly underground) computer groups/clubs
  38.        bring out a so called DOC DISK, a disk with a lot of manuals,
  39.        solutions, hints and cheat/hack-tips about games and sometimes
  40.        even business software (there even was a DOC DISK with the entire
  41.        manual of Deluxe Paint IV, over 700 pages of text).
  42.      Although the DOCMAKER was intended to bring such DOC DISKs to the
  43.        PC, it's quite possible you have another use intended.  The most
  44.        likely use of the DOCMAKER is to release a magazine-on-a-disk.
  45.  
  46.  
  47.      DOCMAKER Vocabulary.
  48.      --------------------
  49.      Throughout the DOCMAKER document files, following words will be
  50.      used :
  51.  
  52.      Crunching            : A method of reducing the size of data
  53.                             without loss of data.  To use the data, it
  54.                             has to be decrunched first.
  55.      Decrunching          : The process of returning crunched data to
  56.                             its original format.
  57.      Encrypting           : Transforming into unreadable.
  58.      Decrypting           : Transforming back into it's original format.
  59.      DOC-Interpreter      : The program used to display/print the texts
  60.                             and/or pictures.  A DOC-Interpreter can not
  61.                             run stand-alone, it has to be incorporated
  62.                             in a DOCs file.
  63.      DOCMAKER             : The program used to create the DOCs
  64.      DOCs file            : The combination of the DOC-Interpreter and
  65.                             DOCs.  This is in fact an EXE (executable)
  66.                             DOS program file, all texts and/or pictures
  67.                             are incorporated within this EXE file.  You
  68.                             thus have a single program, which does not
  69.                             make use of any other files.
  70.      DOCs (data)          : The data part of a DOCs file.  It consists
  71.                             of a list of all menu entries and the
  72.                             entries themselves.  These entries can be
  73.                             either text, pictures (or both) or a
  74.                             program.  The texts/pictures are crunched
  75.                             and encrypted.
  76.      CRC                  : Cyclic Redundancy Check.
  77.                             This is a very simple but effective method
  78.                             to check if a block of bytes has got errors.
  79.                             It's a lot beter than parity checks or
  80.                             checksums.
  81.      Internal file format : The way the DOCMAKER stores its information.
  82.                             The internal file format can change from
  83.                             version to version, the external file format
  84.                             should never change.
  85.                             P.S. The one exception is version 3.0 of the
  86.                             DOCMAKER, the external file format of the
  87.                             text files has changed due to the new
  88.                             features in the DOCMAKER.  Version 3.0 text
  89.                             files are not compatible with previous
  90.                             versions. Future versions should be
  91.                             compatible with 3.0 though.
  92.      External file format : The way the DOCMAKER expects the files to
  93.                             be when they are to be added to the DOCs
  94.                             file.
  95.  
  96.  
  97.      Features.
  98.      ---------
  99.       DOCMAKER :
  100.        - Easy to use UI (User Interface).
  101.        - Support of standard ASCII files, or the more appropriate
  102.          Text files (see later).
  103.        - Support of graphics-files, available in two resolutions :
  104.                640*200 : CGA resolution
  105.                640*350 : EGA resolution
  106.            All pictures are 2 colors.
  107.          Or PCX Files.
  108.        - The possibility to have small pictures within text.
  109.        - Built-in crunching of all files (except programs) to be used
  110.          with the DOC interpreter.
  111.        - Built-in 32-Bit CRC checking.
  112.        - Up to 76 texts and/or pictures per DOCs file.
  113.        - Unlimited size of DOCs file (Whatever the size of the DOCs file,
  114.          the DOC-Interpreter only needs about 256 Kb of free memory to
  115.          run).
  116.        - Making DOCs from scriptfiles.  This allows you to test out
  117.          different versions without repeatedly typing the same things.
  118.        - Built In Virus Infection Checking (BIVIC (tm)) (for both
  119.          DOCMAKER and DOC-Interpreter.  You get following message
  120.          displayed on screen :
  121.                EXE file is corrupt.
  122.                Check for Virus Infection.
  123.  
  124.       DOC-Interpreter :
  125.        - Support for the major graphics boards (CGA, EGA, VGA, Hercules)
  126.        - Support for following printers :
  127.                 - Epson FX 80
  128.                 - Epson LQ 24
  129.                 - HP DeskJet
  130.                 - HP LaserJet
  131.                 - NEC Pinwriter 2200
  132.                 - IBM Graphics printer
  133.          Most printers support/emulate one or more of these printers.
  134.        - Supports LPT1 through LPT4.
  135.        - Easy to use (graphical) user interface
  136.        - Built in 32-Bit CRC checking.
  137.        - BIVIC (tm).
  138.        - Small (Only 21Kb in size, needs 256Kb when running, 40Kb resident
  139.          when running a program set up in the menu).
  140.  
  141.  
  142.      Why use the DOCMAKER.
  143.      ---------------------
  144.      You've got a small users group and want to release a club magazine
  145.        every month or so.  You could just distribute a set of textfiles
  146.        and/or picture files hooked together in a batchfile (or
  147.        something like that).  With the major problem being : One file
  148.        missing could screw up the entire setup.
  149.      Suppose you have a few text and/or graphics files you want to show
  150.        to other people (Let's say the solution to some very hard
  151.        adventure). Because you have spent several hours playing the
  152.        adventure and some more hours typing the text/drawing the
  153.        pictures, you want everybody to know you made the text/pictures,
  154.        so you write down your name in every one of those files. You copy
  155.        the files to a disk and give it to your friends or you make an
  156.        archive and upload it to a BBS.
  157.        Several weeks later 'X' (could be a computer group/club or an
  158.        individual) distributes the solution to the same adventure. Well
  159.        in fact he used your solution and changed your name into his.
  160.  
  161.      The solution is simple, the DOCMAKER.
  162.      Because all files stored in the DOC interpreter (Created by the
  163.        DOCMAKER) are encrypted AND crunched you have a first level of
  164.        security that your name won't be changed and that the end-user
  165.        has got *ALL* the files.  It also takes considerably less disk
  166.        space since all files are crunched and decrunched at run-time.
  167.      P.S.I. does NOT provide ANYBODY with the internal file formats or
  168.        methods of decrypting and crunching/decrunching.  Therefor,
  169.        nobody will be able to decrunch and decrypt the files to their
  170.        original format.  Of course it will still be possible for
  171.        everyone to retype your text or redraw your picture, but there's
  172.        no EASY/FAST way.
  173.  
  174.      There are other ways to show texts and pictures (GRASP for
  175.      instance), but the DOCMAKER & DOC Interpreter have a lot more to
  176.      offer for this particular kind of presentation.
  177.        - Small : The DOC Interpreter is only 22Kb in size.
  178.        - Fast : I've spent over 200 hours just on optimizing the code.
  179.                 (i.e. the graphics routines, crunching).
  180.        - Built-in crunching/decrunching.
  181.        - Built-in printer support for the most used printers.
  182.        - Built-in 32-Bit CRC checking.
  183.        - Point & shoot menu system (also in graphics mode).
  184.        - Automatically makes best use of the features of your screen.
  185.        - Up to 76 entries.
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.              ---------------------------------------------------
  193.              -                                                 -
  194.              -                  The DOCMAKER                   -
  195.              -                                                 -
  196.              ---------------------------------------------------
  197.  
  198.  
  199.      After typing DOCMAKER at the DOS prompt you are presented with the
  200.      main screen. The main screen is made up of four parts, the top part
  201.      contains the program name, version number and copyright notice.
  202.      The bottom part is currently empty and will be used to accept user
  203.      entry.  The middle left part is the menu.  The middle right part is
  204.      the info box and currently holds the P.S.I. logo.
  205.  
  206.  
  207.  
  208.      The DOCMAKER : MENU
  209.      -------------------
  210.      The menu is a point & shoot menu system, The active selection is
  211.      white on a blue background (reverse video for monochrome systems)
  212.  
  213.      The menu has following options :
  214.  
  215.         Create new DOCs file
  216.         Activate an existing DOCs file
  217.         Change Title
  218.         Add to a DOCs file
  219.         Create a DOCs file from script
  220.         Quit DOCMAKER
  221.  
  222.      ! Throughout the DOCMAKER program, pressing the Escape key will
  223.        either return you to the menu, or back up one step.  Whenever
  224.        you've made a mistake just press Escape.  There is no 'undo'
  225.        function however, and overwriting or adding to a file can not be
  226.        undone, in that case, you'll have to start over.
  227.      ! Whenever a question has to be answered with 'Yes' or 'No', the
  228.        docmaker will display a box displaying a question.  Just position
  229.        the highlighted bar over the correct answer and press Enter.
  230.        The question can not be stopped by pressing Escape.
  231.      ! Whenever a file has to be specified (other than a DOCS file) you
  232.        can either type the full name (and path), or just type a wildcard
  233.        (ex. *.PCX).  A file-pick list will be shown, just use the
  234.        cursor keys to select the correct file.
  235.      ! If the filename of a picture has 'PCX' as extension, it is
  236.        assumed to be a standard PCX picture (as defined by ZSoft), and
  237.        is processed as such.
  238.        Other extensions are assumed to be raw data files.
  239.  
  240.  
  241.      Create a new DOCs file.
  242.      -----------------------
  243.      Make a new (empty) DOCs file.  After you've created a DOCs file,
  244.      you will be able to add texts/pictures.
  245.  
  246.      You will need to provide following info :
  247.        1) The name of the DOCs file.  Do not provide a drive or path,
  248.           also do not add an extension (.EXE will be added
  249.           automatically).
  250.        2) The title of the DOCs file, this title will be displayed at
  251.           the top of the menu in the DOCs file.
  252.      The DOCMAKER will now create the DOCs file.  This will take a few
  253.      seconds.
  254.        3) The DOCMAKER now asks if you would like an intro page.  Just
  255.           choose 'Yes' or 'No'.  If you chose 'Yes' you will need to
  256.           provide the name of the intropage.
  257.           ! An intropage is a 200 lines picture (see later), it will be
  258.             displayed after you've selected the correct graphics and
  259.             printer in the DOCs file.  After pressing a key the menu is
  260.             displayed.
  261.           ! This intropage can not be printed.
  262.  
  263.  
  264.      Activate an existing DOCs file.
  265.      -------------------------------
  266.      If you have previously created a DOCs file, and want to add some
  267.        more entries, you can do so by first activating that file.  Just
  268.        type the name of the DOCs file to activate.
  269.        ! The active DOCs file is displayed on screen and all
  270.          transactions are done on that file.  You don't need to
  271.          reactivate the same DOCs file over and over to add more
  272.          entries.
  273.  
  274.  
  275.      Change title
  276.      ------------
  277.      If you made a mistake typing the title or want another title, just
  278.        type the new title.
  279.  
  280.  
  281.      Add to a DOCs file.
  282.      -------------------
  283.      Adding entries to a DOCs file.
  284.  
  285.      1) Choose the type of entry you want to add :
  286.         (ASCII, Text, Program, 200 lines picture, 350 lines picture).
  287.      2) Provide the name of the file to add.
  288.      3) Type the name for the DOCs file menu.
  289.      4) If the type of entry is a 200 lines picture or a 350 lines
  290.         picture, type the colour of pixels to print (see later)
  291.      5) When viewing ASCII or TEXT files, you can choose whether you
  292.         want the user of the DOCs file to be able to write the entry to
  293.         a file.  This can be a very nice feature if you are distributing
  294.         source codes or info forms the user needs to fill in.
  295.         !! When enabling this feature, you can not include pictures in the
  296.         text.
  297.      Wait while the DOCs file is updated.
  298.  
  299.  
  300.      Create a DOCs file from script.
  301.      -------------------------------
  302.      Creating and adding entries to a DOCs file in one go.  You will
  303.        need to create a script file first with an editor.
  304.  
  305.      Type the name of the script file to use.  Relax, have some coffee
  306.        (or whatever) and wait while the DOCMAKER is processing the
  307.        script file.
  308.  
  309.  
  310.      Quit DOCMAKER.
  311.      --------------
  312.      Guess what this one does !
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.              ---------------------------------------------------
  320.              -                                                 -
  321.              -               The DOC-Interpreter               -
  322.              -                                                 -
  323.              ---------------------------------------------------
  324.  
  325.  
  326.      The DOC-Interpreter really doesn't need much explaining.  The DOC
  327.      interpreter is a program which has some data (the DOCs file)
  328.      attached to it.  After you start the program (it works always, even
  329.      if the program isn't in the current directory), a small menu is
  330.      shown which requires you to select your machine equipment (Graphics
  331.      display type, Printer & Printer port and pagelength). Once you have
  332.      done that, just press <Enter> and the show begins.
  333.  
  334.       ! You may rename the program file at any time, this will not
  335.         effect the running of the DOC-Interpreter.
  336.  
  337.      If there's an intro page it will be displayed, now the DOC-
  338.      Interpreter waits until you press a key.  It may be a good idea to
  339.      put a short text somewhere in that picture telling the user to
  340.      press a key.
  341.  
  342.      The menu system is simple, just use the cursor keys to select the
  343.      correct entry then press enter, the DOCs file will be read and the
  344.      file decrunched.
  345.  
  346.       ! A note about pagelength.
  347.         Pagelength is a new feature of version 3.0.  In previous
  348.         versions, the creator of the DOCs file had to decide what
  349.         pagelength to use.  From V3.0 and on, the user can specify the
  350.         number of lines his printer can print on one page, or even
  351.         specify to print continuously on listing paper.
  352.  
  353.  
  354.  
  355.  
  356.  
  357.  
  358.              ---------------------------------------------------
  359.              -                                                 -
  360.              -                   File Formats                  -
  361.              -                                                 -
  362.              ---------------------------------------------------
  363.  
  364.  
  365.      ! A note on Paragraphs.
  366.        From version 3.0 on the DOCMAKER supports variable pagelength
  367.        (see above).  To make this possible, the creator of the DOCs file
  368.        has to specify where a pagebreak may occur.  This may seem
  369.        difficult, but it isn't, just keep reading.
  370.  
  371.  
  372.      ASCII files.
  373.      ------------
  374.      ASCII files will be treated as unformatted texts, a pagebreak can
  375.        occur in between any two subsequent lines. ASCII files are the
  376.        files you create with any editor, as long as the files abide by
  377.        some rules they can be used directly in the DOCMAKER.
  378.         1) Maximum length of a line = 80
  379.         2) The lines must be separated with a "Carriage return/Line
  380.            feed".  Most editors do this fine, there are some editors
  381.            though which work slightly different. There are some who use
  382.            a "Line feed/Carriage return" or even just a "Carriage
  383.            return" or a "Line feed". How to know ?  Try it out, if it
  384.            doesn't look right, your editor probably does it wrong.
  385.         3) No Control-characters (Characters below the space in the
  386.            ASCII chart).  Remember the 'TAB' character is a control
  387.            character, you will need to 'de-tab' your ASCII file, this is
  388.            a built in feature in most good editors.
  389.         4) Maximum size about 64Kb (depending on the contents of the
  390.            text larger texts are possible). If you have texts which are
  391.            longer, you'll have to split them and use two (or more) menu
  392.            entries.
  393.  
  394.  
  395.      Text files.
  396.      -----------
  397.      Text files are ASCII files with paragraph formatting. First of all
  398.        text files must obey the same rules of standard ASCII files.
  399.  
  400.      The creator of the file must specify where a pagebreak may occur.
  401.        This makes it possible to keep blocks of text together on the
  402.        same line, especially when it's a picture made up of the line
  403.        drawing ASCII codes this can be very usefull.
  404.  
  405.      You tell the DOCMAKER where a pagebreak may occur by inserting a
  406.        formatting character (default is '*') ON THE FIRST POSITION OF
  407.        THE LINE.  You *INSERT* a formatting character, not overwrite the
  408.        first character on the line.
  409.  
  410.      The largest possible paragraph is 20 lines.  So you have to add a
  411.      formatting character at least every 20 lines.  If a paragraph is
  412.      larger, the DOCMAKER will return an error when processing the text.
  413.  
  414.      Here's an example :  (The '|' signifies the left border of the
  415.      screen).
  416.         |  This is an important
  417.         |  piece of text, these
  418.         |  five lines must be
  419.         |  printed on the same
  420.         |  page.
  421.         |*
  422.         |*  !!!!!!!!!!!!!!!!!!!!!!!!!
  423.         |  !!  Beware of the dog  !!
  424.         |  !!!!!!!!!!!!!!!!!!!!!!!!!
  425.         |*
  426.         |*  This is the start of a new paragraph.
  427.  
  428.      Note that in the 'Beware of the dog' box, the first line is shifted
  429.        to the right by 1 position, just think of the formatting
  430.        character as a not printed character in the DOC Interpreter.
  431.  
  432.      Commands :
  433.        You can have several commands in your textfile.
  434.        A command starts with the '@' as *FIRST* character on a line.
  435.        The following commands are available :
  436.  
  437.        @!           : Remark.  The rest of the line is ignored.
  438.        @FormatChar= : Overrides the standard formatting character of
  439.                       '*'. You must place the formatting character
  440.                       immediately after the = sign, no space in
  441.                       between.
  442.        @Picture=    : Allows you to add a picture in the text.
  443.                       You specify the filename and which picture lines
  444.                       to include in the text.
  445.                       Example :
  446.                       @Picture= MAZE.PCX,0,100
  447.                          This will insert line 0 through line 100 in the
  448.                          text.  You will have 101 lines of the picture
  449.                          in your text.
  450.                       A maximum of 160 lines can be inserted at one
  451.                       time, altough you can have multiple pictures with
  452.                       a total of over 160 lines.
  453.                       When printing the pictures from the DOC
  454.                       Interpreter, the black pixels are printed.  The
  455.                       picture will look the same as on screen. The
  456.                       pictures are show on screen and printed as if they
  457.                       were 200-lines pictures.
  458.                       !! Do not include pictures if you want to have texts
  459.                          that can be writen to a file.
  460.  
  461.        !! There's one exception to the rule that the command must start
  462.           on the first position of a line.  That exception is a
  463.           formatting character. A formatting character may precede the
  464.           command on the same line.  The only real use for this is with
  465.           the picture command.  You can start a new paragraph with a
  466.           picture.  The command to do this is, is :
  467.           *@Picture=test.PCX,0,100
  468.           Replace the asterix with the chosen formating character.
  469.           You WILL need to do this to have a picture of over 152 lines
  470.           in size.  Altough the other commands may have a formatting
  471.           character, there's really no use to do so since a formatting
  472.           character is not needed.
  473.  
  474.  
  475.      Some tips for the text files, some of the rules also apply for
  476.        ASCII files :
  477.  
  478.       - Set your editor for a left and a right margin. The texts look a
  479.         lot better if they don't start at the leftmost edge of the paper.
  480.       - Do not set your editor to proportional (aligned right margins).
  481.         This is done by inserting spaces, it looks lousy, especially
  482.         when printing on the LaserJet wich a non-courier font selected.
  483.       - The best result for formatting is to put a formatting character
  484.         on each line in between paragraphs, and the first line of each
  485.         new paragraph.
  486.       - Insert a formatting character as often as possible.  This will
  487.         allow for better use of the screen and/or paper.
  488.       - Since the picture is displayed and printed at the same
  489.         resolution of the 200-lines pictures, the picture may seem to be
  490.         stretched some what if it was made at 350-lines resolution. To
  491.         avoid this problem, draw the pictures in 200-lines (CGA)
  492.         resolution.
  493.       - Pictures consume a lot of memory, every line of picture takes 80
  494.         bytes. Having many big pictures can easily fill the 64Kb you
  495.         have available for the text.
  496.       - Do not stack up the pictures.  The pictures are not meant to be
  497.         used as a very big picture.  If you have 2 or more pictures one
  498.         after the other, it's not assured they will be printed one after
  499.         the other, there may be a few lines in between. The pictures are
  500.         meant to be used to enlighten some of the text, or to avoid
  501.         using very rough pictures using the ASCII set.
  502.       - Do not make any assumptions on the horizontal dimensions of the
  503.         printed picture.  You could make a picture and then use text
  504.         arrows to point to a certain part of the picture.  Since the
  505.         picture is printed in somwhat different aspect ratios on
  506.         different pictures, this will not work correctly.
  507.       - Since the BLACK pixels are printed, the picture looks the same
  508.         on screen as on paper.  To avoid problems, draw you picture in
  509.         black pixels on a white background.
  510.       - The commands are as shown above, they are case insensitive
  511.         (@picture= is exactly the same as @PICTURE=), but do be
  512.         carefull with adding spaces. the command is @Picture=, not
  513.         @Picture =. You can insert spaces in between parameters on the
  514.         command lines though, exception is the @FormatChar= command,
  515.         the formatting character must immediately follow the equal sign.
  516.       - Do not add extra characters after the commands.  They may work
  517.         with the current version of the DOCMAKER, but they may not in
  518.         new releases.
  519.  
  520.  
  521.  
  522.      Pictures.
  523.      ---------
  524.      The DOCMAKER uses two kinds of pictures, 200-lines (CGA resolution)
  525.        and 350-lines (EGA resolution) pictures. Since both kinds of
  526.        picture fill the entire screen the pixels in 200-lines pictures
  527.        are somewhat taller. Both pictures have 640 pixels horizontally,
  528.        and 200 or 350 pixels vertically
  529.  
  530.      For those who know a little Pascal.  Here's the record definition of
  531.        both types of pictures.
  532.        TYPE Linedata   = ARRAY [0..79] OF BYTE;
  533.             Picture200 = ARRAY [0..199] OF Linedata;
  534.             Picture350 = ARRAY [0..349] OF Linedata;
  535.  
  536.      As of this writing the DOCMAKER accepts two types of files as
  537.      pictures. These are :
  538.        - Raw data files which are in fact pictures with the pixel data
  539.          for each line in sequence (as the record definition above
  540.          dictates). Raw data files are the ones created with the old
  541.          DOCMAKER utilities (after conversion). From DOCMAKER 3.0 and on
  542.          however, the screen capture utilities have all been replaced
  543.          with SAVEPCX, a screen capture utility which saves PCX files,
  544.          since most drawing programs allow loading PCX files, I have
  545.          decided to stop incorporating Raw datafiles.  You can load the
  546.          PCX files in your favourite drawing package and change the
  547.          pictures before adding them to the DOCs file.
  548.        - PCX Pictures.  These are pictures which conform to the PCX
  549.          picture file format as defined by ZSoft in their PC Paintbrush
  550.          program. If the file extension is PCX, the DOCMAKER will assume
  551.          it's a PCX picture and load the picture as such.
  552.          Only pictures with 1 bit per pixel are allowed. These include,
  553.          all monochrome (2 color) pictures and EGA/VGA 16 color
  554.          pictures. 4 color CGA pictures have 2 bits per pixel and 256
  555.          color MCGA/VGA pictures have 8 bits per pixel and can not be
  556.          used.
  557.          If you're using a color PCX picture, only the high order plane
  558.          is used (On 16 color pictures all pictures with the intensity
  559.          bit set (bright colors assuming standard palette) are converted
  560.          to white pixels, the rest are converted to black. If you don't
  561.          quite understand, try loading some pictures into the DOCMAKER.
  562.  
  563.      I'm working on some more types of pictures, I strongly suggest
  564.        using PCX pictures, they use less diskspace and are easier to
  565.        modify (most drawing programs allow loading PCX pictures).
  566.        If you have the older screen capture programs and convert program,
  567.        you can still use the Raw datafiles.
  568.  
  569.      Some tips for the picture files (some rules also apply for pictures
  570.        to be incorporated in texts) :
  571.        - When adding pictures, the DOCMAKER asks if it has to print the
  572.          Black or White pixels. When specifying black pixels, the
  573.          picture will be printed as it is shown on screen. If you
  574.          specify white pixels, the picture will be printed as a negative
  575.          of what's shown on screen. Because some pictures (especially
  576.          scanned ones) look very weird when inverted, I suggest always
  577.          drawing the picture in black on a white background (Standard in
  578.          DeluxePaint).
  579.        - Printer ribbon is expensive and wears out fast when printing
  580.          graphics. Don't use very large areas of black.  Don't use a
  581.          border around the picture. If you need black area's try using a
  582.          pattern (gray level).
  583.        - Since the pictures in the DOCMAKER will be Black/White, draw
  584.          the pictures in Black/White.
  585.        - If the picture is in color, try dithering (color to
  586.          black/white) the picture. A good program is Graphics Workshop
  587.          (It's ShareWare too, you can find it on BBS's under the name
  588.          GWSnnn.ZIP, nnn is the version number).  It does a great job at
  589.          converting pictures from one format to another too.
  590.        - Pictures can have a higher resolution than the size in the
  591.          DOCMAKER. A 800x600 PCX picture can be used as a 350-line (or
  592.          even a 200-line) picture. Keep in mind that only the top left
  593.          window with specified (640x350 or 640x200) width and height is
  594.          used, the rest is ignored.
  595.        - Pictures can't be smaller than the target size.  A picture with
  596.          320x200 resolution is not accepted. Keep in mind that the
  597.          Hercules has a 720x348 resolution, and can not be used as a 350
  598.          lines picture.
  599.        - The CGA-screen has only 200 lines, showing the 200-lines
  600.          pictures is no problem, the 350-lines pictures is a bit harder.
  601.          The DOC interpreter can show the 350-lines pictures on the CGA
  602.          but with a significant loss of detail.  3 out of 7 lines aren't
  603.          displayed.  The pictures are printed as 350-lines pictures
  604.          however and will come out fine.
  605.        - The Hercules screen has 348 lines, to show 350-lines pictures
  606.          the first and last lines aren't displayed.  Again, when
  607.          printing everything works fine.
  608.        - To show 200-lines pictures on the EGA and Hercules, 3 out of 4
  609.          lines are doubled, the picture comes out fine on screen.  This
  610.          method makes sure the entire screen is used and that screen
  611.          ratios aren't changed too much.
  612.  
  613.  
  614.  
  615.      Script Files.
  616.      -------------
  617.      The DOCMAKER Scriptfile is a standard ASCII file which has the
  618.      commands needed to create a DOCs file.
  619.  
  620.      Each line starting with a ';' is regarded as a remark and the rest
  621.      of the line is ignored.
  622.  
  623.      Valid commands are :
  624.  
  625.         CREATE        <filename> <title>
  626.         INTROPICTURE  <filename>
  627.         ASCII         <filename> <menutext>
  628.         ASCIISAVE     <filename> <menutext>
  629.         TEXT          <filename> <menutext>
  630.         TEXTSAVE      <filename> <menutext>
  631.         PROGRAM       <filename> <menutext>
  632.         PICTURE200    <filename> <B/W> <menutext>
  633.         PICTURE350    <filename> <B/W> <menutext>
  634.  
  635.      where <filename>  The name of the file to add, on the create line.
  636.                        Do not add a file extension nor a pathname.
  637.            <title>     The title of the DOCs file.
  638.            <menutext>  The text to place in the menu.
  639.            <B/W>       Either the letter 'B' or 'W' (print White or
  640.                        Black pixels).
  641.  
  642.      CREATE       : Create a new DOCSfile, this must be the first type
  643.                     of command in the Scriptfile. Remarks are allowed to
  644.                     prepend this command.
  645.      INTROPICTURE : A 200 lines picture, to be used as intro picture.
  646.                     This line must follow the CREATE command no other
  647.                     commands in between, remarks are allowed.
  648.      ASCII        : An unformatted ASCII file.
  649.      ASCIISAVE    : An unformatted ASCII file. Which can be written to a
  650.                     file by the user of the DOCs file.
  651.      TEXT         : A formatted text file (see above).
  652.      TEXTSAVE     : A formatted text file (see above).  Which can be
  653.                     written to a file by the user of the DOCs file.
  654.      PROGRAM      : the name of a program (if you supply a path it is
  655.                     stripped off so only the program name remains).
  656.      PICTURE200   : A 200 lines picture. (see above)
  657.      PICTURE350   : A 350 lines picture. (see above)
  658.  
  659.      !! DO NOT add a remark at the end of a command line, it will be
  660.         regarded as part of the menutext.
  661.      !! if the menutext is too long it will be clipped, there is no
  662.         warning that the DOCMAKER has clipped of the text, you have to
  663.         run the DOCs file to see if it has been clipped (the menutext
  664.         can be up to 36 characters long).
  665.  
  666.      Scriptfile example.
  667.  
  668.       ; *************************
  669.       ; ** DOCMAKER Scriptfile **
  670.       ; *************************
  671.  
  672.       CREATE       PSI-MAG         PSI Magazine 1  (C) 1992 by PSI
  673.       ; We have an intro picture.
  674.       INTROPICTURE PSIMAG.PCX
  675.  
  676.       TEXT         GRAPHICS.TXT    How to program the EGA/VGA Card
  677.       ; 350 lines (EGA resolution) picture with drawings of
  678.       ; Read & Write modes on the EGA/VGA
  679.       PICTURE350   RWMODES.PCX  B  Read and Write mode picture
  680.       PROGRAM      SCROLLS.EXE     EGA/VGA demo with 4 scrolls & Panning
  681.       TEXT         FREE-USR.TXT    Win A USR Dual Standard
  682.  
  683.  
  684.      Program incompatibilities.
  685.      ----------------------------
  686.      - Central Point Anti-Virus
  687.            Because of their built-in virus infection cheking (BIVIC) the
  688.            DOCMaker and DOC Interpreter have some conflicts with the
  689.            VSAFE program. If you remove the Program Protection flag
  690.            (Alt-V, 8), everything's OK. Also the CPAV program allows to
  691.            make any program self-checking.  Do NOT add this on the
  692.            DOCMAKER or the DOC Interpreter.
  693.      - Virus Scanners
  694.            Some scanners add extra bytes at the end of the programs that
  695.            have been scanned. Next time the scanning is performed, only
  696.            those bytes are checked resulting in faster execution of the
  697.            scanning. I did not have a chance to test all scanners, but
  698.            just in case, disable adding those bytes to both the DOCMAKER
  699.            and the DOC Interpreter (other programs have no built-in
  700.            virus checking).
  701.      - Multi-Taskers
  702.            Because of their nature of taking over a lot of system
  703.            resources, the DOCMAKER and DOC Interpreter will not work
  704.            under certain circumstances.  OS/2 2.0 however gave no problem
  705.            whatsoever.
  706.            The main problem is when printing under a multitasker.  Be
  707.            sure no printing jobs are active when selecting to print an
  708.            entry from the DOCs file.
  709.  
  710.  
  711.  
  712.  
  713.      Thank you.
  714.      ----------
  715.      I'd like to thank the following people who helped me making the
  716.      DOCMAKER & DOC interpreter.
  717.  
  718.      - Peter Cloet, Marc De Witte, Karim Djillali, Jimmy King, Randal
  719.        Neirynck : Thanks for Testing.
  720.      - Official Version for testing the DOCMAKER since version 1.0 and
  721.        helping to make the DOCMAKER popular, and for the many useful
  722.        idea's. Special thanks to Tasmaniac of Official Version for
  723.        giving some hints on making a beter product and designing some of
  724.        the code.
  725.      - Randal Neirynck : Thanks for lending your printer book (NEC
  726.                          P2200) and testing the NEC P2200 (Epson LQ24)
  727.                          driver.
  728.      - Jimmy King : Thanks for lending your printer book (HP Deskjet
  729.                     Plus) and testing the HP driver.
  730.      - Marc De Witte and
  731.        Karim Djillali : Thanks for testing and re-testing the Epson
  732.                         FX80 driver.
  733.      - Thanks to Borland for providing an outstanding Pascal Compiler
  734.        and blazing fast assembler.
  735.  
  736.  
  737.  
  738.      Trademarks
  739.      ----------
  740.      PSI, DOCMAKER, DOC Interpreter, DOCs file and BIVIC are trademarks
  741.        of Prometheus Systems Incorporated.
  742.      IBM, PC, XT, AT, Color Graphics Adapter, Enhanced Graphics Adapter,
  743.        Video Graphics Array & PC-DOS are registered trademarks of
  744.        International Business Machines.
  745.      Hercules Graphics Card is either a trademark or a registered
  746.        trademark of Hercules Inc.
  747.      AdLib & AdLib Visual Composer are trademarks of AdLib Inc.
  748.      SoundBlaster, SoundBlaster Pro are either trademarks or registered
  749.        trademarks of Creative Labs Incorporated.
  750.      MS-DOS and Microsoft are registered trademarks of Microsoft
  751.        Corporation.
  752.      Amiga is either a trademark or a registered trademark of Commodore
  753.        Business Machines.
  754.      Deluxe Paint is either trademark or a registered trademark of
  755.        Electronic Arts.
  756.      PC Paintbrush is a registered trademark of ZSoft Corporation.
  757.      Epson is either a trademark or a registered trademark of Seiko
  758.        Epson Corporation.
  759.      NEC & Pinwriter are either trademarks or registered trademarks of
  760.        Nippon Electronics Corporation.
  761.      Hewlett Packard, DeskJet & LaserJet are either trademarks or
  762.        registered trademarks of Hewlett Packard.
  763.      Turbo Pascal & Turbo Assembler are registered trademarks of Borland
  764.        International.
  765.      Leisure Suit Larry is a trademark of Sierra On-Line Inc.
  766.      Sierra is a registered trademark of Sierra On-Line Inc.
  767.  
  768.  
  769.      Disclaimer
  770.      ----------
  771.      The software, diskettes, and documentation are provided "AS IS".
  772.      There is no warranty of merchantability, no warranty of fitness for
  773.      a particular use, and no warranty of any kind, either expressed or
  774.      implied regarding the software, diskettes, or documentation.
  775.      Accordingly, the entire risk as to the use, results and performance
  776.      of the software and documentation is assumed by you.  In no event
  777.      will Prometheus Systems Incorporated be liable to you or any one
  778.      else for any consequential, special, or indirect damages resulting
  779.      from possession, use, or malfunction of this product, including
  780.      without limitation, damage to property and, to the extent permitted
  781.      by law, damage for personal injury, even if Prometheus Systems
  782.      Incorporated has been advised of such damages or loss. Some
  783.      Countries (states) do no allow limitations on the duration of
  784.      implied warranties and/or the exclusion or limitation of incidental
  785.      or consequential damages, and thus the preceding limitation and/or
  786.      exclusions and limitations may not apply to you.  This warranty
  787.      gives you specific legal rights, and you may have other rights
  788.      depending on the laws in your country (state).  You agree that the
  789.      liability of Prometheus Systems Incorporated arising out of any
  790.      kind of legal claim (whether in contract, tort, or otherwise) will
  791.      not exceed the amount you originally paid for the use of this
  792.      product.
  793.  
  794.  
  795.  
  796.