home *** CD-ROM | disk | FTP | other *** search
/ Programmer 7500 / MAX_PROGRAMMERS.iso / INFO / BASIC / CROSSBAS.ZIP / CROSSREF.DOC < prev    next >
Encoding:
Text File  |  1982-11-18  |  15.1 KB  |  564 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                             Computerenergy's CROSSREF
  9.  
  10.                              Cross Reference Utility
  11.  
  12.  
  13.  
  14.  
  15.  
  16.  
  17.                                    Version 1.0
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.  
  31.  
  32.  
  33.  
  34.  
  35.  
  36.  
  37.  
  38.  
  39.  
  40.  
  41.  
  42.  
  43.  
  44.                                Proprietary Notice
  45.  
  46. CROSSREF is  a  proprietary   product  developed  by  Richard  C.    Bemis  and
  47. distributed by Computerenergy Corporation, Denver, Colorado.  
  48.  
  49. Copyright 1982 by Richard C.  Bemis and Computerenergy Corporation.  All rights
  50. reserved except those expressly granted to the user within this document.  
  51.  
  52. Computerenergy Corporation,  PO  Box  6267,  Denver,  CO  80206  (303) 233-9118
  53. Source: ST6070 
  54.  
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.                                       - i -
  62.  
  63.  
  64.                                 TABLE OF CONTENTS
  65.  
  66. Section                                                                    Page
  67.  
  68.  
  69.  
  70. CHAPTER 1  CROSSREF DISTRIBUTION NOTICE ...................................   1
  71.  
  72. CHAPTER 2  INTRODUCTION ...................................................   2
  73.  
  74. CHAPTER 3  SYSTEM SETUP ...................................................   3
  75.    3.1  Copying CROSSREF ..................................................   3
  76.    3.2  Program Setup - Final Installation ................................   3
  77.  
  78. CHAPTER 4  OPERATION ......................................................   4
  79.    4.1  Execution .........................................................   4
  80.    4.2  Entering Responses ................................................   4
  81.    4.3  Maillist/Donation Assistance ......................................   4
  82.    4.4  Program Entry .....................................................   4
  83.  
  84. CHAPTER 5  OTHER INFORMATION ..............................................   6
  85.    5.1  Distribution Disk Contents ........................................   6
  86.    5.2  System Requirements ...............................................   6
  87.    5.3  Disclaimer ........................................................   6
  88.  
  89. CHAPTER 6  SUGGESTIONS, FEEDBACK, AND BUG REPORTS .........................   7
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123. CROSSREF                             - ii -          Computerenergy Corporation
  124.  
  125.  
  126.                                     CHAPTER 1
  127.  
  128.                           CROSSREF DISTRIBUTION NOTICE
  129.  
  130. CROSSREF is being  distributed using the "Freeware"* approach.  To those of you
  131. unfamiliar with  this  approach, it  works like  this.   You may send either  a
  132. preformatted  single-sided  disk (or  a prepaid  contribution  for our disk and
  133. mailer) to  us with a prepaid return mailer and we will send a complete copy of
  134. the product.   If the product does not meet your needs, please pay nothing.  If
  135. the product  does meet your needs, and you can use it, then we would appreciate
  136. a  contribution of  whatever  you  feel  is  appropriate.  Naturally,  we  have
  137. probably given  you  a clue  in several  places  as to what is  our "completely
  138. unprejudiced opinion" of an appropriate contribution amount.  Contributions are
  139. completely voluntary and much encouraged.  
  140.  
  141. Even if you  do not  contribute, you are encouraged to  copy and distribute the
  142. product freely subject to the following restrictions: 
  143.  
  144.      1. Do not  distribute altered copies.  Note: You may distribute a separate
  145.         set of modifications  to merge in if you  wish but they must be clearly
  146.         identified  as  not originating  from Computerenergy.   If  you do make
  147.         modifications, we  would like to see what you've done, if possible, for
  148.         future versions.  
  149.  
  150.      2. The  product  is to  be distributed  as  a complete "distribution copy"
  151.         produced  by the  copy  utility  provided  with  the product  for  this
  152.         purpose.  
  153.  
  154.      3. No fee is to be charged for copying or distributing the program without
  155.         an express written agreement with Computerenergy Corporation.  
  156.  
  157.      4. Commercial  sale of  this product  in any manner is prohibited  without
  158.         Computerenergy's  written  permission.  Some  products will be released
  159.         with this permission automatically given and expressly stated.  
  160.  
  161. User Groups/Clubs:  Computerenergy's  freeware  products may  be distributed by
  162. Clubs and User Groups subject to the same restrictions.  We would ask only that
  163. contributions to  our continuing efforts be encouraged by those performing such
  164. distribution.  
  165.  
  166. Computer Bulletin Boards: Computerenergy's freeware products may be distributed
  167. by  BBS's  subject  to the  same restrictions  and  contribution encouragement.
  168. However, as the products tend to be large and consist of several files, we have
  169. some concern as to the reliability of transmissions and length of connect time.
  170. Perhaps disks could be mailed or just the documentation placed on the board for
  171. browsers.  
  172.  
  173.  
  174. * The  Freeware concept  was initially  developed by Andrew Fluegelman and  the
  175. term  "FREEWARE"  is a  trademark of  The Headlands Press, Inc.  The  Headlands
  176. Press provides  a catalog of information about Freeware products available from
  177. multiple sources.   They may  be contacted at PO Box  862, Tiburon, CA 94920 or
  178. Source: TCP204 or Compuserve: 71435,1235.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185. CROSSREF                             - 1 -           Computerenergy Corporation
  186.  
  187.  
  188.                                     CHAPTER 2
  189.  
  190.                                   INTRODUCTION
  191.  
  192.  
  193. Computerenergy's Cross   Reference   was   created  to   make  programming  and
  194. maintenance jobs  easier.   We  feel  that  a computer  should  help as much as
  195. possible in  its own  development efforts.  CROSSREF is a  tool that produces a
  196. cross-reference  for  each reference  to a  variable or a line number  within a
  197. program.  
  198.  
  199.  
  200.  
  201. After you have  setup the  system and read the Operation  chapter, we recommend
  202. that you  try  CROSSREF  on some  of your  own  programs.  If you are  going to
  203. "wing-it"  without   reading  further,  then  SAVE  the  Basic  program  to  be
  204. cross-referenced in  ASCII (true  wingers understand this), type CROSSREF,  and
  205. good luck!  
  206.  
  207.  
  208.  
  209.  
  210.  
  211.  
  212.  
  213.  
  214.  
  215.  
  216.  
  217.  
  218.  
  219.  
  220.  
  221.  
  222.  
  223.  
  224.  
  225.  
  226.  
  227.  
  228.  
  229.  
  230.  
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247. CROSSREF                             - 2 -           Computerenergy Corporation
  248.  
  249.  
  250.                                     CHAPTER 3
  251.  
  252.                                   SYSTEM SETUP
  253.  
  254.  
  255. The Cross  Reference  distribution disk  contains a  version  of the program in
  256. compiled  formats  along  with its  Syntax file.   Compiled  versions are being
  257. distributed as they execute much faster.  
  258.  
  259. 3.1  Copying CROSSREF
  260.  
  261.      There is a batch file which copies the entire distribution disk for backup
  262.      or distribution purposes.  We highly recommend making a backup copy before
  263.      proceeding as it is safer and the mails can be slow.  
  264.  
  265.      Place the Cross  Reference distribution  disk in Drive A: and  a formatted
  266.      disk without  DOS on it in Drive B:.  While in DOS, type CRCOPY and follow
  267.      any instructions.  
  268.  
  269. 3.2  Program Setup - Final Installation
  270.  
  271.      We recommend that a  copy of CROSSREF and its  control file, CROSSWDS.DAT,
  272.      be placed  on a Basic Program Development DOS System disk if possible.  If
  273.      this is  your first  run-through, do not perform this  step yet - use your
  274.      copy of the distribution disk and proceed to the Operation Chapter.  
  275.  
  276.      1. Copy CROSSREF.EXE to the System disk.  
  277.  
  278.              A Sample COPY command might be:
  279.  
  280.                             COPY B:CROSSREF.EXE A:
  281.  
  282.      2. Copy  the CROSSWDS.DAT  file  to  the  same  disk.  This  file  must be
  283.         available any time CROSSREF program is used.  
  284.  
  285.              A sample COPY command might be:
  286.  
  287.                             COPY B:CROSSWDS.DAT A:
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309. CROSSREF                             - 3 -           Computerenergy Corporation
  310.  
  311.  
  312.                                     CHAPTER 4
  313.  
  314.                                     OPERATION
  315.  
  316. 4.1  Execution
  317.  
  318.      Starting Cross  Reference is  simply a  matter of entering DOS and  typing
  319.      CROSSREF followed by the Enter key.  
  320.  
  321. 4.2  Entering Responses
  322.  
  323.      You will quickly  notice that all input requested by Cross Reference is at
  324.      the  bottom  of  the screen,  following a  prompt,  and contained within a
  325.      "target".  We have found that a relatively constant area for data entry is
  326.      superior  to  the  more  typical  design  of  "fill-in-the-blanks"  as  it
  327.      minimizes  eye travel  and  usually  makes  for  a more  consistant  entry
  328.      process.   All  responses  are completed  by pressing  the  Enter key.  In
  329.      several prompts,  and on  the keyboard, the Enter key  is represented by a
  330.      symbol roughly similar to this: (<-').  
  331.  
  332.      In addition  to  the  normal  editing  functions provided  for inner-field
  333.      editing there are a couple of special functions available: 
  334.  
  335.                Field Erase:  Press the ESC key to erase an entry and start over
  336.                              or to change a field that has a pre-loaded value.
  337.  
  338.                Field Backup: Press the Up-Arrow to "backup" to the previous
  339.                              entry.  The current entry will be erased as you
  340.                              "backup".
  341.                              Note: You can "backup" as far as you like until
  342.                              the very beginning of the program.
  343.  
  344. 4.3  Maillist/Donation Assistance
  345.  
  346.      The first  screen you  see is  a title, information, and copyright  screen
  347.      with a "Press Enter to continue or space for Maillist/Donation assistance"
  348.      prompt.  Normally, you will press the Enter key to start CROSSREF.  If you
  349.      press the space bar, a program will run which will help you print a letter
  350.      that you  can  send  to us  to be  sure  you are placed on  our maillist -
  351.      particularly important  if you did not receive your copy directly from us.
  352.      Amazingly enough, the letter will even assist you in making a contribution
  353.      but that is not required (nice though).  
  354.  
  355.      Note: The assistance program  - CRMAIL - is contained  on the distribution
  356.      disk and  its copies but should not be copied to your DOS development disk
  357.      as it  is  large,  not required,  and a  waste  of disk space.  CRMAIL  is
  358.      chained  from CROSSREF  as it  resides on the distribution disk  or may be
  359.      executed directly from the distribution disk by typing CRMAIL.  
  360.  
  361. 4.4  Program Entry
  362.  
  363.      Up to 25 programs  may be specified to be  listed in sequence at one time.
  364.      NOTE: Each program must be previously saved in ASCII format using the ",A"
  365.      option of the Save command in Basic.  Example: 
  366.  
  367.                     SAVE "B:progname.S",A
  368.  
  369.      We use the  .S  extension  for  "Source"  to differentiate  between  Basic
  370.  
  371. CROSSREF                             - 4 -           Computerenergy Corporation
  372.  
  373.  
  374.                                                            CHAPTER 4: OPERATION
  375.  
  376.  
  377.      encoded programs  and those saved in ASCII.  This approach also provides 2
  378.      copies of  each program  as it is developed -  a sort of automatic backup.
  379.      Any program extension may be used.  
  380.  
  381.      If a program is  read by CROSSREF that has  accidentally not been saved in
  382.      ASCII, CROSSREF will display an ERR=62 message and return to DOS.  
  383.  
  384.      For each program to be listed, CROSSREF asks for 3 pieces of information -
  385.      program name, beginning  line number to start listing,  ending line number
  386.      to end listing.  Each program name may be entered without an extension and
  387.      CROSSREF will  append the a default Program Name Extension = ".S".  If the
  388.      program is entered  with an extension, then the  entered extension will be
  389.      used.  
  390.  
  391.      Each line  number field  is pre-loaded  with a default value which  may be
  392.      changed  most easily  by pressing  the ESC key and keying  a new number or
  393.      backspacing and  re-keying the  number.  The default value is  selected by
  394.      pressing the Enter key.  
  395.  
  396.  
  397.  
  398.  
  399.  
  400.  
  401.  
  402.  
  403.  
  404.  
  405.  
  406.  
  407.  
  408.  
  409.  
  410.  
  411.  
  412.  
  413.  
  414.  
  415.  
  416.  
  417.  
  418.  
  419.  
  420.  
  421.  
  422.  
  423.  
  424.  
  425.  
  426.  
  427.  
  428.  
  429.  
  430.  
  431.  
  432.  
  433. CROSSREF                             - 5 -           Computerenergy Corporation
  434.  
  435.  
  436.                                     CHAPTER 5
  437.  
  438.                                 OTHER INFORMATION
  439.  
  440. 5.1  Distribution Disk Contents
  441.  
  442.  
  443.           File Name       Description
  444.           ------------    --------------------------------------
  445.  
  446.           CROSSREF.EXE    Compiled CROSSREF
  447.           CROSSREF.DOC    Documentation
  448.           CROSSWDS.DAT    Basic Syntax File
  449.           CRMAIL.EXE      Maillist/Donation Assistance
  450.           CRCOPY.BAT      Copies Distribution Disk - both CROSSREF and MONITOR
  451.  
  452.  
  453. 5.2  System Requirements
  454.  
  455.      CROSSREF requires an IBM  PC with 64K, DOS 1.1,  and at least 1 disk drive
  456.      (2 disks highly recommended for development machines).  
  457.  
  458.  
  459. 5.3  Disclaimer
  460.  
  461.      All Computerenergy computer programs  are distributed on an "as  is" basis
  462.      without warranty.  
  463.  
  464.      Computerenergy Corporation and/or any of its program authors shall have no
  465.      liability or responsibility to customer or any other person or entity with
  466.      respect to  any liability,  loss or damage caused or  alleged to be caused
  467.      directly  or  indirectly   by  programs  distributed  in  any   manner  by
  468.      Computerenergy Corporation,  including but not limited to any interruption
  469.      of  service,  loss of  business or  anticipatory  profits or consequential
  470.      damages resulting from the use or operation of such computer programs.  
  471.  
  472.      Note: Good  data  processing  procedure dictates  that the  user  test the
  473.      program, run  and test sample sets of data, and run the system in parallel
  474.      with the  system previously in use for a period of time adequate to insure
  475.      that results of operation of the computer program are satisfactory.  
  476.  
  477.  
  478.  
  479.  
  480.  
  481.  
  482.  
  483.  
  484.  
  485.  
  486.  
  487.  
  488.  
  489.  
  490.  
  491.  
  492.  
  493.  
  494.  
  495. CROSSREF                             - 6 -           Computerenergy Corporation
  496.  
  497.  
  498.                                     CHAPTER 6
  499.  
  500.                      SUGGESTIONS, FEEDBACK, AND BUG REPORTS
  501.  
  502.      If you  can  spare  the  time,  we  would  appreciate  your  feedback  and
  503.      suggestions to  help us  to improve CROSSREF.  As an  added inducement, we
  504.      will also send  a free CROSSREF (corrected) to  the first person reporting
  505.      each bug.   Immediate family  members of Computerenergy employees are  NOT
  506.      eligible.    If   possible,   each   bug   reported   should   include   a
  507.      short-as-possible  printout  of  the reference  situation with explanatory
  508.      notes.   Our unprejudiced  judging panel  will make "Bug Awards" when  the
  509.      spirit moves them and, of course, their decisions are final.  
  510.  
  511.      We are also  aware of  some esthetic errors when operating  with the color
  512.      video interface.  Those still remaining should be corrected soon, but we'd
  513.      still like to hear about any you find.  
  514.  
  515.      Please address  correspondence  to  the address  on the  title  page.  (If
  516.      you've lost  your title page, just send us a note and we'll send you a new
  517.      one.) 
  518.  
  519.  
  520.  
  521.  
  522.  
  523.  
  524.  
  525.  
  526.  
  527.  
  528.  
  529.  
  530.  
  531.  
  532.  
  533.  
  534.  
  535.  
  536.  
  537.  
  538.  
  539.  
  540.  
  541.  
  542.  
  543.  
  544.  
  545.  
  546.  
  547.  
  548.  
  549.  
  550.  
  551.  
  552.  
  553.  
  554.  
  555.  
  556.  
  557. CROSSREF                             - 7 -           Computerenergy Corporation
  558.  
  559.  
  560. 
  561.  
  562.  
  563.  
  564.  
  565.  
  566.  
  567.  
  568.  
  569.  
  570.  
  571.  
  572.  
  573.  
  574.  
  575.  
  576.  
  577.  
  578.  
  579.  
  580.  
  581.  
  582. CROSSREF