home *** CD-ROM | disk | FTP | other *** search
/ Phoenix CD 2.0 / Phoenix_CD.cdr / 02a / pdflow.zip / FLOW.DOC next >
Text File  |  1986-12-01  |  5KB  |  125 lines
  1. L---+---T1----+-T--2----T----3--T-+----4T---+---T5----+-T--6----+----J----+----
  2. .H:
  3. .H:                          FLOW Chart Utility             Page $$$
  4. .X:5
  5.  
  6.     This document describes the use of the FLOW utility as implemented 
  7. on  the PC.   The reason for the development of this utility  was  the 
  8. unavailability  of  any  package which could create  flow  charts  for 
  9. programming  in the standard formats.   I  have attempted to provide a 
  10. utility  which  will  create flowcharts for programmers  from  a  file 
  11. composed of commands describing the logic to be diagrammed.  There are 
  12. only  a few commands in the repertoire at this time and the intent  is 
  13. to  provide  a easy to use program without a lot of learning  required 
  14. before it can be used. 
  15.  
  16.     To  use  this program,  the following format is to be used to  get 
  17. started. 
  18.  
  19.     FLOW <options> command-file <-o(output file)>
  20.  
  21.     where:
  22.  
  23.         The  options  field  is optional.  It provides  the  following 
  24.         capabilities: 
  25.  
  26.         l option - this option directs the program to create a listing 
  27.         of the commands on the output device. 
  28.  
  29.         n  option  - this option directs the program to  suppress  the 
  30.         initial  form feed character when writing the flow diagram  to 
  31.         the output device. 
  32.  
  33.         o  option - this option,  when it immediately follows the  "-" 
  34.         option indicator,  directs the program to begin looking in the 
  35.         next character of the command line for the name of the  output 
  36.         file.  This is an optional field.  If it is not present,   the 
  37.         program assigns the output device to the console screen. 
  38.  
  39.         p option - this option specifys that the default output device 
  40.         is  to  be  PRN rather than CON.  It has no meaning if  the  o 
  41.         option is specified. 
  42.  
  43.         The command file is a text file of commands for this  utility. 
  44.         This  file can be created by any text editor available  within 
  45.         your system. 
  46.  
  47.     Command format:
  48.  
  49.         This program expects the commands to be in a specific format. 
  50.     The  general form of the commands is as follows with each  command 
  51.     contained within one string of 77 characters or less. 
  52.  
  53.         Command id. The first character of the string determines the 
  54.     type  of  command  being processed.  There are  only  two  formats 
  55.     available  at  this time,  Label or logic  command.   The  program 
  56.     differentiates  between the two based on the first character.   If 
  57.     the  character  is  a "$",  the remainder of the line is  a  logic 
  58.     command. All other input is considered to be a label command. 
  59.  
  60.         Label fields. Label commands start in column 1 and may be up 
  61.     to  8 characters in length.  They are intended to provide a  means 
  62.     for linking various sections of logic together. 
  63.  
  64.         Logic commands. There are only 7 types of commands recognized. 
  65.     These type are as follows: 
  66.  
  67.         H - This command indicates that this is the start of a section     
  68.         of logic. 
  69.  
  70.         E - This command indicates the end of a section of logic.
  71.  
  72.         W  -  This command provides for the description of work  being    
  73.         done at this point in the logic flow. 
  74.  
  75.         P  - This command provides for the calling of a common routine 
  76.         or function to accomplish the logic function required at  this 
  77.         point within the logic flow. 
  78. 
  79.         T  -  This  command provides for testing  the  results  of  an 
  80.         operation  or  other condition in order to control  the  logic 
  81.         flow. 
  82.  
  83.         A - This command provides a means for specifying the resulting 
  84.         action  to  be taken for the condition tested.   This  command 
  85.         must  immediately  follow a T command or it is ignored.   This 
  86.         command requires a strict format in order for it to work. This 
  87.         program expects only two possible answers to any test.   Those 
  88.         answers  are yes and no.   In order to specify the  course  of 
  89.         action to be taken, the user must enter these in the format of 
  90.         "yes:  "  or "no:  ".  These answers are then followed by  the 
  91.         label  of the command to which logic is to branch.  Either  or 
  92.         both may be used without regard to case. 
  93.  
  94.     The  following pages of this document provide and example  of  how 
  95. the commands are used and the results of those commands. 
  96. .hq:
  97.  
  98. 
  99. $h entry
  100. label
  101. $t test line 1
  102. $a yes: label1
  103. labela
  104. $p test line 2 is longer and uses two lines
  105. $j label2
  106. label1
  107. $w test line three is still longer yet than the other lines were
  108. $w test line 4
  109. $p call test procedure
  110. $t check it out
  111. $a yes: label1 no: labela
  112. label2
  113. $w test another line
  114. $p again we check it 
  115. $w another line
  116. $w another line
  117. $w another line
  118. $w another line
  119. $w another line
  120. $w another line
  121. $w another line
  122. $w this is the end
  123. $e
  124. 
  125.