home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / PASCAL / T_REF.ZIP / T-REFCH6.DOC < prev    next >
Encoding:
Text File  |  1987-01-15  |  11.7 KB  |  265 lines
  1.  
  2.  
  3.  
  4.                      Chapter VI - A Step by Step Tutorial
  5.  
  6.      This  chapter  is  meant  to  assist in  familiarizing  you  with  T-Ref.
  7. However,  before  running  T-Ref,  it is a good idea to make  several  back-up
  8. copies of the program first.   The program is not copy protected,  so  copying
  9. the  program  simply  requires a "COPY *.* s:  t:" command where 's:'  is  the
  10. source  drive  the enclosed diskette is on and 't:' is the  target  drive  the
  11. blank  formatted  diskette is on.   The diskette contains an AUTOEXEC file  to
  12. boot  T-Ref  from power up.   (You must of course supply the Operating  System
  13. command file "COMMAND.COM").
  14.      Once  you  have backed T-Ref to another diskette,  load the new  diskette
  15. into the default drive and type 'T-REF'.  (It is a good idea to always use the
  16. newly  created diskette and save the original diskette as an  archived  copy.)
  17. The program will load and the main screen (see page 2) will appear.   Note the
  18. block cursor is at the 'Active Directory' field, which is presently blank.
  19.  
  20.  
  21. Cursor Movement:
  22.  
  23.      The  first step in learning how T-Ref works is to learn how to  move  the
  24. block cursor about the screen.   This is easy to do since T-Ref uses the arrow
  25. keys  located  on  the numeric keypad area (the  up,  down,  left,  and  right
  26. arrows).   Strike  the  down arrow several times to see how the  block  cursor
  27. moves down the screen from field to field.   Notice that when the block cursor
  28. is at the 'Active Output File' field and the down arrow is struck,  the  block
  29. cursor  moves  to the 'Source Listing' field,  and from there to the  'Reserve
  30. Words' field.  The block cursor will continue down the left side of the screen
  31. to  the 'Begin Scanning' field and when the down arrow is struck  again,  will
  32. "wrap"  back around to the 'Active Directory' field.   The up  arrow  performs
  33. just the reverse: the block cursor moves up one field at a time along the left
  34. fields of the screen.
  35.      The left and right arrows move the cursor left and right.  Therefore, on
  36. lines where only one field exists,  the block cursor does not move.   Only the
  37. lines  that  two  or three fields exist are affected by  the  left  and  right
  38. arrows.  Try these keys on several lines of the screen.
  39.      The  Home  key  will send the block cursor  immediately  to  the  'Active
  40. Directory' field,  no matter where it is on the screen.  Move the block cursor
  41. to  somewhere  else on the screen and strike the Home key.   The End key  will
  42. send the block cursor to the 'Begin Parsing' field, which is the last field at
  43. the bottom of the screen.
  44.  
  45. Pop-Up Help Windows:
  46.  
  47.      Next,  strike the F1 function key.  Notice the window that appears in the
  48. middle of the screen.   The information within the window is a description  of
  49. what each of the function keys (F1 - F10) do.  Strike any key to exit.
  50.      The F2 function key is the other help key.   The information that appears
  51. within the window depends upon the block cursor's location.   Strike the  Home
  52. key  to move the block cursor to the 'Active Directory' field and then  strike
  53. the  F2  function key.   Notice that the information provided about the  field
  54. includes what the field is for and what are valid inputs for the field.   Move
  55. the  block cursor about the screen and try the F2 function key at  each  loca-
  56. tion.
  57.  
  58.  
  59.  
  60.  
  61.                                21
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. Exiting the program:
  71.  
  72.      The  ESC key is used to exit the program.   Strike the ESC key now.   The
  73. question  that  is  appearing  now on the screen insures you  don't  exit  the
  74. program when the ESC key is struck by mistake.   Type 'N' for now to return to
  75. the program.  When you are ready to exit the program, you need only strike the
  76. ESC key and respond 'Y' to this question.
  77.  
  78.  
  79.  
  80. A demonstration program:
  81.  
  82.      The   package   enclosed  includes   a  sample  Pascal   program   called
  83. 'PRINTDOC.PAS'.   The  program is provided to demonstrate some of the capabil-
  84. ities of T-Ref.   Move the block cursor to the 'Active Input' field.  Type the
  85. name  'PRINTDOC'  and hit return.  (Remember,  the file  extension  ".PAS"  is
  86. assumed.)  Notice that while you are typing the name of the file, the blinking
  87. cursor  is within the block cursor located at the 'Input File' field.  If  you
  88. make  a mistake typing the name 'PRINTDOC',  strike the left arrow to back the
  89. blinking cursor up within the block cursor.   Notice that when you hit return,
  90. the blinking cursor moves back to the end of the bottom line on the screen.
  91.      After you have entered the name of the input file,  move the block cursor
  92. to the 'Active Output File' field and again type 'PRINTDOC'.  This is the name
  93. of  the file the output source will be sent to.  (Since a file name  extension
  94. was not specified, "PRT" is assumed.)   Like the input file name,  the default
  95. disk  drive  and default directory will be used since the  'Active  Directory'
  96. field is blank; therefore, the output file 'PRINTDOC.PRT' will be found on the
  97. same diskette as the input file.
  98.  
  99. Activating the Source Listing and Cross Reference:
  100.  
  101.      For  the purpose of this demonstration,  run both the Source Listing  and
  102. Cross  Reference  Listing.   Set  the 'Source Listing' field  and  the  'Cross
  103. Reference' field to "On".  You may later wish to try different combinations of
  104. these and the fields that appear below these two.
  105.  
  106. Setting the Source Listing fields:
  107.  
  108.      The  program  that  is to be read ("PRINTDOC") has been set so  that  all
  109. letters  are in lower case format.   Set the 'Reserve Words' field to  "Upper"
  110. and the 'Identifiers' field to "Forml" so that you can observe the difference.
  111. If not already so,  turn the line numbering, the lexical and block levels, and
  112. the active procedures fields to "On".  The 'Header', the 'Page Numbering', and
  113. the 'Include File' fields are covered below.
  114.  
  115. Setting the Cross Reference fields:
  116.  
  117.      Assuming  you are interested in getting a cross reference of the  identi-
  118. fiers being USED, set all of the usage fields (the last or third cursor column
  119. for  the first six fields under 'Cross Reference') to "Used" and set the scope
  120. fields  (the six fields just left of the usage fields)  to  "PrgDf".   (Quick:
  121. What kind of cross reference would a "SysDf" setting give you?)  The 'Header',
  122. the 'Page Numbering', and the 'Include File' fields are covered below.
  123.  
  124.  
  125.  
  126.  
  127.                                22
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. Output Headers:
  137.  
  138.      Now  that the input and output files have been specified and the  listing
  139. parameters are set,  let's create a header for the source output and the cross
  140. reference  output  listings.   For the source output  header,  strike  the  F3
  141. function key.  The number of lines to be used for the header must be between 1
  142. and  5 (of course,  zero (0) is valid,  but that won't give you a header),  so
  143. give  it  2 lines by typing '2' and hitting enter.   Remember  that  when  the
  144. header  is  printed at the top of each page,  the program  will  automatically
  145. buffer  blank lines before and after the header,  so it is not necessary to do
  146. so within the header.
  147.      The  program has now given you a work area in which to create the header:
  148. 2 lines by 75 columns in size.   Any of the printable ASCII keys can be  typed
  149. within this area.   The arrow keys (up,  down, left, and right) can be used to
  150. position  the  cursor  where  you  wish to type  text.  These  keys  are  non-
  151. destructive,  so  data will not be lost by moving the cursor over the  top  of
  152. existing text.   Also the Home key moves the cursor to the first column of the
  153. present  line and the End key moves the cursor to the end of the present line.
  154. Notice there is a list of valid keys given at the bottom of the  window.   Try
  155. each of these keys (except <Del>) so you will become familiar with them.
  156.      Type the following in the work area:
  157.  
  158.                         Sample Heading For Source Listing
  159.                                   Print Program
  160.  
  161. When  you have completed this,  hit the ESC key.   This action  completes  the
  162. header creation process.
  163.      Now,  for  the cross reference header,  the sequence is exactly the same.
  164. Strike  the F4 function key and respond with '2' again.   Type  the  following
  165. into the work area:
  166.  
  167.                     Sample Heading for Cross Reference Listing
  168.                                   Print Program
  169.  
  170. Again, hit the ESC key to complete the header creation process.
  171.      Before  the  source listing and cross reference headers are printed  with
  172. the other information, you must make sure the 'Header' fields are set to "ON".
  173. If they are not,  move the block cursor to the 'Header' fields and strike  the
  174. space  bar until the word "ON" appears within the block cursor.   Do this  for
  175. BOTH 'Header' fields.
  176.  
  177. Paging:
  178.  
  179.      Turn  paging on for both the source listing and the cross  reference  (if
  180. not  presently  turned on) by moving the block cursor to the 'Page  Numbering'
  181. fields and striking the space bar until "ON" appears within the block cursor.
  182.  
  183. Include File processing:
  184.  
  185.      To  demonstrate the "OPT" (optional) setting on the two  'Include  Files'
  186. fields  work,  move the block cursor to the 'Include Files' field under Source
  187. Listing.   Hit the space bar until "Opt" appears within the block cursor.  Hit
  188. the  left or right arrow key to move the block cursor to the  'Include  Files'
  189. field  under  Cross Reference.   Again hit the space bar until  "Opt"  appears
  190. within the block cursor.
  191.  
  192.  
  193.                                23
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. Running the program:
  203.  
  204.      Now we are ready to run the program!   But before you do,  strike the F10
  205. key to save the present field settings.   Now,  strike the END key to move the
  206. block  cursor to the "Begin Parsing" field,  hit the space bar until the  word
  207. "YES" appears within the block cursor, and hit the Return key.
  208.      The  "Begin  Parsing" field will be replaced by
  209.  
  210.           "Now Parsing Line"
  211.  
  212. and  a  counter will count each line that is parsed.   When the  include  file
  213. compiler directive within PRINTDOC is reached,
  214.  
  215.           "Include File =  PRINTDOC.LIB"
  216.  
  217. will  appear  above the counter,  the 'Include File' field  under  the  Source
  218. Lister will flash (for color monitors), and
  219.  
  220.           "Do you wish to include this file? <Y,N>:"
  221.  
  222. will  appear below the counter.   Respond by typing "Y".   You are telling the
  223. computer to include this file in the source listing.   Again the question will
  224. appear  and  the 'Include File' field under the Cross  Referencer  will  flash
  225. (again,  for color monitors).   Respond here by typing "N" for no cross refer-
  226. ence of identifiers found within the include file.
  227.      If  you ever start the parser before you are ready,  or if you decide  to
  228. make  some changes to the output,  strike any regular key during  the  parsing
  229. process.  When the question
  230.  
  231.           "Do you wish to stop parsing?  <Y,N>:  "
  232.  
  233. appears,  respond "Y".  The files will be closed and the parser will stop.  If
  234. you accidentally strike a key during the parsing process,  respond "N" to this
  235. question.
  236.      When  the  parsing is complete,  the counter will be replaced  by
  237.  
  238.           "Cross Referencing A's"
  239.  
  240. and the alpha counter will count up through "Z".   Once completed,  the 'Begin
  241. Parsing'  field  returns  and  the line below it will signify  the  number  of
  242. identifiers  cross referenced.   You have now completed your first source  and
  243. cross reference listing.
  244.      Exit the program by striking the ESC key and responding "Y".  Enter Turbo
  245. or  any other ASCII editor to browse the file "PRINTDOC.PRT" that  resides  on
  246. your  default  drive.   You may wish to try several different combinations  of
  247. settings for the fields to become more familiar with the program and find  the
  248. settings that you best like.
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.                                24
  260.  
  261.  
  262.  
  263.  
  264.  
  265.