home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 580a.lha / AGraph_v2.0 / AGraphV2.Readme.pp / AGraphV2.Readme
Encoding:
Text File  |  1991-11-29  |  17.6 KB  |  473 lines
  1.  
  2.                                   A-GRAPH V1.0
  3.                                  --------------
  4.                  Written in compiled AMOS Basic by Dave Smith
  5.                 ----------------------------------------------
  6.  
  7. PURPOSE
  8. -------
  9.  
  10. A-Graph was knocked up in the hope of a quick bit of cash... nah, on second
  11. thoughts don't type that, Louise - I need to at least pretend to be sincere.
  12.  
  13. A-Graph is the result of countless hours of selfless toil, for the sole
  14. purpose of bringing the world a cheap Amiga program to draw Bar, Line, Area
  15. and Pie charts, for reports or presentations, in a user-friendly way. Many's
  16. the time the author thoughtfully considered the question, "Shall I eat today,
  17. or continue my countless hours of selfless toil?"
  18.  
  19. The answer was always the same.
  20.  
  21. And so today, those long weeks are over. The hard disk crash is just a
  22. distant nightmare. The blown power supply and overheated CPU have been
  23. forgotten. The stunted fingers from hours of typing have been mostly
  24. repaired, in a Meccano sort of way, at the local casualty department. And
  25. here, on a disk weighing substantially more than the programmer, is his
  26. baby, the fruit of his labour, his hopefully nuclear-powered cash-magnet...
  27.  
  28. A-Graph.
  29.  
  30.  
  31. LOADING
  32. -------
  33.  
  34. From the workbench, double-click on the AGraph icon.
  35.  
  36. From the CLI or Shell, simply type "AGraph".
  37.  
  38. The program will take a few seconds to decompress, then the menu screen will
  39. be displayed.
  40.  
  41. Please note that although A-Graph does run in 512K, you will probably need to
  42. close all windows on the Workbench and make sure it is the first thing you
  43. run on boot-up. With 1 meg, such precautions are unnecessary. With half a meg,
  44. you'll probably not have enough memory to draw a pie chart in Hi-Res. Medium
  45. res will be fine though. 1 meg owners get the lot, as usual (lucky beggars).
  46.  
  47. A-Graph needs 2 other files to run, both found in the libs: drawer. These are
  48. diskfont.library and mathtrans.library. If AGraph doesn't run first time,
  49. check that these files exist. If not, simply copy them over from your
  50. workbench disk to your A-Graph disk.
  51.  
  52.  
  53. NOTE
  54. ----
  55.  
  56. This is A-Graph V2.0, an update to V1.1, which in turn was an update to V1.0.
  57. See the end of this document for update information.
  58.  
  59.  
  60. INTRODUCTION
  61. ------------
  62.  
  63. Right, I've done the interesting bit (the programming), now comes the bit
  64. every software author loves to hate - the doc file!!! (Aaaargh)
  65.  
  66. Just kidding, text files are my life.
  67.  
  68. So what does A-Graph do? Well, this may surprise you but it draws graphs.
  69. More specifically, it has the following features:
  70.  
  71.    *  Draws Bar, Line, Area and Pie charts from given data
  72.    *  Many options including change size, colour and pattern of the graph
  73.    *  Save graph as an IFF file (8-colour medium or hi-res)
  74.    *  Load and Save data
  75.    *  Works in both PAL and NTSC, with larger screen areas for both menu
  76.        and work screens with PAL (I hate programs which just give PAL users
  77.        the NTSC standard 200 lines)
  78.    *  Workbench 2.0 Look and Feel! (Well, almost)
  79.    *  Raises user-friendliness to an art form! (Ditto)
  80.    *  Works with 512K and above
  81.  
  82. Whatever your graph needs, A-Graph will cater for them. As long as they
  83. involve Bar, Line, Area and Pie charts.
  84.  
  85.  
  86. MAIN MENU
  87. ---------
  88.  
  89. On loading the program, it will take a few seconds to decompress after which
  90. you will be presented with the menu screen. This is where you set all of the
  91. parameters for the graph (the data, graph type, grid on/off etc). The larger
  92. "Draw Graph" button at lower left then allows you to view the graph. In a 
  93. minute I'll take you through the menu options one by one, but first a word on
  94. how A-Graph works.
  95.  
  96. A graph may be composed of up to six "Datasets", all of which are represented
  97. on one set of axes. A Dataset is, surprise surprise, a set of data to be
  98. represented. This data is made up of a title for the set (for instance, 
  99. "Sales 1966-1989"), some numbers, and labels for these numbers.
  100.  
  101. You can choose which Dataset to edit by clicking the left mouse button on one
  102. of the 6 small buttons near the top of the screen, labelled 1-6. Only one can
  103. be selected at any one time. All data editing operations are now carried out
  104. on the selected set - Input data, Alter Data, Print Data, Save and Load Data. 
  105. It makes absolutely no difference to the final graph which set is currently 
  106. selected - it is purely for data editing purposes.
  107.  
  108. Got that? Good! We'll move on then...
  109.  
  110.    GRAPH TYPES
  111.    -----------
  112.    Each of the six Datasets can be represented on screen in four different
  113.     ways: a Bar Graph, a Line Graph, a Pie Chart or an Area Graph.
  114.  
  115.    There are six buttons to achieve this, labelled "Dataset 1" through to 
  116.     "Dataset 6" just below the six Dataset selection buttons mentioned above. 
  117.    Clicking on one of these buttons will cycle it from "None" - no display - 
  118.     through "Bar", "Line", "Pie" and "Area". The Dataset will be displayed as 
  119.     the type you have selected.
  120.  
  121.     Just a couple of points to note here - if *any* of the Datasets are set 
  122.     to "Pie", then only that Dataset will be drawn, in the form of a Pie Chart. 
  123.     If two or more Datasets are set to Pie, then only the first one will be 
  124.     drawn. 
  125.  
  126.     Bar, Line and Area graphs are all drawn on the same axes. Area graphs
  127.     are drawn first (ie. at the back), then Bars and finally Lines. This
  128.     way, no Dataset obscures another.                                            
  129.  
  130.     Finally, if two or more Datasets are set to "Bar", then they will be
  131.     drawn as a Multibar graph - that is, one set is interleaved with 
  132.     another for easy comparison, in the form {ab ab ab}. Hard to explain, 
  133.     much easier if you just try it!
  134.  
  135.     There follows a description of each graph type, along with the options
  136.     that affect it:
  137.  
  138.     BAR  -  A vertical bar graph, drawn in the selected colour (see SET
  139.             COLORS) and pattern.
  140.             ---
  141.             Options - Large/Medium/Small, Grid On/Off
  142.  
  143.     LINE -  A straightforward line, drawn in the selected colour. Crosses
  144.             marking each point of data can be turned on or off.
  145.             ---
  146.             Options - Large/Medium/Small, Points On/Off, Grid On/Off
  147.  
  148.     PIE  -  Data is sorted into ascending order and the pie chart is drawn
  149.             based on this sorted data. Points On/Off controls the labelling
  150.             of each slice of the pie.
  151.             One quick word about pie charts - they work best with up to 10
  152.             or at the most 15 pieces of data. For a good, accurate pie chart
  153.             I would recommend you keep your data down to that level.
  154.             ---  
  155.             Options - Large/Medium/Small, Points On/Off
  156.  
  157.     AREA -  Much like a line graph, except filled with your chosen pattern
  158.             and/or colour.
  159.             ---
  160.             Options - Large/Medium/Small, Grid On/Off
  161.  
  162.  
  163.    DATA OPTIONS
  164.    ------------
  165.  
  166.    Input Data
  167.    ----------
  168.    Input Data lets you input the data on which the graph will be based (full
  169.    of surprises, this program). It asks for a "data point" - in other words,
  170.    a number. Then a label is required - just press return if you don't want
  171.    one. Otherwise, "1983", "December" or "1", for example, are all valid
  172.    labels.
  173.  
  174.    One restriction on the data that I have imposed is that a value of 0 will
  175.    end the input process - that is, if you enter two data points of, say, 10
  176.    and 14, a value of 0 for the third will get you the response "OK, got 2
  177.    points of data - correct?". If it is not correct, you can alter the
  178.    original data or add new, extra points.
  179.  
  180.    This restriction should not really cause many problems - if you do need a
  181.    0 in your graph, use 0.1 instead. That should work just as well.
  182.  
  183.  
  184.    Alter Data
  185.    ----------
  186.    Alter Data also works on the current set. It allows you to go through the
  187.    existing data, changing it to your heart's content using the same method
  188.    as in Input Data - number then label.
  189.  
  190.  
  191.    Load/Save Data
  192.    --------------
  193.    Load and Save Data load and save the current data set respectively
  194.    (that's the problem with writing user-friendly programs. The doc file
  195.    always sounds ridiculous). The data is saved as a text file, with a <CR>
  196.    symbol at the end of each line. If anything but a data file is loaded,
  197.    the program will not crash but simply reject the false data. For 
  198.    simplicity, I would stick to using the .DAT suffix if I were you!
  199.  
  200.    If you want to produce your own data file outside of A-Graph, this is the 
  201.    formula:
  202.  
  203.     Number of data points <CR>
  204.     Title of Dataset <CR>
  205.     Point 1 <CR>
  206.     Label for Point 1 <CR>
  207.         .
  208.         .
  209.         .
  210.     Final Point <CR>
  211.     Label for final point <CR>
  212.  
  213.    For example:
  214.  
  215.     3 <CR>
  216.     Sales <CR>
  217.     5 <CR>
  218.     Jan <CR>
  219.     10 <CR>
  220.     Feb <CR>
  221.     15 <CR>
  222.     Mar <CR>
  223.  
  224.    is a valid file. Note that the <CR> symbol MUST be present - that means
  225.    that programs such as ED will not produce valid files, as the <CR> symbol
  226.    is not placed. <CR> stands for Carriage Return, by the way.
  227.     
  228.  
  229.    Print Data
  230.    ----------
  231.    Print Data prints out the current set to any preferences-compatible
  232.    printer. For this option to work, you need to boot from a standard
  233.    workbench disk with such files on it as devs:printer.device and
  234.    devs:system-configuration, otherwise the option will have no effect.
  235.  
  236.  
  237.    GRAPH OPTIONS
  238.    -------------
  239.    This is the fun bit. The options are Large/Medium/Small, Points On/Off,
  240.    Grid On/Off, Save as IFF and Annotate.
  241.  
  242.    Size, and just how much it counts
  243.    ---------------------------------
  244.    Clicking on the button marked "Large" will cycle through "Medium" and
  245.    "Small", in that order. This is the size of the graph. The maximum width
  246.    and height in Large mode is about 600*240 pixels in PAL, 600*190 in NTSC.
  247.    In Hi-Res, the maximum height is doubled. Small mode has a maximum graph 
  248.    size of about 250*100 in PAL, 250*90 in NTSC. With the pie chart, Large 
  249.    gives a radius of 100 pixels, Medium a radius of 75 pixels and Small a
  250.    radius of 50 pixels.
  251.  
  252.    A Small pie chart looks extremely cute.
  253.  
  254.    Points On/Off
  255.    -------------
  256.    Points On, when clicked, becomes Points Off. Points, as described
  257.    earlier, are the little crosses on a line graph to help easy reading of
  258.    values. On a pie chart, they are the numbers on the slices. Points On
  259.    means they will be displayed, Points Off means they won't.
  260.  
  261.    This option has no effect on Bar or Area graphs.
  262.  
  263.    Grid On/Off
  264.    -----------
  265.    With all graphs except pie charts, when the button reads "Grid On" then a
  266.    grid will be drawn on the graph - this is most useful with Area and Line
  267.    graphs.
  268.  
  269.    Save IFF
  270.    --------
  271.    Clicking on this will draw your graph, and then a file selector will
  272.    appear. The default name for the graph is "Graph.IFF", and since this is
  273.    not entirely original you can of course change it. Press Return or click
  274.    on OK to save the graph as an 8-colour medium or hi-res. IFF pic, suitable 
  275.    for loading into DPaint, ProPage 2, Excellence! etc.
  276.  
  277.    Annotate
  278.    --------
  279.    When you click on this, you will be asked to input some text for
  280.    inclusion on the graph. Type in your text and then position it on the
  281.    graph with the mouse.
  282.  
  283.    The annotation will only be used for the type of graph it was added to -
  284.    for instance, if you annotate a bar graph, the text will not appear on a
  285.    line graph or a pie graph. You can have up to 24 annotations on one
  286.    graph, but if you change graph types and annotate the new type all of the
  287.    old annotations will be lost. They won't be lost if you just draw a new
  288.    type of graph, only if you annotate that new graph.
  289.  
  290.    Pattern
  291.    -------
  292.    Click on the "+" button to step upwards through the 32 patterns, and the
  293.    "-" button to step downwards. Clicking on either with the right button
  294.    takes you straight back to pattern 0 - that is, solid colour with no
  295.    pattern. This is the default.
  296.  
  297.    Each Dataset has its own pattern setting. To change the pattern of a 
  298.    particular set, just click on it's editing button and proceed as above.
  299.  
  300.    All graph types except the line graph are affected by the change.
  301.  
  302.  
  303.    COLOUR
  304.    ------
  305.    Colour can be extensively altered, so deserves a section to itself. To
  306.    bring up the colour menu, click on the "Set Colours" button in the middle
  307.    of the screen.
  308.  
  309.    Element Colours
  310.    -----------------
  311.    You can set the individual colours of the axes, the grid and the six data
  312.    sets. For the axes and grid colours, just click on the colour you want 
  313.    each to be drawn in. For the datasets, click on the number of the set you
  314.    wish to alter, and then on the desired colour on the bar below. Note that
  315.    here you are not actually altering the colours - you are just selecting
  316.    which of them is to be used for what.
  317.  
  318.    The axes' colour is also the colour of any annotations you may make.
  319.    Remember also that the first colour is the background colour, so anything
  320.    you draw in this will be invisible!
  321.   
  322.    Colour Alteration
  323.    -----------------
  324.    Here you can alter the eight colours used for the graph to any in the
  325.    Amiga's 4096-colour palette.
  326.  
  327.    Simply click on the colour you wish to alter, then drag the bars on the
  328.    RGB scales with the mouse (click on the bar with the left button and hold
  329.    it down, then move the mouse left or right before releasing the button).
  330.    Clicking to the right or left of the bar will also move it in the
  331.    corresponding direction. The colour values are displayed to the right of
  332.    the RGB scales, to help you get that exact shade.
  333.  
  334.    Print Colours
  335.    -------------
  336.    Or Print Clrs, as we say in the business. This is a toggle switch -
  337.    clicking on it once changes all the colours to grey scales more suitable
  338.    if your graph is to be saved and printed. Clicking it again restores the
  339.    colours to the way they were before.
  340.  
  341.    I suggest that you use a coloured or black background for a chart intended
  342.    to be used in a presentation or something, ie. if you are going to show
  343.    it on screen. If it is to be printed as part of a document or just from
  344.    DPaint then I'd select Print Clrs first, to get the white background if
  345.    nothing else. You may want to set all the colours to black except the
  346.    background, and use a pattern on the area/bar graphs. Either way prints
  347.    out equally well.
  348.  
  349.    And to finish...
  350.    ----------------
  351.    Click on OK to keep your changes, or Cancel to lose them. This only
  352.    applies to the palette changes - element colour information is always
  353.    kept.
  354.  
  355.     
  356.    MISC.
  357.    -----
  358.    And Finally...
  359.  
  360.    Med-Res / High-Res
  361.    ------------------
  362.    The button labelled "Med-Res" at the top of the screen, when clicked on,
  363.    changes to read "Hi-Res". In this mode, the graph will be drawn in 
  364.    interlace mode, 640x512 in PAL and 640x400 in NTSC. Lines and Area graphs
  365.    in particular are much improved in this mode, as are Pie Charts. If memory
  366.    is tight, you may not be able to use this mode. If this occurs, just click
  367.    on the button again to return to Med-Res mode.
  368.  
  369.    About
  370.    -----
  371.    Information on the program, addresses etc. You know, the usual "About"
  372.    stuff.
  373.  
  374.    Help
  375.    ----
  376.    Click on this once to activate the Help mode. In this mode, the
  377.    cursor changes to a question mark. Just click on the button you want
  378.    help on.
  379.  
  380.    When you've finished with help, just click on the Help button again.
  381.  
  382.    Quit
  383.    ----
  384.    What do you think it does?
  385.  
  386.    Correct.
  387.  
  388.  
  389. SHAREWARE!
  390. ----------
  391.  
  392. This program is Shareware! That means, if you like it and want to see it
  393. updated (which it has been and will be again... see SUPPORT & UPDATES) you 
  394. should send me #5. That's Five pounds sterling, UK currency, if you're reading 
  395. this on a non-UK terminal.
  396.  
  397. I think this is a fair amount for all the work I have put into A-Graph, and
  398. all the work which is yet to go into it. Please be honest and send the fee
  399. if you like the program, I'm a struggling CompSci student and need all the
  400. financing I can get!
  401.  
  402.  
  403. SUPPORT & UPDATES
  404. -----------------
  405.  
  406. If you send me the Shareware fee, in return I'll send you the latest version
  407. of A-Graph (this is V2.0) and the source code both on-disk (in AMOS and 
  408. ASCII format) and in printed form. I'll also add you onto a mailing list, so
  409. that whenever A-Graph is updated you'll receive the updated version quite a
  410. while before non-payers.
  411.  
  412. Future updates include:
  413.  
  414.    *  Many more graph types, including 3D with everything, Stacked Bar,
  415.        Circular Plot, 3-Axis Bar and Line graphs and, most importantly,
  416.        formula plotting.
  417.    *  More points of data than the present 24 (possibly up to 256 for line 
  418.        and area graphs?)
  419.    *  Improved data entry and editing (a must)!
  420.    *  Statistical analysis, eg. coefficient correlation, trend forecasting.
  421.    *  Printing from within the program.
  422.    *  PostScript/DR2D output (?) (We'll see!)
  423.    *  Import from spreadsheet programs 
  424.    *  Anything you suggest - I want your ideas when you register.
  425.  
  426. So you see, it will be well worth your while to send me the five quid! These
  427. updates will only take place if enough people show interest, and are honest
  428. enough to register.
  429.  
  430. I know you are!
  431.  
  432.  
  433. CONTACT ADDRESSES
  434. -----------------
  435.  
  436. Here's where to send the #5, bug reports [shouldn't be any :-) ], ideas for 
  437. the future etc...
  438.  
  439.          Dave Smith,                       Dave Smith,
  440.          4 Cleveland View,                 Fylde College,
  441.          South Bents,           or         Lancaster University,
  442.          Sunderland                        Lancaster
  443.          SR6 8AP                           LA1 4YF
  444.  
  445. Either will reach me, but if it's during term-time the Lancaster Uni address
  446. will get to me quicker.
  447.  
  448. I can be contacted by email at:
  449.  
  450.                      csc361@uk.ac.lancs.cent1
  451.  
  452. or, from the Internet,
  453.  
  454.                   csc361@central1.lancaster.ac.uk
  455.  
  456. The first address should work from CIX and JANET, as well as one or two
  457. smaller BBS that support JANET links. The second address is for use from
  458. outside the UK, eg. Europe and the US, via the Internet.
  459.  
  460.  
  461. THE END
  462. -------
  463.  
  464. So it is! I hope you enjoy A-Graph, and find it useful... please contact me
  465. for any reason you may find, and watch out for A-Graph V3.0!
  466.  
  467. ---
  468. Dave Smith
  469.  
  470. 21/09/91
  471.  
  472. Updated 3/11/91
  473.