home *** CD-ROM | disk | FTP | other *** search
/ Simtel MSDOS 1992 December / simtel1292_SIMTEL_1292_Walnut_Creek.iso / msdos / flowchrt / flowchrt.arc / FLOW.DOC < prev    next >
Text File  |  1985-12-22  |  48KB  |  1,198 lines

  1.     
  2.     
  3.     
  4.     
  5.     
  6.     
  7.     
  8.     
  9.     
  10.     
  11.     
  12.     
  13.     
  14.     
  15.     
  16.     
  17.     
  18.     
  19.     
  20.    
  21.    
  22.    
  23.    
  24.                             FLOWCHARTER 1.45
  25.                             by J. C. Justin 
  26.      
  27.    
  28.    
  29.    
  30.    
  31.    
  32.    
  33.    
  34.    
  35.    
  36.    
  37.    
  38.    
  39.    
  40.    
  41.                             Table of Contents
  42.      1.  INTRODUCTION
  43.         
  44.          FLOWCHARTER Overview .................................  1-1 
  45.          FLOWCHARTER files ....................................  1-2
  46.           
  47.      2.  FLOWCHARTER Installation
  48.        
  49.          Initialization .......................................  2-1   
  50.          FLOWCHARTER execution ................................  2-2
  51.          FLOWCHARTER Command Options ..........................  2-3
  52.       
  53.      3.  Flowchart Files
  54.         
  55.          Flowchart Command Structure ..........................  3-1
  56.          Flowchart Commands ...................................  3-2  
  57.          Special Format Commands ..............................  3-8
  58.      
  59.      4.  FLOWCHARTER Messages
  60.  
  61.          Error Messages .......................................  4-1 
  62.  
  63.     
  64.    
  65. 
  66.                                                                     1-1
  67.             
  68.    
  69.    
  70.                              INTRODUCTION  
  71.    
  72.    FLOWCHARTER OVERVIEW
  73.    
  74.      The purpose of a flowchart is to provide  a  method  of  displaying 
  75.      complex  procedures  or events in a graphical manner using standard 
  76.      symbols which are easy  to  understand.  The  most  common  use  of 
  77.      flowcharts  is  in  the design of complex computer programs.  These 
  78.      flowcharts show the basic design of the program independent of  the 
  79.      computer  language  in  which  they will later be written.  In this 
  80.      way,  other programmers can translate the design  into  the  actual 
  81.      program using the flowcharts.  
  82.      
  83.      FLOWCHARTER is designed to provide a programmer with the capability 
  84.      to  easily  produce flowcharts using simple commands which are then 
  85.      translated into the actual flowchart symbols and output  to  a  dot 
  86.      matrix printer.  
  87.      
  88.      This  method  allows flowcharts to be easily updated as the program 
  89.      design changes and eliminates the tedious job of  drawing  and  re-
  90.      drawing  flowcharts while maintaining up to date drawings.  Updates 
  91.      or corrections are made to the flowchart using  any  standard  text 
  92.      editer such as Word Star, PC Write etc...  and then re-printed with 
  93.      minimal effort.  
  94.      
  95.      The  FLOWCHARTER was developed for use on the IBM Personal Computer 
  96.      or any compatible such as the PC XT, PC AT,  Sperry PC,  etc..  and 
  97.      the Epson FX-80 or compatible dot matrix printer.  
  98.  
  99.      This  software  is  user-supported  software  and  copies  of  this 
  100.      diskette  (but  not of the printed manual) can be freely copied and 
  101.      used by anyone who wishes to do so. Because of this, FLOWCHARTER is 
  102.      changing to respond to the requests of its users.  If you feel this 
  103.      program  has  benefited  you  or  or  you  wish to recieve the most 
  104.      current revision,  we encourage you to register for your own  copy. 
  105.      Registration costs $25 and provides you the following benefits: 
  106.          
  107.      *  Current FLOWCHARTER manual    *  FLOWCHARTER support for a year
  108.      *  Current FLOWCHARTER diskette  *  Telephone support for questions
  109.      
  110.      To register for your copy send $25 to:
  111.      
  112.      JJ Enterprises(tm)
  113.      13133 Thomas Circle, Burnsville, Mn. 55337 612/890-5405
  114.      PO, COD,  Minnesota residents add 6% sales tax.
  115.      Quantity discounts available.
  116.      
  117.      If  you  have  any  comments  concerning  FLOWCHARTER they would be 
  118.      greatly appreciated and can be sent to the above address. Rights to 
  119.      commercially market this software remain with the programmer.  
  120.      
  121.     
  122.                                                                     1-2
  123.             
  124.    FLOWCHARTER FILES
  125.  
  126.      Included with the FLOWCHARTER program is a number  of  other  files 
  127.      which  enable  it  to  be used with different printers or allow the 
  128.      user to tailor the program to their specific needs.  The  following 
  129.      list  contains  a  brief description if each file supplied with the 
  130.      FLOWCHARTER program.  
  131.  
  132.                                    
  133.      FLOW.COM  
  134.        This file is the actual FLOWCHARTER executable program.  
  135.  
  136.      PRINTDVR.000
  137.        This  file  contains  the  printer  driver  to  be  used  by  the 
  138.        FLOWCHARTER program (see 2-1).  
  139.  
  140.      FLOWDEMO.FLO
  141.        This file contains a sample flowchart,  which can be  printed  by 
  142.        the  FLOWCHARTER  program,  and  demonstrates the various options 
  143.        possible.  
  144.      
  145.      FLOW.DOC
  146.        This  file  contains  the  document  explaining  the  FLOWCHARTER 
  147.        program and its operation.  
  148. 
  149.                                                                     2-1
  150.  
  151.  
  152.                           FLOWCHARTER INSTALLATION
  153.  
  154.    INITIALIZATION
  155.      
  156.      Before using the FLOWCHARTER  program  you  should,  for  your  own 
  157.      protection,  make  a  working  copy of the distribution disk before 
  158.      proceeding.  
  159.  
  160.      Before the FLOWCHARTER program can be run you must copy the printer 
  161.      driver  for  your printer into the file called PRINTDVR.000.  Refer 
  162.      to page 1-2 for the descriptions of each printer driver. Locate the 
  163.      driver for your printer (all drivers end with the  extension  .DVR) 
  164.      and  enter  the  following  command replacing the XXXXXXXX with the 
  165.      name of the driver for your printer.  
  166.      
  167.      COPY XXXXXXXX.DVR PRINTDVR.000
  168.  
  169.      When  the  FLOWCHARTER  program  is  started,  it  searches for the 
  170.      PRINTDVR.000 file in the current directory.  If  the  file  is  not 
  171.      located in the current directory,  the path must be specified using 
  172.      the INSTALL program  (see  4-1).  This  will allow you to place the 
  173.      FLOWCHARTER  program  and  the  printer  driver  in a common system 
  174.      directory.  
  175.       
  176.                                                                     2-2
  177.           
  178.    
  179.    FLOWCHARTER EXECUTION
  180.    
  181.      The  following  section  describes  operation  of  the  FLOWCHARTER 
  182.      program and assumes that the FLOWCHARTER program (FLOW.COM) and the 
  183.      printer driver (PRINTDVR.000) are located in the current directory.  
  184.      If  the  file  PRINTDVR.000  can not be found the following message 
  185.      will be printed and the program will terminate.  
  186.  
  187.        PRINTDVR.000 File not found!! --- FLOWCHARTER Program terminated
  188.  
  189.      To run the FLOWCHARTER program enter the command: 
  190.    
  191.      FLOW 
  192.    
  193.      The FLOWCHARTER program should now be running  and  displaying  the 
  194.      following prompt on the third line from the bottom: 
  195.      
  196.      OPTION > 
  197.      
  198.      Below  the prompt line are 2 lines showing all of the single letter 
  199.      OPTION commands possible.  Each command is executed by pressing the 
  200.      corrosponding letter.  If a command requires more information (such 
  201.      as a filename) another message requesting the needed information is 
  202.      displayed above the prompt line.  Any other  information  or  error 
  203.      messages are also scrolled onto the screen above the prompt line.  
  204.  
  205.      The FLOWCHARTER program processes two types of files.  The fist type 
  206.      contains  the  flowchart  commands which are used to plot the actual 
  207.      flowchart symbols.
  208.   
  209.      Example:
  210.   
  211.      START   .$H EXAMPLE OF A FLOWCHART FILE
  212.              .$P PROCESS BOX SYMBOL
  213.              .$D DISPLAY SYMBOL
  214.              .$E END
  215.    
  216.   
  217.      The  second type is a batch file which contains FLOWCHARTER command 
  218.      options.  This file can be used to load the  Plot  Queue  with  the 
  219.      names  of  flowchart files which are to be plotted.  This file type 
  220.      must have a filename extension of (.BAT).  
  221.      
  222.      Example:
  223.  
  224.      A          (Add DEMO.FLO file to Plot Queue)
  225.      DEMO.FLO
  226.      A          (Add DEMO1.FLO file to Plot Queue)
  227.      DEMO1.FLO
  228.      Q          (List Plot Queue)
  229.      P          (Plot files)
  230.  
  231.      When the FLOWCHARTER program is first started it searches for batch 
  232.      file AUTOFLOW.BAT and starts executing it.  This file can  be  used 
  233.      load  a  flowchart  file which initializes the FLOWCHARTER defaults 
  234.      (such as margins, position of title, etc.).  
  235.  
  236.  
  237.  
  238. 
  239.                                                                     2-3
  240.      
  241.    FLOWCHARTER COMMAND OPTIONS
  242.      
  243.      
  244.      
  245.      COMMAND OPTION "A"
  246.      
  247.        The FLOWCHARTER program is capable  of  printing  any  number  of 
  248.        flowchart  files by (A)dding the names of all files to be printed 
  249.        to the Plot Queue using the (A) command option.  To enter a  file 
  250.        name press "A" and the following message will be displayed: 
  251.        
  252.        Enter Filename > 
  253.      
  254.        Now  enter the name of the flowchart file to be printed.  You can 
  255.        use a file name with a drive (like C:DEMO) or an extension  (like 
  256.        DEMO.FLO).   With  DOS  2.00  you  can  also  use  a  pathname  ( 
  257.        \TEST\DEMO.FLO  ).   FLOWCHARTER  uses  standard  DOS  files  and 
  258.        filenames.  However, the entire file name must not be longer than 
  259.        30 characters.  
  260.        
  261.        An  optional  field follows a flowchart filename which is used to 
  262.        specify the first and last sheets of the flowchart to be printed.  
  263.        A (/) must seperate the filename,  first sheet number,  and  last 
  264.        sheet  number.  If  this field is ommited all sheets are printed.  
  265.        In the following example, only sheets 2 through 3 of FLOWDEMO.FLO 
  266.        will be printed.  
  267.        
  268.        Enter Filename >FLOWDEMO.FLO/2/3 
  269.        
  270.        The FLOWCHARTER program searches for the filename entered  before 
  271.        it  is  entered  into  the  Plot  Queue and if the specified file 
  272.        cannot be found the following message will be displayed: 
  273.        
  274.        FILE NOT FOUND...  
  275.        
  276.       
  277.      
  278.      COMMAND OPTION X (Exit FLOWCHARTER) 
  279.      
  280.        Pressing X causes the FLOWCHARTER program to  be  terminated  and 
  281.        control returned to DOS.  
  282.  
  283.      
  284.                                                                     2-4
  285.      
  286.      
  287.      COMMAND OPTION P (Process Plot Queue)
  288.        
  289.        Pressing  P  causes all flowchart/batch files entered in the Plot 
  290.        Queue to be plotted/executed.  As the Plot  Queue  is  processed, 
  291.        the  lower  three lines of the display is replaced with a running 
  292.        status showing the name of the file being  processed,  the  sheet 
  293.        being  printed,  the  total number of sheets to print,  the total 
  294.        number of files in the Plot Queue left to process,  and the total 
  295.        number  of  flowchart  errors  and warnings printed for all files 
  296.        processed so far. The format of the running status is as follows: 
  297.    
  298.        
  299.        Plotting................... FILENAME.EXT   
  300.        Currently printing sheet...   1 of   4     Error Count......  0
  301.        Files not yet Plotted......   0            Warning Count....  0
  302.    
  303.      
  304.        Pressing  any  key while the Plot Queue is being processed causes 
  305.        the following message to be displayed and allows  you  to  either 
  306.        terminate or continue processing the files in the Plot Queue.  
  307.        
  308.        **Abort (Y/N)?  
  309.        
  310.        If  Y is pressed,  the current file being processed is terminated 
  311.        and removed form the Plot Queue and the  cursor  returns  to  the 
  312.        prompt  line  and  waits  for  another  Command  Option.  If N is 
  313.        pressed, processing continues where it left off.  
  314. 
  315.                                                                     2-5
  316.  
  317.      COMMAND OPTION S (Scan Plot Queue) 
  318.        
  319.        Pressing S causes all files entered in the Plot Queue  to  be  be 
  320.        scanned  for  any errors.  When initiated the following prompt is 
  321.        displayed: 
  322.     
  323.    
  324.        Select Scan Mode...(1 = Scan & Printout   2 = Scan) > 
  325.    
  326.     
  327.        If "1" is selected,  all error messages will be outputted to  the 
  328.        printer  and the screen as the flowcharts are scanned.  If "2" is 
  329.        selected all error messages will be output to the screen only.  
  330.  
  331.        As the Plot Queue is processed,  the lower  three  lines  of  the 
  332.        display is replaced with a running status showing the name of the 
  333.        file being processed,  the sheet being printed,  the total number 
  334.        of sheets to print,  the total number of files in the Plot  Queue 
  335.        left  to  process,  and  the total number of flowchart errors and 
  336.        warnings printed for all files processed so far.  The  format  of 
  337.        the running status is as follows: 
  338.    
  339.  
  340.        Plotting................... FILENAME.EXT   
  341.        Currently printing sheet...   1 of   4     Error Count......  0
  342.        Files not yet Plotted......   0            Warning Count....  0
  343.    
  344.  
  345.        Pressing any key while scanning causes the following  message  to 
  346.        be  displayed  and  allows  you  to  either terminate or continue 
  347.        scanning the Plot Queue.  
  348.    
  349.        
  350.        **Abort (Y/N)?  
  351.    
  352.        
  353.        If Y is pressed, scanning is terminated and the cursor returns to 
  354.        the prompt line and waits for another Command  Option.  If  N  is 
  355.        pressed, scanning continues where it left off.  
  356.     
  357.        Unlike  the  command  option "P",  files are not deleted from the 
  358.        Plot Queue as they are processed so  when  scanning  is  complete 
  359.        they can be plotted without re-entering the filenames.  
  360.        
  361.         
  362.                                                                     2-6
  363.        
  364.      COMMAND OPTION Q (List Plot Queue) 
  365.        
  366.        The  following  command option allows you to verify the filenames 
  367.        and sheet limits entered in the Plot Queue.  Each filename listed 
  368.        is preceded by a number which represents the order the files will 
  369.        be processed.  This number is also used if you want to  delete  a 
  370.        filename  from  the Plot Queue.  (see Command Option D).  To list 
  371.        the Plot Queue press Q  and  FLOWCHARTER  will  print  all  files 
  372.        currently in the Plot Queue.  
  373.        
  374.        EXAMPLE:
  375.         
  376.        **1     TEST.BAT                BATCH FILE
  377.        **2     \TEST\DEMO.FLO          PAGES 1 - 999
  378.        **3     DEMO1.FLO               PAGES 1 - 6
  379.        **4     DEMO2.                  PAGES 1 - 1
  380.        
  381.        
  382.        
  383.        
  384.      COMMAND OPTION D (Delete filename from Plot Queue)
  385.        
  386.        This  Command  Option  allows you delete a filename from the Plot 
  387.        Queue.  To delete a filename from the queue  you  must  know  the 
  388.        number of the filename in the Plot Queue.  To find this, list the 
  389.        Plot Queue by pressing "Q" (List Plot Queue command).  
  390.        
  391.        
  392.        **1     \TEST\DEMO.FLO          PAGES 1 - 999
  393.        **2     DEMO1.FLO               PAGES 1 - 6
  394.        **3     DEMO2.                  PAGES 1 - 1
  395.        
  396.        
  397.        Now press "D" and the following message will be displayed:
  398.        
  399.        ENTER NUMBER OF FILE TO DELETE >
  400.        
  401.        Now enter the number of the  filename  to  delete  from  queue.  
  402.        
  403.        For example: Enter 1 to delete \TEST\DEMO.FLO 
  404.                     Enter 2 to delete DEMO1.FLO
  405.                     Etc...
  406.        
  407.        If  you  deleted  filename number 2 then listed the Plot Queue it 
  408.        would now be: 
  409.        
  410.        
  411.        **1     \TEST\DEMO.FLO          ALL PAGES
  412.        **2     DEMO2.                  PAGES 1 - 1
  413.        
  414.         
  415.                                                                     3-1
  416.        
  417.        
  418.                            FLOWCHART FILES
  419.    
  420.      
  421.    FLOWCHART COMMAND STRUCTURE
  422.       
  423.      The FLOWCHARTER program automatically generates  three  columns  of 
  424.      flowchart  symbols which fit on a standard 8.5 x 11 sheet of paper.  
  425.      When a chain of flowchart symbols takes more  than  1  column,  the 
  426.      first  column  ends in a numbered circle and the next column begins 
  427.      with the same numbered circle.  
  428.      
  429.      Any connecting circles going to another sheet will be indicated  by 
  430.      writing  the  word "SHEET" and the coresponding sheet number.  Each 
  431.      printed sheet will automatically be numbered by placing  "SHEET  __ 
  432.      OF __" in the lower right corner.  
  433.      
  434.      Flowcharts are generated by creating a text file which contains the 
  435.      flowchart  commands  which  are  used by the FLOWCHARTER program to 
  436.      draw  the  individual  flowchart  symbols.   This   file   can   be 
  437.      created/edited  using  any  text editer such as Wordstar,  PC Write 
  438.      etc...  Each line in  the  flowchart  file  may  contain  only  one 
  439.      flowchart command and consists of the following three fields: 
  440.      
  441.      Label :  This field is optional but must begin in column 1 if used.  
  442.               The label may contain any characters to a maximum  of  10.  
  443.               If  the  label  field  is used,  a space must separate the 
  444.               label and the command field.  When the FLOWCHARTER finds a 
  445.               label,  a numbered connector circle is generated with  the 
  446.               label printed to left of the circle.  
  447.      
  448.      Command: This  field  must  begin  in  any column except 1.  It can 
  449.               contain any legal flowchart command.  
  450.      
  451.      Comment:  This  field must follow the command field and consists of 
  452.               any string of characters to be printed with the  flowchart 
  453.               symbol specified in the command field.  If all the comment 
  454.               does  not  fit  on  one  command  line,  the  continuation 
  455.               character (;) must appear at the end of that line and  the 
  456.               next  line  must  contain only a (.$) in the Command field 
  457.               and  the  remaining  text  in  the  comment   field.   The 
  458.               FLOWCHARTER  program automatically divides the text string 
  459.               to fit in each  flowchart  symbol.  In  the  case  of  the 
  460.               Test/Decision   symbol   the   text   is   centered   both 
  461.               horzizontally and vertically.  
  462.      
  463.       
  464.                                                                     3-2
  465.      
  466.    FLOWCHART COMMANDS
  467.    
  468.      The  following  section  describes  all  of  the flowchart commands 
  469.      available and examples of how they can be used.  The examples  used 
  470.      are  contained  in  the file called FLOWDEMO.FLO supplied with this 
  471.      program.  This file can be printed before this section is  read  in 
  472.      order to make the examples easier to understand.  
  473.      
  474.      
  475.      
  476.      HEAD OF CODING (.$H)
  477.      
  478.        The .$H command is used to start (or Head) a  new  flowchart.  It 
  479.        causes a terminal symbol to be drawn at the top of a new sheet to 
  480.        designate  the  entrance to the flowchart.  If a label is present 
  481.        it will be printed inside the terminal symbol.  If  there  is  no 
  482.        label,  "ENTER" will be printed instead.  The text in the comment 
  483.        field is used as the title of the flowchart and is printed on the 
  484.        lower left corner of the  sheet.  The  title  may  be  up  to  90 
  485.        characters  in length and will be printed on all sheets until the 
  486.        flowchart ends or another .$H command is encountered.  
  487.      
  488.      
  489.      
  490.      PROCESS BOX (.$P)
  491.      
  492.        The .$P command is used to draw a process box symbol.  The normal 
  493.        symbol size contains four lines of  twelve  characters  from  the 
  494.        comment  field.  If  the comment field consists of more than four 
  495.        lines,  the box is increased in hight to accommodate  up  to  ten 
  496.        lines of text.  
  497.        
  498.        Example:
  499.        
  500.                .$P COMMENT IN PROCESS BOX
  501.        
  502.        
  503.      LISTING (.$L)
  504.        
  505.        The.$L  command  is  used to draw a listing/documentation symbol.  
  506.        The normal symbol size contains four lines of  twelve  characters 
  507.        from  the  comment  field.  If the comment field consists of more 
  508.        than four lines,  the symbol is increased in hight to accommodate 
  509.        up to ten lines of text.  
  510.        
  511.        Example:
  512.        
  513.                .$L THIS IS A LISTING SYMBOL
  514.        
  515.         
  516.                                                                     3-3
  517.        
  518.        
  519.        
  520.        
  521.      SUBROUTINE BOX (.$S)
  522.        
  523.        The  .$S  command  is  used to draw a subroutine box symbol.  The 
  524.        symbol can contain a maximum of four lines of  twelve  characters 
  525.        from  the  comment  field.  Since  the  subroutine  may have more 
  526.        detailed coding elsewhere in the  same  set  of  flowcharts,  the 
  527.        symbol  can  be  labeld  by  placing  the label of the subroutine 
  528.        followed by a (/) as the first word in  the  comment  field.  The 
  529.        label can be a maximum of ten characters and will be printed just 
  530.        above and to the left of the subroutine symbol.  The word "SHEET" 
  531.        followed  by a sheet number will be printed just above and to the 
  532.        right.  The sheet number is the sheet  where  the  label  of  the 
  533.        detailed  coding  is located.  If the label is not located in the 
  534.        current flowchart file a question mark will be printed instead of 
  535.        the sheet number.  
  536.        
  537.        Example:
  538.        
  539.                .$S SUBLABEL/ COMMENT IN SUBROUTINE BOX
  540.         
  541.      
  542.      
  543.      
  544.      PREPARATION BOX (.$W)
  545.      
  546.        The .$W command is used to draw a  preparation  box  symbol.  The 
  547.        symbol  can  contain a maximum of four lines of twelve characters 
  548.        from the comment field.  Since the preparation routine  may  have 
  549.        more  detailed  coding  located  elsewhere  in  the  same  set of 
  550.        flowcharts, the symbol can be labeled by placing the label of the 
  551.        preparation routine followed by a (/) as the first  word  in  the 
  552.        comment  field.  The label can be a maximum of ten characters and 
  553.        will be printed just above and to the  left  of  the  preparation 
  554.        symbol.  The  word  "SHEET"  followed  by  a sheet number will be 
  555.        printed just above and to the right.  The  sheet  number  is  the 
  556.        sheet  where the label of the detailed coding is located.  If the 
  557.        label is not located in this flowchart file a question mark  will 
  558.        be printed instead of the sheet number.  
  559.        
  560.        Example:    
  561.        
  562.                .$W PREPLABEL/ COMMENT IN PREPARATION BOX
  563.         
  564.         
  565.                                                                     3-4
  566.        
  567.      INPUT/OUTPUT BOX (.$I)
  568.        
  569.        The  .$I  command is used to draw a input/output box symbol.  The 
  570.        symbol can contain a maximum of four lines of  twelve  characters 
  571.        from  the comment field.  Since the input/output routine may have 
  572.        more detailed  coding  located  elsewhere  in  the  same  set  of 
  573.        flowcharts, the symbol can be labeled by placing the label of the 
  574.        input/output  routine  followed by a (/) as the first word in the 
  575.        comment field.  The label can be a maximum of ten characters  and 
  576.        will  be  printed  just above and to the left of the input/output 
  577.        symbol.  The word "SHEET" followed by  a  sheet  number  will  be 
  578.        printed  just  above  and  to the right.  The sheet number is the 
  579.        sheet where the label of the detailed coding is located.  If  the 
  580.        label  is not located in this flowchart file a question mark will 
  581.        be printed instead of the sheet number.  
  582.        
  583.        Example:   
  584.        
  585.                .$I INOUTLABEL/ COMMENT IN INPUT/OUTPUT BOX
  586.        
  587.        
  588.        
  589.      JUMP (.$J)
  590.        
  591.        The .$J command will cause a jump to the label specified  in  the 
  592.        comment field.  The specified label must exist within the current 
  593.        flowchart  file.   The  .$J  command  draws  a  connector  circle 
  594.        containing a FLOWCHARTER generated  number  with  the  label  and 
  595.        sheet  number of where that label is located printed to the right 
  596.        of the circle.  On the sheet where the label is  located  another 
  597.        connector  circle  is  drawn  with the same FLOWCHARTER generated 
  598.        number.  If the label is located on the same  sheet  as  the  .$J 
  599.        command the word "SHEET" will not be printed.  
  600.        
  601.        Example:   
  602.        
  603.                .$J LABEL
  604.        
  605.        
  606.        
  607.      COMMENT (.$C)
  608.        
  609.        The  .$C  command  draws a comment symbol which can contain up to 
  610.        ten lines of eighteen characters  from  the  comment  field.  The 
  611.        size  of  the comment bracket expands to accomodate the amount of 
  612.        the text.  
  613.      
  614.        Example:   
  615.        
  616.                .$C THIS IS THE COMMENT 
  617.        
  618.         
  619.                                                                     3-5
  620.      MESSAGE (.$M)
  621.        
  622.        The .$M command prints a message or note of up to ten  characters 
  623.        above and to the left of the next flowchart symbol.  
  624.        
  625.        Example:   
  626.        
  627.                .$M MESSAGE 
  628.        
  629.        
  630.        
  631.      TEST (.$T)
  632.        
  633.        The .$T command draws a test/decision symbol which can contain up 
  634.        to  three  lines  of eight characters.  If more than two branches 
  635.        are required,  the number  of  branches  required  are  specified 
  636.        immediately  following the .$T as part of the command field. The 
  637.        branch  alternatives/conditions  are  specified  using  the  .$A 
  638.        command.  
  639.        
  640.        Examples:   
  641.        
  642.                .$T THIS IS A TEST SYMBOL
  643.                .$T3 MULTIPLE BRANCH TEST
  644.        
  645.        Default  conditions  occur when using the .$T command without the 
  646.        .$A command.  When not using the .$A command,  tests are  assumed 
  647.        to  have  two  alternatives/conditions  associated  with the test 
  648.        symbol,  "YES" (test passes) and "NO" (test fails).  When  a  .$J 
  649.        command  or  .$E command follows the .$T command the word "NO" is 
  650.        printed to the right of the test symbol and  the  word  "YES"  is 
  651.        printed  below the test symbol.  If followed by a .$J command,  a 
  652.        connector symbol and the label specified in the comment field  of 
  653.        the  .$J  command is printed to the right of the test symbol.  If 
  654.        followed by a .$E command, a end of coding symbol is drawn to the 
  655.        right of the test symbol with the text from the comment field  of 
  656.        the  .$E command printed inside the end of coding symbol.  If the 
  657.        comment field of the .$E command is blank the word "EXIT" will be 
  658.        printed instead.  
  659.         
  660.        Examples:   
  661.        
  662.                .$T GOOD
  663.                .$J GOODONE
  664.                .$T BAD         
  665.                .$E ERROR
  666.        GOODONE .$D DISPLAY DATA
  667.        
  668.        When the .$T command is not followed by a .$A,  .$J  or  .$E  the 
  669.        word  "YES"  is  printed  to the right of the test symbol and the 
  670.        word "NO" is printed below the test symbol.  A  connector  symbol 
  671.        is  drawn  to the right which branches to the point following the 
  672.        next flowchart symbol.  
  673.        
  674.        Example:   
  675.        
  676.                .$T PRINTER OFF?
  677.                .$P PRINT LINE
  678.                .$P GET NEXT LINE
  679.         
  680.                                                                     3-6
  681.        
  682.      ALTERNATIVES (.$A)
  683.        
  684.        The .$A command is used to specify the  branch  alternatives  for 
  685.        the  test  symbol.  This  command  must  directly follow the test 
  686.        (.$T) to which it applies.  The format for the comment  field  of 
  687.        the .$A command is as follows: 
  688.        
  689.                  .$A Alternative,Label Alternative,Label etc...
  690.        
  691.        The alternative can be a maximum six characters and specifies the 
  692.        branch  condition out of the test symbol (for example,  YES,  NO, 
  693.        PASS, FAIL,  etc.).  The label can be a maximum of ten characters 
  694.        and  specifies  the  destination  for the associated alternative.  
  695.        The label must exist elsewhere in the current flowchart file.  
  696.        
  697.        When two labels are specified in the .$A comment field the  first 
  698.        alternative  with  a  label  is  printed to the right of the test 
  699.        symbol,  and the second alternative and label are printed  below.  
  700.        Each   alternative  produces  a  connector  circle  containing  a 
  701.        FLOWCHARTER generated number and the label and sheet number where 
  702.        the label  is  located.  If  only  one  label  is  specified  the 
  703.        alternative  with  the  label is printed to the right of the test 
  704.        symbol.  The alternative without the label is printed  below  the 
  705.        test symbol allowing a continous flow of symbols.  
  706.        
  707.        Examples:   
  708.        
  709.                .$T PASS 1
  710.                .$A YES,BRANCH1 NO
  711.                .$P PROCESS ONE
  712.                .$T PASS 2
  713.                .$A YES,BRANCH2 NO,BRANCH1
  714.        BRANCH1 .$P PROCESS TWO
  715.        BRANCH2 .$P PROCESS THREE
  716.        
  717.        When  multiple branches were selected by the previous .$T command 
  718.        (ie .$T4),  the number of alternatives specified in  the  comment 
  719.        field  of  the .$A command must equal the number specified in the 
  720.        .$T command.  Also,  more than 2 alternatives cannot be specified 
  721.        without labels.  
  722.        
  723.        Example:   
  724.        
  725.                 .$T4 BRANCH ON CODE
  726.                 .$A CODE=4,ROUTINE4 CODE=3,ROUTINE3 CODE=2,ROUTINE2 CODE=1
  727.        ROUTINE1 .$S FUNCTION 1
  728.        ROUTINE2 .$S FUNCTION 2
  729.        ROUTINE3 .$S FUNCTION 3
  730.        ROUTINE4 .$S FUNCTION 4
  731.        
  732.        
  733.        
  734.         
  735.                                                                     3-7
  736.        
  737.        When  the  .$A  command is used with two labels unspecified,  the 
  738.        first alternative without a  label  is  printed  below  the  test 
  739.        symbol  and  the second alternative without a label is printed to 
  740.        the right and branches to  a  connector  symbol  after  the  next 
  741.        flowchart symbol.  
  742.        
  743.        Example:   
  744.        
  745.                .$T DATA READY?
  746.                .$A YES NO
  747.                .$P GET DATA   
  748.                .$P PROCESS ANY DATA
  749.  
  750.         
  751.  
  752.      ALTERNATE END OF CODING (.$AE)
  753.        
  754.        The  .$AE  command is used to generate an end of coding symbol to 
  755.        the right of the  test  symbol.  This  command  must  immediately 
  756.        follow  the .$T command to which it applies.  The format for the 
  757.        comment field is the same as the .$A  command  except  the  first 
  758.        alternative  appears  to  the  right  of the test symbol and it's 
  759.        label is printed inside the end of coding symbol.  If  the  label 
  760.        is omitted, the word "EXIT" will be printed instead.  
  761.        
  762.        Example:   
  763.        
  764.                .$T STOP
  765.                .$AE YES,HALT NO
  766.        
  767.        
  768.      DISPLAY (.$D)
  769.        
  770.        The  .$D  command  draws a display symbol which can contain up to 
  771.        three lines of eight characters from the comment field.  
  772.        
  773.        Example:   
  774.        
  775.                .$D THIS IS A DISPLAY SYMBOL
  776.        
  777.        
  778.      END OF CODING (.$E)
  779.        
  780.        The .$E command indicates the end of the  current  flowchart  and 
  781.        draws  the  end  of  coding/terminal  symbol  which can contain a 
  782.        maximum of ten characters from the comment field.  If the comment 
  783.        field  is  blank  the word "EXIT" will be printed in the terminal 
  784.        symbol instead.  
  785.          
  786. 
  787.                                                                     3-8
  788.  
  789.    SPECIAL FORMAT COMMANDS
  790.  
  791.      Special format commands do not generate any symbols,  but allow you 
  792.      to change the defaults for margins, positioning of text, and adding 
  793.      special text.  Once changed,  the new values remain in effect until 
  794.      reset by another command.  Care must be taken when repositioning or 
  795.      adding  text so as not to write over any existing text on the page.  
  796.      
  797.      In addition,  some of the commands allow you to change the font  of 
  798.      the text being printed (Bold,  Expanded, etc.).  Depending upon the 
  799.      printer driver being used, only some of the 16 font types may work.  
  800.      It is suggested that the FLOWDEMO.FLO file be  plotted  which  will 
  801.      print text in all font types.  You can then examine the printout to 
  802.      see which font types are available for your printer.  
  803.      
  804.      
  805.      
  806.      MARGIN COMMAND (.$XM)
  807.       
  808.        This command is used to change the margins  on  the  sheet.  This 
  809.        command  must  appear  before  the  .$H  (Head  of Coding) at the 
  810.        beginning of the flowchart file or between a .$E and .$H command.  
  811.        Once changed,  the new margins remain in effect until changed  by 
  812.        another  command.  The  FLOWCHARTER program automatically reduces 
  813.        the length and number of flowchart columns drawn on each sheet so 
  814.        all symbols are within the specified left, right, top, and bottom 
  815.        limits.  The format for this command is as follows : 
  816.           
  817.               .$XM L.LL,R.RR,T.TT,B.BB
  818.      
  819.        where: L.LL  = This parameter specifies the left margin in decimal 
  820.                       inches. The Default is 0.25 inches.  
  821.    
  822.               R.RR  = This  parameter  specifies  the  right  margin  in 
  823.                       decimal inches. The Default is 0.0 inches.  
  824.  
  825.               T.TT  = This parameter specifies the top margin in decimal 
  826.                       inches. The Default is 0.20 inches.  
  827.  
  828.               L.LL  = This parameter specifies the maximum length of the 
  829.                       flowchart in decimal inches from the top of the 
  830.                       sheet. The Default is 9.4 inches.
  831.           
  832.        All fields must contain a value and  commas  must  seperate  each 
  833.        field.  
  834. 
  835.                                                                     3-9
  836.  
  837.  
  838.      POSITION TITLE COMMAND (.$XH)
  839.  
  840.        This command is used to change the font and reposition the  title 
  841.        generated  by  the  .$H command.  This command must appear before 
  842.        the .$H to which it applies.  The titles on all sheets  following 
  843.        this  command  will  be  printed  at the specified position until 
  844.        another .$XH command is encountered.  The format of this  command 
  845.        is as follows: 
  846.           
  847.               .$XH Fx,X.XX,Y.YY
  848.  
  849.        where:  Fx    = This  parameter is optional and is used to change 
  850.                        the  font  that  the  title  will  be  printed in 
  851.                        (boldface,  condensed,  etc.).  The font type  is 
  852.                        specified  by  "x" and can be any value between 0 
  853.                        and 15. 
  854.  
  855.                X.XX  = This parameter specifies the horizontal position 
  856.                        in decimal inches from the left edge of the sheet 
  857.                        where the title should be printed. The Default is 
  858.                        1.0 inches.  
  859.  
  860.                Y.YY  = This parameter specifies the vertical position in 
  861.                        decimal inches from the top  edge  of  the  sheet 
  862.                        where the title should be printed. The Default is 
  863.                        9.75 inches.  
  864.  
  865.        All fields except the Fx field must contain a  value  and  commas 
  866.        must seperate each field.  
  867. 
  868.  
  869.                                                                     3-10
  870.  
  871.  
  872.  
  873.      POSITION SHEET COMMAND (.$XS)
  874.  
  875.        This command is used to change the font and reposition the (SHEET 
  876.        _  OF  _) on each sheet.  This command must appear before the .$H 
  877.        of the flowchart to which it applies.  The (SHEET _ OF _) on  all 
  878.        sheets  following  this  command will be printed at the specified 
  879.        position until another .$XS command is  encountered.  The  format 
  880.        of this command is as follows: 
  881.           
  882.               .$XH X.XX,Y.YY
  883.  
  884.        where:  Fx   = This  parameter  is optional and is used to change 
  885.                       the  font  that the (SHEET _ OF _) will be printed 
  886.                       in (boldface, condensed,  etc.).  The font type is 
  887.                       specified  by  "x"  and can be any value between 0 
  888.                       and 15.   
  889.  
  890.                X.XX = This  parameter  specifies the horizontal position
  891.                       in  decimal inches from the left edge of the sheet 
  892.                       where the (SHEET _ OF _) should  be  printed.  The 
  893.                       Default is 6.0 inches.  
  894.  
  895.                Y.YY = This parameter specifies the vertical position  in 
  896.                       decimal  inches  from  the  top  edge of the sheet 
  897.                       where the (SHEET _ OF _) should  be  printed.  The 
  898.                       Default is 9.75 inches.  
  899.  
  900.        All  fields  except  the Fx field must contain a value and commas 
  901.        must seperate each field.  
  902.  
  903. 
  904.                                                                     3-11
  905.  
  906.  
  907.      TEXT COMMAND (.$XT)
  908.  
  909.        This  command  is  used  to  print additional text on each sheet.  
  910.        Unlike the other special format commands this command can  appear 
  911.        after  the  .$H  of  the  flowchart  on  which  the text is to be 
  912.        printed.  More than one .$XT can be used to generate the  desired 
  913.        text.  Once  defined,  the  text  will  be  printed on all sheets 
  914.        following the .$XT until the next  .$XT  command  is  encountered 
  915.        with no parameters specified.  
  916.  
  917.        When more than one line of text is to be printed,  each line must 
  918.        be terminated with a semicolon (;).  The next line must contain a 
  919.        (.$) in the command field and any additional  text.  The  example 
  920.        below  would  print  four  lines  of  text  starting at positions 
  921.        specified.  
  922.  
  923.        Example:
  924.  
  925.               .$XT X.XX,Y.YY,LINE 1 OF TEXT;
  926.               .$  LINE 2 OF TEXT;
  927.               .$  LINE 3 OF TEXT;
  928.               .$  LAST LINE OF TEXT
  929.       
  930.        where: Fx    =  This parameter is optional and is used to  change
  931.                        the  font  that  the  text  will  be  printed  in 
  932.                        (boldface,  condensed,  etc.).  The  font type is 
  933.                        specified by "x" and can be any value  between  0 
  934.                        and 15.  If not specified, the program default is 
  935.                        used. See  4-1 on changing program defaults.
  936.  
  937.                X.XX =  This parameter specifies the  horizontal position 
  938.                        in decimal inches from the left edge of the sheet 
  939.                        where the text should be printed.  
  940.  
  941.                Y.YY =  This parameter specifies the vertical position in 
  942.                        decimal inches from the top  edge  of  the  sheet 
  943.                        where the text should be printed.  
  944.  
  945.        All fields except the Fx field must contain a  value  and  commas 
  946.        must  seperate  each  field.  If  no  parameters  are  specified, 
  947.        previously defined text is not printed on following sheets.  
  948.                                                                     3-12
  949.  
  950.       RESET DEFAULTS COMMAND (.$XR)
  951.  
  952.         This  command  is  used  to  reset the parameters changed by the 
  953.         .$XH, .$XS, .$XT, .$XM, and $XP commands to the original program 
  954.         defaults.  This command  must  appear  before  the  .$H  of  the 
  955.         flowchart   to   which   it  applies.   Each  parameter  can  be 
  956.         selectively reset by entering its corresponding  letter  in  the 
  957.         parameter  field  of the command.  The format of this command is 
  958.         as follows: 
  959.        
  960.         Example:
  961.  
  962.                .$XR HSTPM
  963.  
  964.         where: H = Set Title position  and  font  to  original  program 
  965.                    defaults.  
  966.  
  967.                S = Set 'SHEET OF SHEET ' position and font to original 
  968.                    program defaults.
  969.  
  970.                T = Disable printing of any special text.
  971.  
  972.                P = Sets  all  page  numbering  parameters  to original 
  973.                    program defaults.  
  974.  
  975.                M = Set margins to original program defaults.
  976.  
  977.                                                                     4-1
  978.  
  979.                     FLOWCHARTER MESSAGES           
  980.  
  981.  
  982.  
  983.  
  984.    ERROR MESSAGES
  985.  
  986.      When  a  flowchart file is plotted each command line is scanned for 
  987.      any errors.  If any are found, the line number,  the part(s) of the 
  988.      actual  line  in  error,  and  a  message  describing the error are 
  989.      scrolled on the screen above the prompt line.  
  990.  
  991.      The following section describes all the  error  messages  that  are 
  992.      generated and the format of each one.  
  993.  
  994.  
  995.  
  996.  
  997.      1 >TOOLONGLABEL .$P PROCESS BOX
  998.      LABEL EXCEEDED MAXIMUM LENGTH OF TEN CHARACTERS
  999.  
  1000.        This  message is displayed if the label starting in column one or 
  1001.        the label in the comment field of the .$S,  .$W,  or .$I commands 
  1002.        exceed  the  maximum  length  of  10  characters.  The first line 
  1003.        displays the line number where the error occurred and  the  label 
  1004.        in error.  
  1005.  
  1006.  
  1007.      2 >COMMENT TOO LONG FOR TEST SYMBOL      
  1008.      COMMENT TOO LONG FOR SPECIFIED FLOWCHART COMMAND
  1009.  
  1010.        This  message is displayed if the comment will not fit within the 
  1011.        specified symbol.  In the above example the comment supplied will 
  1012.        not fit inside the test symbol which can only hold a maximum of 3 
  1013.        lines  of  8 characters.  The first line displays the line number 
  1014.        and the line where the error was detected.  
  1015.  
  1016.  
  1017.      3 >ENTER   .$H TITLE TOO LONG.....
  1018.      TITLE EXCEEDED MAXIMUM LENGTH OF 90 CHARACTERS
  1019.  
  1020.        This message is displayed if the comment for the .$H  command  is 
  1021.        longer  than  90  characters.  The  first  line displays the line 
  1022.        number and the line where the error was detected.  
  1023.      
  1024.      
  1025.      4 >        .$M MESSAGE TOO LONG
  1026.      MESSAGE EXCEEDED MAXIMUM LENGTH
  1027.  
  1028.        This message is displayed if the comment for the .$M  command  is 
  1029.        longer  than  10  characters.  The  first  line displays the line 
  1030.        number and the line where the error was detected.  
  1031.      
  1032.   
  1033.                                                                     4-2
  1034.  
  1035.  
  1036.      5 >        .$M MESSAGE TOO LONG
  1037.      EXCEEDED MAXIMUM MESSAGE COUNT
  1038.  
  1039.        This message is  displayed  if  more  than  10  sequential  .$M 
  1040.        commands  are found are found in the flowchart file.  The first 
  1041.        line displays the line number and the line where the error  was 
  1042.        detected.  
  1043.      
  1044.      
  1045.      6 >        .$F ILLEGAL FLOWCHART COMMAND
  1046.      ILLEGAL FLOWCHART COMMAND 
  1047.      
  1048.        This  message  is  displayed  if  an illegal flowchart command is 
  1049.        found in the flowchart file.  The first line  displays  the  line 
  1050.        number and the line where the error was detected.  
  1051.      
  1052.      
  1053.      
  1054.      7 > DUPLABEL 
  1055.      DUPLICATE LABEL
  1056.      
  1057.        This  message  is  displayed  if  a the label on the current line 
  1058.        appeared  elsewhere  in  the  same  flowchart.   The  first  line 
  1059.        displays  the  line  number  and  the  line  where  the error was 
  1060.        detected.  
  1061.      
  1062.         
  1063.         
  1064.      8 >LABLE
  1065.      LABEL NOT FOUND IN THIS FLOWCHART FILE
  1066.      
  1067.        This message is displayed if a the destination label (END) on the 
  1068.        current line cannot be found in this flowchart  file.  The  first 
  1069.        line  displays  the  line number and the line where the error was 
  1070.        detected.  
  1071.      
  1072.         
  1073.      9 >         .$J END
  1074.      WARNING--LABEL NOT FOUND IN THIS FLOWCHART BUT DOES APPEAR IN 
  1075.      ANOTHER
  1076.      
  1077.        This message is displayed if a the destination label (END) on the 
  1078.        current line cannot be found in this  flowchart  but  did  appear 
  1079.        elsewhere  in  this  flowchart file.  The first line displays the 
  1080.        line number and the line where the error was detected.  
  1081.      
  1082.    
  1083.                                                                     4-3
  1084.  
  1085.         
  1086.      10 >        .$P PROCESS   
  1087.      UNABLE TO REACH THIS FLOWCHART COMMAND
  1088.      
  1089.        This message is  displayed  if  a  the  current  line  cannot  be 
  1090.        reached.  
  1091.         
  1092.        Example:
  1093.        
  1094.                  .$J NEXT
  1095.                  .$P PROCESS
  1096.        NEXT      .$S SUBROUTINE
  1097.         
  1098.        In the above example the .$P command cannot be reached because no 
  1099.        label  was  specified  and the previous command jumped around it.  
  1100.        The first line displays the line number and the  line  where  the 
  1101.        error was detected.  
  1102.      
  1103.         
  1104.       
  1105.      11 >        .$P PROCESS   
  1106.      COMMENT EXPECTED TO BE CONTINUED ON THIS LINE
  1107.         
  1108.        This  message  is  displayed  if the previous lines comment field 
  1109.        ended with a (;) indicating the comment continued  on  this  line 
  1110.        and  this  line did not contain a (.$) in the command field.  The 
  1111.        first line displays the line number and the line where the  error 
  1112.        was detected.  
  1113.      
  1114.         
  1115.         
  1116.      12 >        .$T2, TEST SYMBOL   
  1117.      BRANCH COUNT FOLLOWING .$T COMMAND IN ERROR
  1118.  
  1119.        This  message is displayed if an error was detected in the branch 
  1120.        count following the (.$T) command.  The first line  displays  the 
  1121.        line number and the line where the error was detected.  
  1122.      
  1123.         
  1124.         
  1125.         
  1126.      13  >  .$A  ALT1,BRANCH1  ALT2  ALT3  ALT4  
  1127.      MORE THAN 2 ALTERNATIVES SPECIFIED WITHOUT LABELS FOR PREVIOUS TEST 
  1128.      SYMBOL
  1129.      
  1130.        This  message  is  displayed  if  the previous test command (.$T) 
  1131.        specified more than 2  branches  and  the  following  alternative 
  1132.        command  (.$A) specified more than 2 alternatives without labels.  
  1133.        The first line displays the line number and the  line  where  the 
  1134.        error was detected.  
  1135.         
  1136.     
  1137.                                                                     4-4
  1138.  
  1139.         
  1140.      14 >        .$A ALT1,BRANCH1 ALT2  
  1141.      NO TEST COMMAND SPECIFIED FOR THIS ALTERNATE
  1142.      
  1143.        This  message  is displayed if the previous flowchart command was 
  1144.        not a test (.$T).  The first line displays the  line  number  and 
  1145.        the command line where the error was detected.  
  1146.        
  1147.         
  1148.         
  1149.         
  1150.         
  1151.      15 >        .$A ALT1,BRANCH1 ALT2  
  1152.      ALTERNATE EXPECTED
  1153.      
  1154.        This  message  is  displayed  if  the previous test command (.$T) 
  1155.        specified more than 2  branches  and  the  following  alternative 
  1156.        command  (.$A)  did  not specify an equal number.  The first line 
  1157.        displays the line number and the command line where the error was 
  1158.        detected.  
  1159.        
  1160.         
  1161.         
  1162.      16 >LONGALT 
  1163.      ALTERNATE EXCEEDED MAXIMUM OF 6 CHARACTERS
  1164.  
  1165.        This message is displayed if the alternative  specified  contains 
  1166.        more  than  six  characters.  The  first  line  displays the line 
  1167.        number and the command line where the error was detected.  
  1168.         
  1169.  
  1170.  
  1171.      17 >        .$XM 0,0,0,0
  1172.      SET MARGIN COMMAND ILLEGAL IF NOT AT BEGINNING OF FILE
  1173.  
  1174.        This message is displayed if the .$XM command was found after the 
  1175.        first .$H command in the file.  
  1176.  
  1177.  
  1178.  
  1179.  
  1180.  
  1181.  
  1182.  
  1183.  
  1184.  
  1185.  
  1186.  
  1187.  
  1188.  
  1189.  
  1190.  
  1191.  
  1192.  
  1193.  
  1194.  
  1195.