home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 7 / FreshFishVol7.bin / bbs / gfx / jcgraph-1.21.lha / JcGraph / Docs / EnglishManual.txt < prev    next >
Text File  |  1993-08-14  |  40KB  |  1,018 lines
  1.                             JcGraph
  2.                     (Demo v0.903 on FredFish 671)
  3.                     (Demo v1.100 on FredFish 760)
  4.              Copyright 1992, Jean-Christophe Clément
  5.                 Internet:clemj00@dmi.usherb.ca
  6.  
  7. Amiga, AmigaDos, WorkBench are a trademark of Commodore-Amiga Inc.
  8. PostScript is a trademark of Adobe system corp.
  9. Professionnal Page is a trademark of Gold Disk Inc.
  10. PageStream is a trademark of Soft-Logik corp.
  11. Saxon Publisher is a trademark of Saxon Industries Inc.
  12. AegisDraw2000 is a trademark of Oxxi/Aegis Inc.
  13. Advantage is a trademark of Gold Disk Inc.
  14. File requester: Copyright 1990 Khalid Aldosery.
  15. HyperText system by Dominic Giampaolo.
  16.  
  17. Note to the purists: English is my second language.
  18.  
  19. WARNING:
  20.  
  21. This software is now freely-redistributable but is still copyrighted to
  22. his author, Jean-Christophe Clement.
  23.  
  24. Table of content:
  25. -----------------
  26.  
  27. 0.Introduction.
  28. 1.Required configuration, Hardware and Software.
  29. 2.JcGraph's installation.
  30. 3.Step by step example of a graph's creation.
  31. 4.Menu options summary.
  32. 5.Control panel window.
  33. 6.File format: Input.
  34. 7.File format: Output.
  35. 8.Graph's modification.
  36. 9.Keyboard equivalent.
  37. 10.Palette requester.
  38. 11.TOOLTYPE and command line options.
  39. 12.ARexx interface.
  40. 13.Graph type file format.
  41. 14.The future of JcGraph.
  42. 15.JcGraph history.
  43.  
  44. 0.Introduction:
  45. ---------------
  46. a.What is JcGraph ?.
  47.  
  48.     Specialised in business graph generation, JcGraph will output your data
  49. as Pie, line, bar, stack charts,(etc...more) in two or three dimension. You
  50. will then be able to rotate the resulting graph in X,Y,Z axes and output
  51. them to: EPS,Geo 3D, AegisDraw2000 or IFF ILBM.
  52.  
  53. b.Why I have created JcGraph ?
  54.  
  55.     Because, after having tried some commercial software that were "supposed"
  56. to produce professionnal quality business graphs, I found that none  were up
  57. to what is available for Macintosh or IBM PC compatibles. Considering the
  58. Amiga reputation as a "Multimedia" computer, it was time for a change.
  59.  
  60. c.JcGraph's philosophy.
  61.  
  62.     The first goal of Jcgraph was to produce highest quality business
  63. graphics with the greatest visual impact with the least effort possible.
  64.     So, I asked myself: "What is the single most difficult thing to do when
  65. someone is making a business graphic without any specific tool other than a
  66. paint program ?". The answer is quite simple: "The main graphic itself!".
  67. I mean, once the main graph is designed, the process of adding title,
  68. annotation, graduated background, etc... is trivial.
  69.     JcGraph reflects this thinking; it will help you create a great looking
  70. graphic and the flexibility of it's export modules will let you add all the
  71. fancy details in other specialized software.
  72.  
  73. d. Style guide compliance.
  74.  
  75.   Well, I tried as much as possible to stick to the Style guide book. If you
  76. take into account the limited ressources I had to invest in JcGraph, I think
  77. it is quite good.
  78.  
  79. 1.Required configuration, Hardware and Software:
  80. ------------------------------------------------
  81.  
  82. Minimal:
  83.             Any Amiga (more than one is not a necessity :-).
  84.             1meg RAM.
  85.             WorkBench 1.3.
  86.             1 floppy disk.
  87.  
  88. Suggested:
  89.             Accelerated Amiga.
  90.             1.5+ meg RAM.
  91.             WorkBench 2.0+.
  92.             Hard-Disk.
  93.  
  94. JcGraph has been tested and judged fully functionnal under these system
  95. configurations:
  96. -Amiga 500, 1 floppy, 1 meg RAM, WB 1.3, 68000.
  97. -Amiga 2000HD, 52 Megs HD, 3 megs RAM, WB 2.0, 68000.
  98. -Amiga 3000/16, 50 Megs HD, 2 megs RAM, WB 2.0, 68030/16Mhz
  99. -JcGraph has some problems working in AGA 256 color modes, so, if you got
  100.  one of the new machine, stay with 16 colors or less...
  101.  
  102. 2.JcGraph's installation:
  103. -------------------------
  104.  
  105. A-Logical assigns:
  106. ------------------
  107.  
  108. For example: If you copy JcGraph in "Work:MyJcGraph",
  109.              add this line to the file "s:startup-sequence":
  110.              "assign JcGraph: Work:MyJcGraph".
  111.  
  112. B-Directory and files required (After having done A):
  113. -----------------------------------------------------
  114. libs:icon.library               :On WB 1.3 (in ROM under 2.0).
  115. libs:kd_freq.library            :File-requester Library. (For <2.0 user)
  116. libs:IffParse.library           ;Library used for IFF ILBM .
  117. JcGraph:Graphtype               :Contain all graph types.
  118. JcGraph:Template                :Contain all Templates.
  119. JcGraph:HelpFile                :Contain all help files.
  120. JcGraph:Rexx                    :Contain all Rexx scripts.
  121. JcGraph:HelpFile/ht             :On-line Help engine.
  122. JcGraph:JcGraph                 :Main program.
  123.  
  124. If you haven't done so yet, go to jcgraph:libs directory and type (in a
  125. shell) "copy #?.library libs:". Everything should be functionnal from now.
  126. Note that I CANNOT distribute 'IffParse.library' that comes with WB 2.0,
  127. so, you should manage to get it somewhere else.
  128.  
  129. 3.Step by step example of a graph's creation:
  130. ---------------------------------------------
  131.     We will produce a graph made of 3 rows of 3 planes each and output it as
  132. AegisDraw2000.
  133.  
  134.     The first step is data creation. To do so, use your favorite text editor.
  135. It is important that it should not produce a file containing special control
  136. characters that would not be recognized by JcGraph (stay ASCII international).
  137.     After your text editor is loaded, start by entering "1002" (without the
  138. "" delimiters). This sequence help JcGraph identify the file type, to be sure
  139. that it is really compatible. Note that all value should be comma-separated.
  140.     Next, enter the number of column that your file will contain, "3" in our
  141. example. Do the same thing for the number of line. Follows a number which
  142. will set the space between each cotation in the scale on the side of the
  143. graph; for example, if your data range from 0 to 100 and you specify 25,
  144. the cotation scale will output "0","25","50","75","100". This number use
  145. the same value unit as the data itself.
  146.     The next number (floating point), is the one by which every cotation
  147. value will be multiplied ; for example, if you enter "1.24", each cotation
  148. of the scale will be muliplied by 1.24. This permits to access floating
  149. point value without changing the data itself. Note that only 3 decimals
  150. positions will be kept for now and that a value of 0 will result in an
  151. integer form (ie no decimal point).
  152.     The next step is the value entry. As we chose to produce a 3 by 3 data
  153. file, there will be 9 consecutive values (they can be on the same line but
  154. should always be comma-separated).
  155.     The 3 next value are text strings that will identify your columns (they
  156. should always be filled). Same procedure for each line. Note that the
  157. orientation is always the same. Rows represents variation and lines are
  158. diferent products type.
  159.  
  160. Here is the resulting data file from the example:
  161. 1002,
  162. 3,3,10,0,
  163. 10,20,30,
  164. 50,60,60,
  165. 15,32,17,
  166. Jan,Fev,Mar,
  167. Gaz,Oil,Fer,
  168.  
  169. Save this result as "test3X3.asc".
  170.  
  171.     The next major step is to load this data file in JcGraph. First, run
  172. JcGraph. Note that once JcGraph is started, there can be a 3 to 5 second
  173. break (more with default ARexx script) before you see anything happen, this
  174. is normal.
  175.     Now, choose "Open..." from the project menu (Amiga+O)
  176. IMPORTANT: JcGraph accepts command from the interface window only. So, every
  177. time you want to perform an operation, you should select it (if not already
  178. selected). It is also worth to mention that when there is no data loaded in
  179. JcGraph, the interface's title bar will display "No Data".
  180.     A file requester will pop up asking "Choose an ASCII data file". It's
  181. utilisation is not described here for brievty but can get extended help by
  182. pressing HELP or SHIFT-F1 when it is active.
  183.     Find et select your file "test3X3.asc" and select "Open" from the lower
  184. left corner of the file requester's window. The mouse pointer will change
  185. for a small clock until your data file is openned. This should'nt be long.
  186.  The title bar should now display "test3X3.asc".
  187.     The window titled "Preview" gives an approximation of what the final
  188. graph will look like, in this case, data is graphed as 3D blocks. For
  189. example purpose, we will choose another type of graphic.
  190.     Choose "Load..." (Amiga+T) from the "GraphType" menu. Another file
  191. requester should