home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_1.iso / files / 298.lha / ChartMaster / ChartMaster.DOC < prev    next >
Text File  |  1980-11-30  |  23KB  |  453 lines

  1.  
  2.          ********  /***                                     /***
  3.        /***//////  /***                                     /***
  4.        /***        /***                                     /***
  5.        /***        /*******      **********  /** /*****  /*********
  6.        /***        /***///***  /***///***//  /*****///   ////***///
  7.        /***        /***  /***  /***  /***    /***/          /***
  8.        /***        /***  /***  /***  /***    /***           /***
  9.         /********  /***  /***   /**********  /***           /***
  10.          ///////   ////  ////    //////////  ////           ////
  11.  
  12.  /***       ***                               /***
  13.  /****    *****                               /***
  14.  /***/** **/***                               /***
  15.  /*** /*** /***    ***********    /******  /*********   /*******   /** /***** 
  16.  /***  //  /***  /***////***//  /***////   ////***///  /***////**  /*****///  
  17.  /***      /***  /***   /***     ///***       /***     /********   /***/
  18.  /***      /***  /***   /***        //***     /***     /***///     /***  
  19.  /***      /***   /***********  /*******/     /***      /*******   /***  
  20.  ////      ////    ///////////  ////////      ////       ///////   ////  
  21.  
  22.                   COPYRIGHT (C) 1989  by Michael Bodin
  23.                          ALL RIGHTS RESERVED
  24.  
  25. -=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
  26.  
  27.         Chart Master is a chart making program designed with the user in
  28.       mind. This program will allow you to create a variety of different
  29.       charts with very little user input. These charts are accurate to 
  30.       within +/- 1% of the total specified range. 
  31.       
  32.         Let's start with an overview of Chart Master. The following diagram
  33.       should give you an idea of the chart layout and some of the terms 
  34.       used in Chart Master.
  35.       
  36.       Main Screen:
  37.       ~~~~~~~~~~~~
  38.       
  39.                               Main Title Area
  40.      Col. Label -|
  41.                  |
  42.           C     -|  
  43.           o      |
  44.           l.    -| 
  45.                  | 
  46.           T     -|                        __
  47.           i      |                       |  |
  48.           t     -|          __           |  |     
  49.           l      |         |  |          |  |    
  50.           e     -|   __    |  |          |  |           __    
  51.                  |  |  |   |  |    __    |  |          |  |   
  52.                 -|  |  |   |  |   |  |   |  |    __    |  |
  53.                  |__|__|___|__|___|__|___|__|___|__|___|__|_____Row Label
  54.  
  55.                     JAN    FEB    MAR    APR    MAY    JUN
  56.                  
  57.                                   Row Title                  
  58.  
  59.         
  60.         As you can see there is an overall chart title and each axis has 
  61.       both a Title area and a Label for the axis. You can enter in all
  62.       titles and labels or only those you need to best describe your chart.
  63.       The following are the specifications for each:
  64.       
  65.               Main Title      60 chars.
  66.               Column Title    20 chars.
  67.               Row Title       40 chars.
  68.               Column Label    12 chars.
  69.               Row Label       12 chars.
  70.               
  71.         Each item within the chart can also have an Item Name as well as
  72.       its Item Value. In the diagram the Item Names are JAN, FEB, etc. The
  73.       Item Value is displayed as a bar. 
  74.       
  75.               Item Name       20 chars.
  76.               Item Value       4 places  (0000 - 9999)
  77.               
  78.         I will be referencing these terms throughout the rest of this
  79.       documentation. Next I will cover the chart definition and item
  80.       definition requesters. These requesters are used to define your
  81.       chart and the individual items.
  82.       
  83.       Chart Requester
  84.       ~~~~~~~~~~~~~~~
  85.       ___________________________________________________
  86.       |                                     X     Y     |
  87.       | Chart Title___________________     ___    ___   |    
  88.       | |_____________________________|   |___|  |___|  |
  89.       |                                                 |
  90.       | Col. Title____________             ___    ___   |      
  91.       | |_____________________|           |___|  |___|  |
  92.       |                                                 |
  93.       | Row Title_____________________     ___    ___   |
  94.       | |_____________________________|   |___|  |___|  |
  95.       |                                                 |
  96.       | Col Label____         Row Label____             |
  97.       | |____________|       |_____________|            |    
  98.       |              __             ____      ____      |
  99.       | Total Items |__|     Range |____| to |____|     |
  100.       |   ____           ______            ________     |
  101.       |  |_OK_|         |_UNDO_|          |_CANCEL_|    |
  102.       |_________________________________________________|
  103.       
  104.  
  105.  
  106.         When you select New from the PROJECT menu this requester will be
  107.       displayed. From here you can define your chart's parameters. The
  108.       titles and labels are self explanatory. Each has an X,Y location
  109.       on the screen. Initially these values will all be zero. The program
  110.       will automatically center these text strings when it finds a value
  111.       of zero or blank. Later after the chart is defined if you wish to
  112.       fine tune these placement values you can edit the chart and these
  113.       X,Y gadgets will display the centered values. You can then change
  114.       them slightly to create the screen layout you desire.
  115.  
  116.         The Labels are automatically placed in line with the axis they 
  117.       represent. (See diagram 1) These are fixed locations and cannot be
  118.       changed.
  119.       
  120.         The Total Items gadget allows you to enter in the total number
  121.       of items for this chart. You can enter up to 12 items per chart.
  122.       (Anymore items makes for a cramped display). Again you can enter
  123.       1 up to 12 total items. Be aware also when creating your chart
  124.       that although each item can have a 20 character Item Name, when
  125.       you get above six items these Item Names will run together if you
  126.       are using the full 20 chars. (Example: When entering 12 items to
  127.       represent 12 months in a year it is best to use an abbreviation
  128.       for each month.) Experimentation is the best way to judge how many
  129.       characters you can use for the Item Name given the number of items
  130.       to be displayed.
  131.       
  132.         The Range gadget allows you to specify the total range for the
  133.       chart. For example you could say 0 to 100 to show a percentage or 
  134.       0 to 1000 units of whatever. This range can be anywhere from 0 to
  135.       9999. This should be adequate for most displays. The range for
  136.       most of the chart displays will always be zero based. If you wish
  137.       to show both positive and negative values in the same chart you 
  138.       will have to select the Deviation Bar Chart. With this chart type
  139.       you can specify a negative low range value. (YOU MUST SELECT THE
  140.       DEVIATION BAR CHART from the menu BEFORE you define your chart!)
  141.       If you have have any other chart type selected and you enter a 
  142.       negative value for the low range the program will reset this to 0.
  143.       
  144.         Once you have defined all the parameters for your chart select the
  145.       OK gadget. If you are editing an existing chart and you make a mistake
  146.       in entering the parameters you can select the UNDO gadget to recall
  147.       the original values. Or you can select the CANCEL gadget in which
  148.       case no changes will be made.
  149.       
  150.       
  151.       Items Requester
  152.       ~~~~~~~~~~~~~~~
  153.       ______________________________________
  154.       |                               __   |
  155.       |                  Item Number |__|  |                    
  156.       |                                    |
  157.       | Item Name_______________________   |
  158.       | |_______________________________|  |
  159.       |             ____                   |
  160.       | Item Value |____|                  |
  161.       |   ____                  ________   |
  162.       |  |_OK_|                |_CANCEL_|  |     
  163.       |____________________________________|  
  164.  
  165.  
  166.         Once you have selected the OK gadget from the Chart Info requester
  167.       you will be presented with the Item Info requester. This requester
  168.       is where you specify the individual names and values for each of the
  169.       items specified in Total Items. As you can see this is a very simple
  170.       requester. In the Item Number gadget will appear the item number you
  171.       are working with. For example if you specify 7 total items that will
  172.       serve to represent the 7 days of the week item #1 would be Sunday,
  173.       item #2 would be Monday and etc. Once you are done defining the item's
  174.       name you can then enter the Item Value. This value must be a number 
  175.       that falls within the range low and high you specified in the Chart
  176.       Info requester. If you enter a number greater than the high range 
  177.       the value will be reset to the high range value. You cannot enter a
  178.       negative number unless you are defining a Deviation Bar chart, in 
  179.       which case you cannot enter a number less than the low range value.
  180.       Also you cannot enter a fractional number. (Example: 1.2, 0.5, etc.)
  181.       These values can ONLY be integers.
  182.       
  183.         After you have entered the value select the OK gadget to move on 
  184.       to the next defined Item. After you have entered the data for the last
  185.       defined item, the screen will clear and your chart will be displayed.
  186.       If you have made a mistake in entering any of the data for the items 
  187.       you can always go back and edit each item. To edit an item just sel-
  188.       ect Item from the EDIT menu and the Item Info requester will be re-
  189.       displayed. Enter the Item Number you wish to edit in the Item Number 
  190.       gadget and that item's data will be displayed for editing. Select OK 
  191.       or CANCEL gadgets when you are finished editing.
  192.       
  193.         That's all you need to know to quickly define a chart and its
  194.       parameters. The whole process is quick and easy. Once your chart is
  195.       displayed you can then select any of the appropriate chart types and
  196.       your chart will be instantly redefined to the new type. So changing
  197.       from a Bar chart type to a 3D Bar chart to Vertical Bar chart is all 
  198.       a matter of selecting the chart type from the CHARTS menu. Please
  199.       note that some definitions may not look to well as a Pie chart unless
  200.       defined with that in mind. Same thing applies to the Deviation Bar
  201.       chart, if your range is zero based. I strongly recommend you ex-
  202.       periment with the different types to get a feel for the different 
  203.       displays.
  204.       
  205.       
  206.       Text Requester
  207.       ~~~~~~~~~~~~~~
  208.       _____________________________________
  209.       |                                   |
  210.       | Line 1_________________________   |
  211.       | |______________________________|  |
  212.       |                                   |
  213.       | Line 2_________________________   |
  214.       | |______________________________|  |
  215.       |                                   |
  216.       | Line 3_________________________   |
  217.       | |______________________________|  |
  218.       |                                   |
  219.       |         Window Coordinates        |
  220.       |         ___             ___       |
  221.       |      X |___|         Y |___|      |
  222.       |                                   |
  223.       |     ____               ________   |
  224.       |    |_OK_|             |_CANCEL_|  |
  225.       |___________________________________|
  226.       
  227.       
  228.         The Text info requester allows you to write 3 lines to be displayed
  229.       in a small window anywhere on screen. This option can be used to de-
  230.       fine, say, a chart key. Each line of text can contain up to 32 char-
  231.       acters. The text is always left justified, so if you wish to center 
  232.       the Text in the window just add in the spaces as needed. This allows 
  233.       you to adjust the placement of the text anywhere within the window. 
  234.       This text window will be displayed when you select the Text ON from 
  235.       the DISPLAY menu. The window will be displayed with a double border 
  236.       at the window coordinates you enter in the requester. Remember that 
  237.       these coordinates must fall within the screen's definition. If you 
  238.       are using a 640X200 screen you can define a Y value no greater than 
  239.       200 - window height. (For a 640X400, 400 - window height.) 
  240.       (Technically this is not really a window like your used to using 
  241.       on the WorkBench. This window becomes part of the chart display itself
  242.       so if you select to save the file as an IFF picture it will be part 
  243.       of the screen bitmap.) If you wish to fine tune the text placement or
  244.       the window coordinates just re-select Text from the EDIT menu. Then
  245.       make your changes and select OK or CANCEL. To re-display the new
  246.       entries you will need to select REDRAW from the DISPLAY menu.
  247.       
  248.       ---------------------------------------------------------------------
  249.       
  250.         These are the three primary requesters you will be working with when
  251.       defining a Chart Master chart. I have touched on some of the major
  252.       items from the menus, so now lets go over each menu item and specify
  253.       each one's function.
  254.      
  255.       PROJECT MENU
  256.       -----------------
  257.       |  New          |
  258.       |  Open         | ---------
  259.       |  Save as  ----->| File  |
  260.       |               | | IFF   |
  261.       |               | ---------
  262.       |  Quit         |
  263.       |  About        |
  264.       -----------------
  265.       
  266.       NEW - Select this item to start a new chart. This clears all the
  267.       chart variables and opens the Chart Info requester. You can then
  268.       define the chart as previously explained.
  269.       
  270.       OPEN - This item allows you to open a previously SAVEd file. This
  271.       file can only be a Chart Master type file. Chart Master filenames
  272.       always end with a ".cm" suffix. A file requester will be displayed
  273.       and you can select the drive name, (DF0:, RAM: etc.) the directory
  274.       and filename. Once selected use the OPEN gadget to load the file.
  275.       Once the file is loaded it will be displayed EXACTLY as you saved
  276.       it. All options will be reset to the saved values. For instance
  277.       if you saved the file with the Grid ON, then when the file reloads
  278.       the Grid will be turned on. Also the file will be displayed as
  279.       the saved chart type. If you save a Pie you load a Pie.
  280.       
  281.       SAVE AS - This item has 2 subitems. One is, Save as FILE. This will
  282.       save the chart definition as a standard Chart Master file. This is
  283.       a very SMALL file and is the way all charts should be saved. If you
  284.       don't save the FILE you will lose the chart definition when you QUIT.
  285.       Again this will call up a file requester and you can select where you
  286.       wish to save the file. You can enter a new filename or use a current 
  287.       filename to overwrite the file. You can enter the ".cm" suffix or if
  288.       you forget the program will automatically tack it on the end. Once 
  289.       you have the disk drive and filename typed in just select the SAVE
  290.       gadget to save the chart definition. If any errors occur you will get 
  291.       a warning message indicating the file was not saved properly.
  292.       The second subitem is Save as IFF. This allows you to save the chart
  293.       displayed as an IFF picture file. You can then load this picture into
  294.       any paint program for touch up work. ( I have tested these IFF pictures
  295.       by loading them into DPAINT I II and III, DigiPaint 3.0, and Photon
  296.       Paint, so I am sure you will have no problem loading them into your
  297.       favorite paint program) NOTE: You must have Chris Weber's iff.library
  298.       in your LIBS: directory for these save routines to work. The library
  299.       is bundled with this program but should they get separated you can
  300.       get a copy on many of the BBS systems. The save routine will work with
  301.       either version 15 or 16 of the iff.library. (SPECIAL THANKS TO CHRIS!)
  302.       To copy this program to a new disk be sure you also copy over the
  303.       iff.library!
  304.       
  305.       QUIT - Self explanatory...you will be asked if your sure you want to
  306.       quit. This is the time to be sure your chart definition is saved,
  307.       otherwise it is lost forever!
  308.       
  309.       ABOUT - This is where I put in those lovely COPYRIGHT notices. But
  310.       they serve a purpose, so here they are!
  311.       
  312.       CHART MENU
  313.       --------------------
  314.       |  Bar    | 3D Bar |
  315.       |_________|________|
  316.       | Vert Bar| Dev Bar|
  317.       |_________|________|
  318.       |  Line   | Point  |
  319.       |_________|________|
  320.       | Column  |  Pie   |
  321.       |_________|________|
  322.  
  323.       These menu items are actually displayed as miniture pictures of the
  324.       chart type they represent. Look at the picture and you'll get an idea
  325.       of what the chart will look like. To select just slide the mouse to
  326.       the chart type you want and release. The chart will instantly be re-
  327.       drawn in the new type.
  328.       
  329.       EDIT MENU
  330.       ---------------
  331.       | Chart   /|C |
  332.       | Item    /|I |
  333.       | Text    /|T |
  334.       ---------------
  335.       
  336.       CHART - Select this item AFTER you have defined the chart to go back
  337.       in and edit any of the chart features. See the chart requester dia-
  338.       gram for details on setting these definitions.
  339.       
  340.       ITEM - Select this AFTER you have defined all the items to go back
  341.       in and edit one particular item. The first item will be called up for
  342.       display. To edit another item just type in the Item Number and that
  343.       item's data wil be displayed for editing. Make your changes and then
  344.       select OK or CANCEL.
  345.       
  346.       TEXT - Select this to define the text lines you want displayed in the
  347.       special text window. Enter the lines of text you want up to 32 chars.
  348.       and then select OK or CANCEL.
  349.       
  350.       DISPLAY MENU
  351.       -----------------
  352.       | Grid   ON     |
  353.       | Border OFF    |
  354.       | Text   ON     |
  355.       | ReDraw    /|R |
  356.       -----------------
  357.       
  358.       The first three items all act like switches. To turn on an option
  359.       just select it. The messages displayed will reflect the current
  360.       state of that option. The default status is shown above. The grid
  361.       is off, the border is on and the text window is off. The message
  362.       says Grid ON which means turn on the grid. The message say Border
  363.       OFF which means turn off the screen border. If you turn on the
  364.       grid the message will change to say Grid off, meaning turn OFF the
  365.       grid. Experiment!
  366.       
  367.       REDRAW - Chart Master will not automatically redraw the screen. If
  368.       you make a change to an item, or the text you must select ReDraw to
  369.       re-display the chart with the new parameters.
  370.       
  371.       SCREEN MENU
  372.       ---------------- -------
  373.       | 640 X    ----->| 200 |
  374.       |              | | 400 |
  375.       | Title  OFF   | -------
  376.       | Palette  /|P |
  377.       ----------------
  378.       
  379.       640 X - This item lets you redisplay the chart in either screen
  380.       resolution. 640x200 or 640X400 (interlace) Select the one that
  381.       suits your needs.
  382.       
  383.       TITLE - This is also an option switch. The screen title can be 
  384.       turned on and off as you wish. NOTE: this is the one option that is
  385.       NOT saved with your chart. The program will always start with the
  386.       screen title ON. To turn it off just select this item. It will stay
  387.       off until you turn it on again.
  388.       
  389.       PALETTE - This item will call up a color palette requester that will
  390.       allow you to change ANY of the 16 colors that Chart Master uses. This
  391.       lets you fully customize the colors displayed. NOTE: certain colors
  392.       are used by the system for menus, requesters, and messages. If you
  393.       change the upper colors (12 - 15) you will find the menus,  etc.
  394.       might look a little strange, but you can set them to any color that
  395.       you feel you need for the best looking display. 
  396.  
  397.  
  398.       That covers all the menu features. Again the best way to judge the
  399.       effect each option has on the chart display, is to experiment! You
  400.       can create some pretty interesting charts using these simple, yet
  401.       powerful features.
  402.  
  403.       --------------------------------------------------------------------
  404.       
  405.       Misc. Notes:
  406.       
  407.       1. Chart Master uses its own specially defined font. This font is
  408.          called CMB.font and must be located in your fonts directory. You
  409.          can optionally assign fonts directory to the directory that con-
  410.          tains the font. To install the font into your fonts directory
  411.          you must first make a CMB directory. The following commands can
  412.          be typed in from the CLI prompt. (To open a CLI window double 
  413.          click the CLI or SHELL icon located on your WorkBench disk.)
  414.          
  415.          First make the directory containing the CMB.font the current 
  416.          directory using the CD command. (Ex: CD ChartMaster/  )
  417.          
  418.          1> makedir FONTS: CMB
  419.          1> copy CMB.font to FONTS:
  420.          1> copy 8 to FONTS:CMB/
  421.          
  422.          If the font is not found you will receive a message when you
  423.          run the Chart Master program. The major difference you will 
  424.          notice is the range numbers displayed on the side of the grid
  425.          will appear as small squares. Other than this the program will 
  426.          function normally.
  427.          
  428.       2. The iff.library must be located in your libs directory. This
  429.          library is a collection of standard IFF routines that allow
  430.          a variety of functions. This library was created by Chris Weber 
  431.          from Switzerland. These are very nice and quick routines that
  432.          provide an IFF standard. My thanks to Chris Weber for this move
  433.          towards developing a standard for IFF routines!
  434.          
  435.       3. Chart Master files are extremely small and always end with a
  436.          ".cm" suffix. If you save your file as an IFF picture it will
  437.          be given a ".pic" suffix to disinguish it from a standard
  438.          Chart Master file. You CANNOT load a ".pic" file, only ".cm"
  439.          files can be reloaded into Chart Master.
  440.       
  441.       4. Finally, no program is perfect and I am sure Chart Master can 
  442.          always stand improvement. If you have any suggestions, comments,
  443.          or general ramblings please address these to myself or to 
  444.          AmigaWORLD. I can be reached at any of the following addresses:
  445.          
  446.             GEnie         M.BODIN
  447.             PLink         MBODIN
  448.             Compuserve    72571,3240
  449.             Lattice BBS   Mike Bodin
  450.  
  451.          Please feel free to contact me with any of your ideas!
  452.          
  453.