home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 613a.lha / AutoGraf_v2.0 / AutoGraf.doc.pp / AutoGraf.doc
Encoding:
Text File  |  1992-03-03  |  10.7 KB  |  255 lines
  1.                  AutoGraf Autolog Graphing program
  2.                          by Joel Swank
  3.                            Version 2.0
  4.                            March 1991
  5.  
  6. Quick Start:
  7.  
  8.    Two sample data files are provided so you can see what the program does.
  9. If you click the Icon, one of these is automatically loaded. You can then
  10. see the graphs and other information that are available. When you are ready
  11. to enter your own data, you can use the "Clear Data" menu item and the
  12. "Edit Data" item. When you have your own data saved in a file, you can
  13. use the "INFO" workbench utility to edit the tooltypes array in the Icon
  14. to have your file automatically loaded at startup.
  15.  
  16. Complete Instructions:
  17.  
  18.   AutoGraf allows entry and graphing of automobile gasoline purchase log.
  19. AutoGraf constructs 3 types of graphs: Cost per mile in cents per mile,
  20. Price per gallon in dollars per gallon, and fuel milage in miles per gallon.
  21. AutoGraf can be started by clicking its icon or by CLI command.
  22.   AutoGraf has a 6 item Project menu: Read File, Write File, Clear Data,
  23. About, Help, and Quit.
  24.  
  25. o Read File will request the name of a data file with a file requester and
  26.   then read the selected file into memory.
  27. o Write File will request the name of a data file with a file requester and
  28.   then write the data to the selected file.
  29. o Clear Data will erase any data currently in memory.
  30. o About gives version information.
  31. o Help displays a portion of this text.
  32. o Quit ends the program. You can also quit using the close gadget on the
  33.   main window.
  34.  
  35.   AutoGraph also has a 6 item Action menu: Edit Data, Graph MPG, Graph $/MI,
  36. Graph $/Gal, Averages, List Data, and Print Window.
  37.  
  38. o Edit Data will allow you to enter and modify the data. See edit window
  39.   below.
  40. o Graph MPG draws a graph of fuel milage versus time.
  41. o Graph $/MI draws a graph of cost per mile for fuel versus time.
  42. o Graph $/GAL draws a graph of cost fuel versus time.
  43. o Averages displays a set of averages for all the selected data.
  44. o List Data prints a formatted list of the data file on the printer. The
  45.   current preferences printer settings are used.
  46. o Print Window does a graphics dump of the contents of the main window
  47.   to the printer.
  48.  
  49.   AutoGraph also has a 3 item options menu: Select Years, Metric, and
  50. English.
  51.  
  52. o Select years allows you to select a subset of the data to be graphed or
  53.   averaged. Years can be entered as 2 digits (0-99) meaning 1900-1999,
  54.   or as full 4 digit numbers. years between 1900 and 2199 are allowed.
  55. o Metric and English are mutually exclusive options that select the units
  56.   to be used for the data. When in Metric Gallons and miles become Liters
  57.   and kilometers. If there is data in memory when you select one of these
  58.   options, you will be given the option of converting the data. The
  59.   odometer reading, gallons/liters, and the price will be converted.
  60.   Autograf cannot detect whether a data file is metric or english. By
  61.   default it starts in English mode. If you are using metric data, you
  62.   can have it start in metric mode by setting the METRIC= tooltype in
  63.   the Icon, or using the -m CLI flag.
  64.  
  65.   The graphs display a running average of the most recent 10 transactions.
  66. When a graph is on the screen, the mouse can be used to display the numeric
  67. value of any point on the graph. Click the 'DONE' gadget or the close window
  68. gadget to erase the graph and return to the main menu.
  69.  
  70.   The edit window allows you to enter, modify and delete records in memory.
  71. Each record has 5 items of data.
  72.   The date of the transaction is used to annotate the X axis of the graph.
  73. The date may be entered in a variety of formats. Some examples: mm-dd-yy,
  74. MMM dd yyyy, mm/dd/yy. 'mm' is the numeric month fron 1 to 12. 'MMM' is the
  75. character month, the first three letters of the month. 'dd' is the numeric
  76. day of the month from 1 to 31. 'yy' and 'yyyy' are the year. If only 2
  77. digits are specified, 1900 is added to the year. Combination formats like
  78. MMM/dd yyyy are also OK.
  79.   The odometer reading is the reading of the vehicles odometer at the time
  80. of the transaction. You may enter up to 999999.9 for the odometer reading.
  81. The decimal point and tenths are optional.
  82.   The Gallons, Price and Dollars define the ammount of the purchase. Any
  83. two of these may be entered and the third will be calculated. If you enter
  84. all three and the values don't match, Price and Dollars will take
  85. precedence, since they are the most likely to be accurate.
  86.   Gallons may be entered with one or zero decimal places. Price is in
  87. dollars per gallon and may be entered with 3 decimal places. Dollars is
  88. the total cost of the transaction and may be entered with 2 decimal places.
  89.  
  90.   The Enter gadget will enter the current data into memory if it is correct.
  91. If an error in the data is detected, you will be informed with a requester.
  92. The odometer reading is the key of the data. It will determine the order
  93. of the records. If you enter an odometer reading identical to one already
  94. in the data, the old record will be replaced. If you have a record with
  95. an incorrect odometer reading in the data, you will have to first delete
  96. it with the Delete gadget and then enter the corrected data. Pressing
  97. RETURN after typing data in a string gadget will take the cursor to the
  98. next string gadget if the entered data is correct. Pressing RETURN in the
  99. last string gadget (Dollars) will automatically enter the current data
  100. if it is all correct.
  101.   The Clear gadget may be used to erase all data from the string gadgets.
  102. It does not affect any data currently in memory.
  103.   The arrow gadgets at the bottom of the window can be used to scan through
  104. the data. One click moves up or down one record. Holding down the left
  105. button over one of these gadgets will roll through the data records.
  106.   The Top gadget will move to the first record and the Bottom gadget will
  107. move to the last record.
  108.  
  109.   AutoGraf accepts 3 parameters at startup. They may be entered as flags
  110. on the command line, or as tooltypes in the ICON. The command line options
  111. are:
  112.    >autograf [-r#] [-m] [file]
  113.  
  114.    -r#    The roll speed in the edit window. 1 to 5 are allowed. 2 is the
  115.           default.
  116.    -m     Selects metric mode. English is the default.
  117.    file   Is the name of a data file to be read at startup.
  118.  
  119. The Tooltypes are:
  120.  
  121.    ROLL=#    The roll speed.
  122.    METRIC=   Select metric mode.
  123.    FILE=file The file to be read at startup.
  124.  
  125.   All must be entered in upper case. The '=' is required.
  126.  
  127.   Two sample data files are provided: 84olds, and 77pont.
  128.  
  129.  
  130.              Error messages in Alphabetical Order
  131.  
  132.     Most error messages appear in requesters. A few appear highlited in
  133.     the window. Most are information only, so you just click "OK" after
  134.     you have read them. A few give you an option which is explained below.
  135.  
  136. All data in Memory will be Cleared:  ARE YOU SURE?
  137.   This message is to verify that you want to erase all data from memory.
  138.   Click "Yes" to clear data, "Cancel" to preserve the data.
  139.  
  140. Do You Wish to Convert the Data to English?
  141.   If you select the "English" option with data in memory you will get this
  142.   message. Click "YES" to convert, "NO" to skip the conversion.
  143.  
  144. Do You Wish to Convert the Data to Metric?
  145.   If you select the "Metric" option with data in memory you will get this
  146.   message. Click "YES" to convert, "NO" to skip the conversion.
  147.  
  148. Edit Window Failed to Open
  149.   Cannot open the edit window. Most likely reason is lack of memory.
  150.   If you have any other applications running, close them and try again.
  151.  
  152. End less than Start
  153.   You have entered a range of years that is invaled. The ending year must
  154.   be greater than or equal to the start year.
  155.  
  156. I/O error reading directory
  157.   The file requester has encountered an error on the disk.
  158.  
  159. Invalid Date Specified
  160.   The format of the date you entered in the Date gadget is invalid.
  161.   See the text for valid date formats.
  162.  
  163. Invalid End Year
  164.   The end year entered is invalid. Years between 0 and 99 are accepted as
  165.   1900 to 1999. Years betweem 1900 and 2199 are also accepted.
  166.  
  167. Invalid Float Specified
  168.   An invalid floating point number was entered. A floating point number
  169.   may have any number of digits and one decimal point with no spaces.
  170.   Scientific notation is not allowed.
  171.  
  172. Invalid Start Year
  173.   The start year entered is invalid. Years between 0 and 99 are accepted as
  174.   1900 to 1999. Years betweem 1900 and 2199 are also accepted.
  175.  
  176. Modified Data not saved Exit anyway, or Cancel?
  177.   If you modify data using the edit window and try to exit AutoGraf before
  178.   writing the data to a file you will get this message. If you want to save
  179.   the data, click "Cancel" and use the "Write File" menu item to save it.
  180.   If you do not want to save the data just click "Exit".
  181.  
  182. No data selected - check options
  183.   Some operations cannot proceed with out sufficient data. To graph, at
  184.   least 2 records are required. If you are sure that there are records in
  185.   memory, check the "Select Years" option to be sure that there is data
  186.   that matches the year range specified.
  187.  
  188. Odometer Reading not Specified
  189.   An odometer reading must be entered before a record can be stored in
  190.   memory.
  191.  
  192. Out of Data Space: Maximum of 1000 records allowed
  193.    You have tried to enter the 1001th record. Sorry only 1000 are allowed.
  194.  
  195. Out of Memory
  196.   An operation cannot proceed for lack of memory. If you have any other
  197.   applications running, close them and try again.
  198.  
  199. Printer Error Encountered
  200.   An error has occured while listing data on the printer. Check the printer
  201.   and try the operation again.
  202.  
  203. Printer failed to open
  204.   An error has occured while opening the printer device. Check the printer
  205.   and try the operation again.
  206.  
  207. Ready Paper in Printer
  208.   This message occurs when you list the data file, and single sheet mode is
  209.   selected in preferences. AutoGraf pauses with this message before every
  210.   page.
  211.  
  212. Two of the following must be Specified: Price, Gallons, Dollars
  213.   To enter a record into memory at least two of the above must be entered
  214.   in the gadgets. The third will be calculated.
  215.  
  216. Unable to find requested path
  217.   The file requester has attempted to log a path that does not exist.
  218.  
  219. Window failed to open
  220.   Cannot open A window. Most likely reason is lack of memory.
  221.   If you have any other applications running, close them and try again.
  222.  
  223. Year Out of Numerical order
  224.   The records in memory must have the year of the date in numerical order.
  225.   You have probably entered a date incorrectly.
  226.  
  227.  
  228.  
  229. Format of the Data file:
  230.  
  231.   Individual fields separated by commas.
  232.  
  233.    * date - character format - MMM DD YYYY
  234.    * odometer reading - 999999.9
  235.    * price per gallon - $9.999
  236.    * Total cost of purchase - $9999.99
  237.    * gallons - 999.9
  238.  
  239.  
  240.  
  241.  
  242.  
  243. Registration:
  244.  
  245.   You can register AutoGraf by sending $10 to the address below.
  246. Registration makes you eligible for automatic update with any future
  247. versions and guaranteed response to any bug reports.
  248.  
  249. Send bugs, complaints, accolades, and registration to:
  250.  
  251. Joel Swank
  252. 205 NW Meadow Dr.
  253. Beaverton, OR 97006
  254. (503) 641-6203
  255.