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