home *** CD-ROM | disk | FTP | other *** search
/ CD Actual 15 / CDACTUAL15.iso / cdactual / program / basic / QBPRT.ZIP / QBPRT.DOC next >
Encoding:
Text File  |  1989-05-06  |  5.6 KB  |  186 lines
  1.  
  2.                                   QbPrt   V 1.0
  3.  
  4.       Copyright 1989 (C)    L.Weinman 121 Valdivia Cir. San Ramon, CA USA
  5.       ____________________________________________________________________
  6.  
  7.       Legal stuff:
  8.  
  9.       This copyrighted program is licensed for non-commercial use without
  10.       cost . No charge may be made by anyone other than the copyright
  11.       holder for this program, except for a nominal fee for copying and
  12.       distribution. It may not be included, or bundled, with any materials
  13.       for which a charge is made. Commercial distribution, or use, may only
  14.       be made with the agreement of the copyright holder.
  15.  
  16.       In other words, give it to others for free and don't use it for work,
  17.       or profit, without obtaining a commercial license. (cheap)
  18.  
  19.       Any distribution of the program QbPrt must include this document.
  20.       ____________________________________________________________________
  21.  
  22.  
  23.  
  24.       This program is intended to make QuickBasic (C) source code more
  25.       readable by indenting the logical structures to make them more
  26.       obvious. It will also produce an output suitable for printing.
  27.  
  28.       I wrote it because I was not satisfied with the programs that I had
  29.       seen. If you are not satisfied with it, please let me know, and I
  30.       will examine your complaints, and suggestions, and perhaps
  31.       incorporate them in future editions. I won't know if you are unhappy
  32.       if you don't tell me.
  33.  
  34.  
  35.       If you are a non-commercial user, and like the program, then small
  36.       gifts are always welcome.
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.  
  50.  
  51.  
  52.  
  53.  
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.                                                                 Pg. 1
  61.  
  62.  
  63.  
  64.  
  65.  
  66.       I have tried to make the program self-explanatory.
  67.  
  68.       After starting the program, select either
  69.  
  70.                     1    =    Pretty A QuickBasic Source File
  71.                     2    =    Print A File"
  72.  
  73.       by pressing key 1 or 2.
  74.  
  75.       If you select 1:
  76.  
  77.       The program will then prompt you for the left margin you want, with
  78.       the default 0. (QuickBasic will always set labels flush left)
  79.  
  80.       Then answer for the desired number of spaces to use for the structure
  81.       indent, with the default 4.
  82.  
  83.       Answer Y if you want the first letters of the source code
  84.       capitalized, with the default being No. I personally find first
  85.       capitals to be esthetically pleasing, but you should be cautious if
  86.       your program involves matching embeded strings. QuickBasic will
  87.       automatically set all reserved words to capitals.
  88.  
  89.       Answer Y if you want the program to delete empty lines.
  90.  
  91.       Answer Y if you want the source code to be displayed on the screen as
  92.       it is being processed.
  93.  
  94.       Press the key corresponding to the drive that the sorce is located
  95.       on.
  96.  
  97.       Select and enter the file you wish to prettify.
  98.  
  99.       Enter the name you wish to give the prettified source code, including
  100.       the drive if applicable.
  101.  
  102.       QbPrt will then process the selected input file, and write it to the
  103.       named output file.
  104.  
  105.       The processed file should then be loaded into QuickBasic and saved as
  106.       an ASCII file if separate compilation with BC (C) is to be used. This
  107.       will change all of the reserved words back to capitals.
  108.  
  109.       You will then be returned to the initial selection screen.
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.                                                            Pg 2
  122.  
  123.  
  124.  
  125.       If you select 2:
  126.  
  127.       Select the drive that the source code is located on.
  128.  
  129.       Select and enter the file that you wish to print.
  130.  
  131.       Enter the title that you wish to use on the printed file.
  132.  
  133.       Answer where you want the processed file send. Either enter the drive
  134.       and file name to produce a disk file, or enter PRN to send the output
  135.       directly to the printer without saving to disk.
  136.  
  137.       Answer the line length that your printer will accomodate, or that you
  138.       wish.
  139.  
  140.       Answer the number of lines per page that your printer will
  141.       accomodate, or that you wish.
  142.  
  143.       Answer the number of columns that you want for the left margin.
  144.  
  145.       Answer the number of spaces that you want between the numbered lines
  146.       delimiter and the source code.
  147.  
  148.       The program will then process the selected input file, and send it to
  149.       the named destination.
  150.  
  151.       The disk file produced is suitable for printing on a "plain vanilla"
  152.       dot matrix printer that prints the standard IBM/Epson character set.
  153.       If you have a different printer, try it and see what happens.
  154.  
  155.       If you select 9:
  156.  
  157.       QbPrt will end and return to DOS.
  158.       --------------------------------------------------------------------
  159.  
  160.       Limitations:
  161.  
  162.       This program is intended for use with QuickBasic 4.0 or 4.5. I have
  163.       not tried it with TurboBasic (C), and it may, or may not, work.
  164.  
  165.       The         IF ...... THEN  '(REM) comment
  166.                        .
  167.                     (ELSE, ELSEIF)
  168.                        .
  169.                   END IF
  170.  
  171.       structure will cause problems. Don't put a comment on the line with
  172.       the IF ..... THEN.
  173.  
  174.       Don't put anything else, except comments, on lines with labels, if
  175.       the label is embedded in a structure.
  176.  
  177.       These are not  bugs, but a decision on my part. Parsing all of the
  178.       possible variations of labels, structures, embedded strings, and
  179.       comments would significantly slow down the program.
  180.  
  181.       Labels will be flush left. Stand alone comments will be flush left.
  182.  
  183.                                                            Pg 3
  184.  
  185.  
  186.