home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 564b.lha / AGraph_v1.0 / AGraph.Doc.pp / AGraph.Doc
Text File  |  1991-10-20  |  15KB  |  387 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.
  44.  
  45. A-Graph needs 2 other files to run, both found in the libs: drawer. These are
  46. diskfont.library and mathtrans.library. If AGraph doesn't run first time,
  47. check that these files exist. If not, simply copy them over from your
  48. workbench disk to your A-Graph disk.
  49.  
  50.  
  51. INTRODUCTION
  52. ------------
  53.  
  54. Right, I've done the interesting bit (the programming), now comes the bit
  55. every software author loves to hate - the doc file!!! (Aaaargh)
  56.  
  57. Just kidding, text files are my life.
  58.  
  59. So what does A-Graph do? Well, this may surprise you but it draws graphs.
  60. More specifically, it has the following features:
  61.  
  62.    *  Draws Bar, Line, Area and Pie charts from given data
  63.    *  Many options including change size, colour and pattern of the graph
  64.    *  Save graph as an IFF file (8-colour med-res)
  65.    *  Load and Save data
  66.    *  Works in both PAL and NTSC, with larger screen areas for both menu
  67.        and work screens with PAL (I hate programs which just give PAL users
  68.        the NTSC standard 200 lines)
  69.    *  Workbench 2.0 Look and Feel! (Well, almost)
  70.    *  Raises user-friendliness to an art form! (Ditto)
  71.    *  Works with 512K and above
  72.  
  73. Whatever your graph needs, A-Graph will cater for them. As long as they
  74. involve Bar, Line, Area and Pie charts.
  75.  
  76.  
  77. MAIN MENU
  78. ---------
  79.  
  80. On loading the program, it will take a few seconds to decompress and then
  81. you will be presented with the menu screen. This is where you set all of the
  82. parameters for the graph (the data, graph type, grid on/off etc). The larger
  83. "Draw Graph" button at lower left then allows you to view the graph. I'll
  84. take you through the menu options one by one.
  85.  
  86.    GRAPH TYPES
  87.    -----------
  88.    Choosing one of the graph types (Bar, Line, Area, Pie) will de-select the
  89.    previously selected one. If you have not specified a type, Bar will be
  90.    used as a default.
  91.  
  92.     BAR  -  A vertical bar graph, drawn in the selected colour (see SET
  93.             COLORS) and pattern.
  94.             ---
  95.             Options - Large/Medium/Small, Grid On/Off
  96.  
  97.     LINE -  A straightforward line, drawn in the selected colour. Crosses
  98.             marking each point of data can be turned on or off.
  99.             ---
  100.             Options - Large/Medium/Small, Points On/Off, Grid On/Off
  101.  
  102.     PIE  -  Data is sorted into ascending order and the pie chart is drawn
  103.             based on this sorted data. Points On/Off controls the labelling
  104.             of each slice of the pie.
  105.             One quick word about pie charts - they work best with up to 10
  106.             or at the most 15 pieces of data. For a good, accurate pie chart
  107.             I would recommend you keep your data down to that level.
  108.             ---
  109.             Options - Large/Medium/Small, Points On/Off
  110.  
  111.     AREA -  Much like a line graph, except filled with your chosen pattern
  112.             and/or colour.
  113.             ---
  114.             Options - Large/Medium/Small, Grid On/Off
  115.  
  116.  
  117.    Dataset 1 / 2
  118.    -------------
  119.    These buttons are toggle switches - click once on them to select, and
  120.    once again to de-select.
  121.  
  122.    They are here for you to state which of the two data sets you want to be
  123.    drawn on your graph - set 1, set 2 or both.
  124.  
  125.    If you have both sets selected, with Bar as the type, set 1 will be a bar
  126.    graph and set 2 will be drawn as a line on the same axes.
  127.  
  128.    If Line is selected, set 1 will be a line and set 2 a bar graph.
  129.  
  130.    If Area has been chosen, set 1 will be the area graph while set 2 will be
  131.    drawn as a line.
  132.  
  133.    A Pie chart only draws one set of data at a time. If both sets are
  134.    selected for display, just set 1 will be shown.
  135.  
  136.    Don't worry, you'll see what I mean when you try it! It's easier to see
  137.    than explain.
  138.  
  139.    DATA OPTIONS
  140.    ------------
  141.  
  142.    Input Data
  143.    ----------
  144.    Input Data lets you input the data on which the graph will be based (full
  145.    of surprises, this program). It asks for a "data point" - in other words,
  146.    a number. Then a label is required - just press return if you don't want
  147.    one. Otherwise, "1983", "December" or "1", for example, are all valid
  148.    labels.
  149.  
  150.    One restriction on the data that I have imposed is that a value of 0 will
  151.    end the input process - that is, if you enter two data points of, say, 10
  152.    and 14, a value of 0 for the third will get you the response "OK, got 2
  153.    points of data - correct?". If it is not correct, you can alter the
  154.    original data or add new, extra points.
  155.  
  156.    This restriction should not really cause many problems - if you do need a
  157.    0 in your graph, use 0.1 instead. That should work just as well.
  158.  
  159.    Two Datasets?
  160.    -------------
  161.    Input Data, by the way, erases totally the existing data set you have
  162.    selected. Initially, you are editing set 1 - the button at the bottom
  163.    right of the Data section reflects this (it says "Dataset 1"). Clicking
  164.    on this button changes the set to be edited to set 2 (the button now says
  165.    "Dataset 2". Who said programmers were obtuse?). Both sets of data are
  166.    completely independant of one another - set 1 can be comprised of 3 bits
  167.    of data and set 2 24 bits (24, by the way, being the maximum number of
  168.    points). The data in set 1 can be 1, 2, 3 and in set 2 be 10001, 75 and
  169.    493 if you want (the graph will look a bit odd though).
  170.  
  171.    Alter Data
  172.    ----------
  173.    Alter Data also works on the current set. It allows you to go through the
  174.    existing data, changing it to your heart's content using the same method
  175.    as in Input Data - number then label.
  176.  
  177.    Load and Save Data load and save the current data set respectively
  178.    (that's the problem with writing user-friendly programs. The doc file
  179.    always sounds ridiculous). The data is saved as a text file, with a <CR>
  180.    symbol at the end of each line. If anything but a data file is loaded,
  181.    the program will not crash but simply reject the false data. For
  182.    simplicity, I would stick to using the .DAT suffix if I were you!
  183.  
  184.    Print Data
  185.    ----------
  186.    Print Data prints out the current set to any preferences-compatible
  187.    printer. For this option to work, you need to boot from a standard
  188.    workbench disk with such files on it as devs:printer.device and
  189.    devs:system-configuration, otherwise the option will have no effect.
  190.  
  191.  
  192.    GRAPH OPTIONS
  193.    -------------
  194.    This is the fun bit. The options are Large/Medium/Small, Points On/Off,
  195.    Grid On/Off, Save as IFF and Annotate.
  196.  
  197.    Size, and just how much it counts
  198.    ---------------------------------
  199.    Clicking on the button marked "Large" will cycle through "Medium" and
  200.    "Small", in that order. This is the size of the graph. The maximum width
  201.    and height in Large mode is about 580*240 pixels in PAL, 580*190 in NTSC.
  202.    Small mode has a maximum graph size of about 200*100 in PAL, 200*90 in
  203.    NTSC. With the pie chart, Large gives a radius of 100 pixels, Medium a
  204.    radius of 75 pixels and Small a radius of 50 pixels.
  205.  
  206.    A Small pie chart looks extremely cute.
  207.  
  208.    Points On/Off
  209.    -------------
  210.    Points On, when clicked, becomes Points Off. Points, as described
  211.    earlier, are the little crosses on a line graph to help easy reading of
  212.    values. On a pie chart, they are the numbers on the slices. Points On
  213.    means they will be displayed, Points Off means they won't.
  214.  
  215.    This option has no effect on Bar or Area graphs.
  216.  
  217.    Grid On/Off
  218.    -----------
  219.    With all graphs except pie charts, when the button reads "Grid On" then a
  220.    grid will be drawn on the graph - this is most useful with Area and Line
  221.    graphs.
  222.  
  223.    Save IFF
  224.    --------
  225.    Clicking on this will draw your graph, and then a file selector will
  226.    appear. The default name for the graph is "Graph.IFF", and since this is
  227.    not entirely original you can of course change it. Press Return or click
  228.    on OK to save the graph as an 8-colour medium res. IFF pic, suitable for
  229.    loading into DPaint, ProPage 2, Excellence! etc.
  230.  
  231.    Annotate
  232.    --------
  233.    When you click on this, you will be asked to input some text for
  234.    inclusion on the graph. Type in your text and then position it on the
  235.    graph with the mouse.
  236.  
  237.    The annotation will only be used for the type of graph it was added to -
  238.    for instance, if you annotate a bar graph, the text will not appear on a
  239.    line graph or a pie graph. You can have up to 24 annotations on one
  240.    graph, but if you change graph types and annotate the new type all of the
  241.    old annotations will be lost. They won't be lost if you just draw a new
  242.    graph, only if you annotate that new graph.
  243.  
  244.    Pattern
  245.    -------
  246.    Click on the "+" button to step upwards through the 32 patterns, and the
  247.    "-" button to step downwards. Clicking on either with the right button
  248.    takes you straight back to pattern 0 - that is, solid colour with no
  249.    pattern. This is the default.
  250.  
  251.    All graph types except the line graph are affected by the change.
  252.  
  253.  
  254.    COLOUR
  255.    ------
  256.    Colour can be extensively altered, so deserves a section to itself. To
  257.    bring up the colour menu, click on the "Set Colors" button in the middle
  258.    of the screen (note to English lovers - I know it should be "Set
  259.    Colours", but the extra "u" wouldn't fit!).
  260.  
  261.    Element Colo(u)rs
  262.    -----------------
  263.    You can set the individual colours of the axes, the grid and the two data
  264.    sets. Just click on the colour you want each to be drawn in. Note that
  265.    here you are not actually altering the colours - you are just selecting
  266.    which of them is to be used for what.
  267.  
  268.    The axes' colour is also the colour of any annotations you may make.
  269.    Remember also that the first colour is the background colour, so anything
  270.    you draw in this will be invisible!
  271.   
  272.    Colour Alteration
  273.    -----------------
  274.    Here you can alter the eight colours used for the graph to any in the
  275.    Amiga's 4096-colour palette.
  276.  
  277.    Simply click on the colour you wish to alter, then drag the bars on the
  278.    RGB scales with the mouse (click on the bar with the left button and hold
  279.    it down, then move the mouse left or right before releasing the button).
  280.    Clicking to the right or left of the bar will also move it in the
  281.    corresponding direction. The colour values are displayed to the right of
  282.    the RGB scales, to help you get that exact shade.
  283.  
  284.    Print Colours
  285.    -------------
  286.    Or Print Clrs, as we say in the business. This is a toggle switch -
  287.    clicking on it once changes all the colours to grey scales more suitable
  288.    if your graph is to be saved and printed. Clicking it again restores the
  289.    colours to the way they were before.
  290.  
  291.    I suggest that you use a coloured or black background for a chart intended
  292.    to be used in a presentation or something, ie. if you are going to show
  293.    it on screen. If it is to be printed as part of a document or just from
  294.    DPaint then I'd select Print Clrs first, to get the white background if
  295.    nothing else. You may want to set all the colours to black except the
  296.    background, and use a pattern on the area/bar graphs. Either way prints
  297.    out equally well.
  298.  
  299.    And to finish...
  300.    ----------------
  301.    Click on OK to keep your changes, or Cancel to lose them. This only
  302.    applies to the palette changes - element colour information is always
  303.    kept.
  304.  
  305.    MISC.
  306.    -----
  307.    Finally... About gives some info on the program, and Quit lets you leave
  308.    (if you must).
  309.  
  310.  
  311. SHAREWARE!
  312. ----------
  313.  
  314. This program is Shareware! That means, if you like it and want to see it
  315. updated (which it will be... see SUPPORT & UPDATES) you should send me £5.
  316. That's Five pounds sterling, if you're reading this on a non-UK terminal.
  317.  
  318. I think this is a fair amount for all the work I have put into A-Graph, and
  319. all the work which is yet to go into it. Please be honest and send the fee
  320. if you like the program, I'm a struggling CompSci student and need all the
  321. financing I can get!
  322.  
  323.  
  324. SUPPORT & UPDATES
  325. -----------------
  326.  
  327. If you send me the Shareware fee, in return I'll send you the latest version
  328. of A-Graph (this is V1.0) and the source code in both on-disk ASCII file and
  329. printed form. I'll also add you onto a mailing list, so that whenever
  330. A-Graph is updated you'll receive the updated version quite a while before
  331. non-payers.
  332.  
  333. Future updates include:
  334.  
  335.    *  Many more graph types, including 3D with everything, MultiBar,
  336.        Stacked Bar, Circular Plot, 3-Axis Bar and Line graphs and, most
  337.        importantly, formula plotting.
  338.    *  More than two data sets on one graph - probably six, I think.
  339.    *  Improved data entry and editing.
  340.    *  Statistical analysis, eg. coefficient correlation, trend forecasting.
  341.    *  Printing from within the program (if I can get AMOS to do it!)
  342.    *  Anything you suggest - I want your ideas when you register.
  343.  
  344. So you see, it will be well worth your while to send me the five quid! These
  345. updates will only take place if enough people show interest, and are honest
  346. enough to register.
  347.  
  348. I know you are!
  349.  
  350. CONTACT ADDRESSES
  351. -----------------
  352.  
  353. Here's where to send the £5, bug reports (shouldn't be any), ideas for the
  354. future etc...
  355.  
  356.          Dave Smith,                       Dave Smith,
  357.          4 Cleveland View,                 Fylde College,
  358.          South Bents,           or         Lancaster University,
  359.          Sunderland                        Lancaster
  360.          SR6 8AP                           LA1 4YF
  361.  
  362. Either will reach me, but if it's during term-time the Lancaster Uni address
  363. will get to me quicker.
  364.  
  365. I can be contacted by email at:
  366.  
  367.                      csd016@uk.ac.lancs.cent1
  368.  
  369. or, from the Internet,
  370.  
  371.                   csd016@central1.lancaster.ac.uk
  372.  
  373. The first address should work from CIX and JANET, as well as one or two
  374. smaller BBS that support JANET links. The second address is for use from
  375. outside the UK, eg. Europe and the US, via the Internet.
  376.  
  377.  
  378. THE END
  379. -------
  380.  
  381. So it is! I hope you enjoy A-Graph, and find it useful... please contact me
  382. for any reason you may find, and watch out for A-Graph V2.0!
  383.  
  384. ---
  385. Dave Smith
  386. 21/09/91
  387.