home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 2: PC / frozenfish_august_1995.bin / bbs / d09xx / d0926.lha / JcGraph / Docs / EnglishManual.txt < prev    next >
Text File  |  1993-10-07  |  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 appear. If JcGraph is correctly installed, a number of
  192. file ending with ".grf" extension should be listed in the window. You can
  193. now choose the type of graph that best suit your needs. For the example,
  194. choose "3D_BrokenPlanes.grf" then "Load...". After a short period of time,
  195. you should see the new graph type reflected in the Preview window. Note that
  196. the wireframe representation of the preview window is used for real-time
  197. manipulation, the final output is filled with colors.
  198.     The actual three-dimensionnal perspective doesn't do justice to the 3D
  199. effect, so we will rotate the graph using the interface window's gadgets.
  200. There is two main section that divide the interface window:
  201. 1. To the left, there is two gadget labelled "Undo" and "Render". We will
  202. discuss their respective function later.
  203. 2. To the right, there is 4 lines of gadgets. These ones control rotation
  204. values and perspective of the graph.
  205.     Line 1: Rotation around X.
  206.     Line 2: Rotation around Y.
  207.     Line 3: Rotation around Z.
  208.     Line 4: Perspective control.
  209.  
  210.     For example purpose, we will not discuss these any further  (they are
  211. described in section 5). For now, just select the first gadget from the top
  212. (the rectangular one, with a "0" in it) and replace the "0" by "-30". Press
  213. RETURN. Do the same with the next gadget, but this time, replace "0" by "30".
  214. You will immediatly see the change in the preview window. The effect is a
  215. lot more dynamic.
  216.     Now, if you want to look at the final result, select the "Render" gadget
  217. from the interface window. The mouse pointer will change for a longer period
  218. of time. After a while, the pointer should get back to normal and you should
  219. see the final result in the Output window. If it is obscured by another
  220. window, just bring it to the front (but remember to click back in the
  221. interface window in order to do any other manipulation on the graph).
  222.     From here, there could be some constatation:
  223. 1. It's nice (I hope so :-)
  224. 2. It's too small.
  225. 3. You don't like the colors.
  226.  
  227. We will solve all the problems, one at a time.
  228. 1. It's nice: That's not really a problem.
  229. 2. It's too small: Grab the sizing gadget (the one at the lower right of
  230. the Output window) and drag it to the desired size. Now, re-press "Render"
  231. and "voila!".
  232. 3. You don't like the colors: It is the next step.
  233.  
  234. Color choice:
  235. Choose the "Color..." (Amiga+k) option under the "Edit" menu. A requester
  236. named "Data color selector" should pop up. To the left, you should see all
  237. available colors... to the right, the values to be colored. You will
  238. probably recognize the texts associated with each line of value. There is
  239. also two more entries named "Background" and "Floor" which will permits
  240. respectively to change the colors of the background, behind the data and
  241. the floor, under the data (compare with the final result for better
  242. understanding). Select "Floor". A white rectangle will appear around the
  243. selected area. Then, choose a color on the left. The little box at the left
  244. of the "Floor" text should reflects the color you selected. When you are
  245. satisfied with the color you choosed, click on the close gadget to validate
  246. your entry (the one at the upper-left of the window). To see the result,
  247. selct "Render" one more time. If you don't like the color palette at all,
  248. use the "Palette..." menu option to change it.
  249.     The final step is to save the file as "AegisDraw2000". To do so, select
  250. "Draw2000" from sub-menu "Fromat..." from menu "Project" (Amiga+4). Then,
  251. choose "Save as..." from "Project" (Amiga+A) that will pop up a file
  252. requester asking for the file name of the resulting graph. Enter the name,
  253. then press RETURN. The file should now be available for use in any
  254. compatible software.
  255.     For more detail on JcGraph function, go to section 4.
  256.  
  257. IMPORTANT:
  258.   It is to be noted that if you have ARexx (or WB 2.0) and Advantage, you
  259. can use an included Arexx script to import it's files directly to JcGraph.
  260.  
  261. 4.Menu options summary.
  262. -----------------------
  263. PROJECT
  264. About...    :Info about JcGraph.
  265. Open...     :Open a text file (Desciption in section 6).
  266. Save        :Save the graph. Format is specified in "Format".
  267. Save as...  :Same as "Save" but request a name.
  268. Format      :Select the file output format :see section 7.
  269. Print...    :Outputs to the printer.
  270.              Beware, you will be asked only once if you want to "CANCEL".
  271. Quit...     :Quit JcGraph...
  272.  
  273. EDIT
  274. Undo        :Undo the last rotation.
  275. Copy        :Not implemented yet.
  276. Color...    :Let you select color values.
  277.             The cycle gadget at the bottom of the requester has two
  278.             position, "Color" and "Grey scale". Grey scale will give you
  279.             an approximation of what the printed result will look like.
  280. Palette...  :Let you change color palette value.
  281.              See Palette section for more info.
  282. TEMPLATE
  283. Load...     :Load a template file wich contain:
  284.              -the graph type.
  285.              -rotation positions.
  286.              -perspective setting.
  287. Save...     :Save a template file.
  288.  
  289. GRAPHTYPE
  290. Load...     :Load a new graph type, 2D or 3D.
  291.  
  292. ENVIRONMENT
  293. Iconify           :Not implemented yet (mmmmm).
  294. Notes...          :Let you leave a note on anything you want. If you
  295.                    press the icon at left, you will always be noticed of
  296.                    your note before quitting.
  297. Arrange           :Organize windows logically on the screen.
  298. Req. Flash ON/OFF :Enable/Disable requesters Display Beep.
  299. Exec Rexx...      :Request for an ARexx script to be executed.
  300. Preview OFF/ON    :Disable/Enable the preview window.
  301. Output Back/Front :When Output window is sized, send it to back or front on
  302.                    final rendering.
  303.  
  304. HELP
  305. General...  :General help system activation.
  306. On Help...  :Activate help on using the help system.
  307. Start Help  :Context-sensitive help. You just have to select the topic
  308.              on wich you need help to get it. Select back the same              option (renamed Stop Helper) to stop.
  309.  
  310. 5.Control panel window:
  311. -----------------------
  312.     The interface window (Control panel window) is the one with lots of
  313. gadget on it.
  314.  
  315. 1. The first line of gadget contain (from the right);identifier of the
  316. rotation axis, 'X' in this case, a scroll gadget wich select the value of
  317. the 'X' rotation and a string gadget which permits to enter the value
  318. numerically. The two other line do the same thing but for the 'Y' and 'Z'
  319. axes. Modification of any of the gadget updates the Preview window
  320. automatically.
  321. 2. The slider gadget named "Perspective" will, as their name implies, will
  322. change the perspective value; the more the cursor is sled to the left, the
  323. more the graph will look "deformed" (like a camera with a fish-eye), to
  324. opposite , sliding it to the right will yield in a more orthogonal-looking
  325. graph. This effect is just for visualisation, so it, it will not be saved
  326. in the "3D Geo" format.
  327. 5.The gadget titled "Undo" will undo the last rotation operation. Menu
  328. option "Undo" (Amiga-Z) will do the same thing.
  329. 6.The "Render" gadget will gives you the final output on the screen.
  330. 7.There is also a cluster of ten button at left. These can be programmed via
  331. Arexx to execute ARexx script when pressed. See details in Rexx scripts
  332. headers given with JcGraph.
  333.  
  334. 6.File format: Input:
  335. ---------------------
  336.  
  337. Here is the text file format description:
  338.  
  339. 1002,                       1. Data identifier. Always 1002.
  340. 4,2,80,6.0,                 2. #Columns,#Lines,Cotation space, Multiplier
  341. 10,20,30,40,                3. First ligne
  342. 50,60,60,80,                4. Second line
  343. Jan,Feb,Mar,Apr,            5. Text under each column.
  344. Gaz,Oil,                    6. Text under each line.
  345.  
  346. Notes: All value may vary between -1000 and 1000.
  347.        Data file should end with a comma.
  348.        When the multiplier is 0, numbers take the
  349.        integer form (ie without floating point).
  350.        All entries should be comma separated but can be logically
  351.        organized with "returns".
  352.  
  353. 7.File format: Output:
  354. ----------------------
  355. IFF ILBM:
  356. File format compatible with most commercial an public-domain paint program.
  357.  
  358. EPSF COLOR & GRAY:
  359. Encapsulated PostScript file format. For now, it is the only format in wich
  360. the legend will be automatically created. Unless you have a PostScript
  361. interpreter, this file cannot be printed on printer other than PostScript
  362. compatible ones. By default, the font used is "Times-Roman". Si you want to
  363. output your graph to the printer and you possess a PostScript printer, just
  364. save it as EPSF. Then, type to a CLI/SHELL prompt "copy FileName to SER:"
  365. if your printer is hooked to the serial port or "copy FileName to PAR:" if
  366. it is hooked to the parrallel port. Select COLOR or GRAY EPSF format
  367. depending on your printer capability.
  368.  
  369. 3D GEO:
  370. Three-dimensionnal file format compatible with most 3D modeler and renderer
  371. on the market: 3DProfessionnal, VideoScape, LightWave, Vertex, etc...
  372. Text are saved too!
  373.  
  374. Draw2000:
  375. Structured file format compatible with the following software:
  376. PageStream 2.2, Professionnal Page 3.0, AegisDraw2000. Will produce very
  377. high quality graphs even on dot-matrix printer. Note that I had some problem
  378. with the AegisDraw import module from PageStream. It seems not to recognize
  379. JcGraph's output.I had the same problems with graphs created with Advantage
  380. and Multiplot.
  381.  
  382. 8.Graph's modification.
  383. -----------------------
  384. 8.1 Font size.
  385.     You can modify font size. You have to edit the graph type with an ASCII
  386. editor. Font size for cotation is the third from the end of the ".grf" file.
  387. Font size of the lines' text is the fourth, and the colums' the fith. There
  388. is also a way to do it inside JcGraph if you got ARexx (look in ARexx script
  389. comments for details or see chapter 12).
  390.  
  391. 9.Keyboard equivalent.
  392. ----------------------
  393. PROJECT
  394. Right Amiga+O :Open...
  395. Right Amiga+S :Save
  396. Right Amiga+A :Save as...
  397. Right Amiga+1 :Format IFF ILBM
  398. Right Amiga+2 :Format EPSF
  399. Right Amiga+3 :Format 3D Geo
  400. Right Amiga+4 :Format Draw2000
  401. Right Amiga+P :Print...
  402. Right Amiga+Q :Quit...
  403.  
  404. EDIT
  405. Right Amiga+Z :Undo
  406. Right Amiga+K :Color...
  407. Right Amiga+, :Palette...
  408.  
  409. TEMPLATE
  410. Right Amiga+L :Load...
  411. Right Amiga+U :Save...
  412.  
  413. GRAPHTYPE
  414. Right Amiga+T :Load...
  415.  
  416. ENVIRONMENT
  417. Right Amiga+. :Notes...
  418. Right Amiga+R :Arrange...
  419.  
  420. HELP
  421. Right Amiga+G :General...
  422. Right Amiga+H :On Help...
  423. Right Amiga+J :Start Helper/Stop Helper
  424.  
  425. COLOR SELECTOR:
  426. Right arrow   : Select next color.
  427. Left arrow    : Select preceding color.
  428. Up arrow      : Select next line.
  429. Down arrow    : Select preceding line.
  430.  
  431. OTHERS:
  432. F1            : Open/Close preview window.
  433. F6 to F10     : ARexx controlled.
  434.  
  435. NB: ESC will get you back from most requester.
  436.  
  437. 10. Palette requester
  438. ---------------------
  439.   This requester will help you change the default color palette of the screen
  440. JcGraph is on using both RGB and HSV color model. At the top, there is some
  441. standard intuition gadget (ie Close, Depth, etc...) that need not to be
  442. documented here (refer to your user manual). The first, leftmost gadget you
  443. will see is a recessed box that shows the color actually active. Click on any
  444. color at the bottom of the requester and you will it changed accordingly.
  445. Right of this gadget is marked vertically with letters RGB followed by three
  446. sliders. It means that you are in the RGB model an that every one of the Red,
  447. Green and Blue component of the active color can be modified with the
  448. appropriate slider at right. Note that values, ranging from 0 to 15,
  449. representing the amount of each RGB component are written at slider's right.
  450. This color palette selector also offers you the possibility to work with
  451. the HSL color model (meaning Hue, Saturation and Luminance), you just have
  452. to click on the area marked RGB to see it changed to HSL, click back on HSL
  453. to return to the RGB color model.
  454.   The big, full-color, rectangular gadget at the bottom of the requester is
  455. quite self-explanatory; it helps you choose the color you want to be activated.
  456.   Next to it, at right, is a kluster of gadget that are decribed here:
  457.  
  458. COPY:   Copy the active color on to another that you will choose after.
  459. RANGE:  Will create a range between two color that you will specify.
  460. OK:     Close the requester and keep your modification
  461. CANCEL: Cancel all the change you may have done to the color palette.
  462.  
  463. The menu:
  464.  
  465. Open...: Load a color palette previously saved. Note that because it is
  466.          IFF format, JcGraph can find color palette in almost any IFF file that
  467.          as CMAP chunk (ie Preferences palette, DR2D file, ILBM, Imagine file,
  468.          etc...), this is handy.
  469. Save As...: This will save you color palette to a file wich will then be accesible
  470.             with any IFF CMAP palette reader. (Note that some palette reader
  471.             make some false assumption about IFF and may have trouble loading
  472.             JcGraph's IFF file, notabily FreePaint and Commodore's own Palette
  473.             preferences (on 2.0)!!!)
  474. Copy:     Copy the entire color palette to the Clipboard.
  475. Paste:    Paste the entire color palette from the Clipboard. (note: that's a
  476.           shame that so few program do that :-()
  477.  
  478.   Note that pressing ESC on the keyboard or closing the window will have the
  479. same effect as clicking on CANCEL gadget.
  480.  
  481. 11.TOOLTYPE and command line options.
  482. -------------------------------------
  483. SCREEN=custom       :Start JcGraph on a custom screen.
  484. SCREEN=workbench    :Start JcGraph on the workbench.
  485. HELPENGINE=file     :Where 'file' is the Help engine used by JcGraph.
  486. TOOLPRI=-127 to 127 :Is JcGraph's task priority.
  487. PORTNAME=name       :Where 'name' is the JcGraph's ARexx port name.
  488. STARTUP=scriptname  :Where 'scriptname' is an ARexx script to be executed
  489.                      on startup.
  490.  
  491. N.B.: Most of the ToolType are commented out by default using '(' and ')'.
  492.  
  493. 12. ARexx Interface:
  494. --------------------
  495.   There is now an ARexx interface for JcGraph. Of course, if you're using
  496. 1.3 or below, you need the commercial ARexx package from William Hawes or better,
  497. spend some money on 2.0. JcGraph rely heavily on ARexx for some of it's
  498. new functions like Windows default position, Rexx Button, HotKeys etc...
  499. I think I implemented a good set of Rexx commands. The one I like the most
  500. is the 'Button' command which open a world of possibilities to the user willing
  501. to learn ARexx. Default startup script is a good example of Button command.
  502. Feel free to modify my script and to distribute them (If there is one you
  503. think that could be useful to other people, send it to me, I will include it
  504. in the registered version sent to my users)
  505.  
  506. There is 40+ ARexx commands available from JcGraph.
  507. These are (in alphabetical order):
  508.  
  509. ActivateWindow:
  510.       Function: Select a window to be the current one.
  511.       Input: INTERFACE/K,OUTPUT/K,PREVIEW/K.
  512.       Output: None.
  513.       Note: None.
  514.       See also: None.
  515.  
  516. Button:
  517.       Function: Assign a script to one of the ten screen gadget.
  518.       Input: button number (1 to 10),LABEL=,script path and name.
  519.       Output: None.
  520.       Note: ex:"button 7 label=Rend JcGraph:test/tess.rex"
  521.                Parameter's position can't be changed.
  522.       See also: Keyboard.
  523.  
  524. Close:
  525.       Function: Quit JcGraph.
  526.       Input: FORCE/S.
  527.       Output: None.
  528.       Note: Same as Quit (only there to be Style Guide complient)
  529.       See also: Quit.
  530.  
  531. Copy:
  532.       Function:
  533.       Input:
  534.       Output:
  535.       Note: Should be activated in version 1.2.
  536.       See also:
  537.  
  538. GetDataColor:
  539.       Function:
  540.       Input:
  541.       Output:
  542.       Note: Should be activated in version 1.2.
  543.       See also:
  544.  
  545. GetFormat:
  546.       Function: Return JcGraph's current output file format.
  547.       Input: None.
  548.       Output: As string:
  549.               1- IFF ILBM
  550.               2- EPSF Gray
  551.               3- EPSF Color
  552.               4- 3D Geo
  553.               5- Draw 2000
  554.       Note: None.
  555.       See also: SetFormat.
  556.  
  557. GetGraphType:
  558.       Function: Returns the path to the curent graph type file + filename.
  559.       Input: None.
  560.       Output: path + filename.
  561.       Note: If returned value is DFLT, it means that no graph type has been
  562.             loaded and the default one is used. If no string is returned,
  563.             it means that no graph type is vailable.
  564.       See also: LoadGraphType.
  565.  
  566. GetRotation:
  567.       Function: Returns X,Y and Z rotation values.
  568.       Input: None.
  569.       Output: X, Y and Z values respectivly as string, space separated.
  570.       Note: ex:"12 34 45".
  571.       See also: SetRotation,GetX,GetY,GetZ,SetX,SetY,SetZ.
  572.  
  573. GetScreenAddress:
  574.       Function: Get JcGraph's screen structure pointer.
  575.       Input: None.
  576.       Output: None.
  577.       Note: Useful to seemlessly integrate your code with JcGraph.
  578.       See also: none.
  579.  
  580. GetTypeValue:
  581.       Function: Returns graph type specific data.
  582.       Input: Data position.
  583.       Output: Value as string.
  584.       Note: The data index value is absolutly not validated, so, be careful.
  585.       See also: SetTypeValue.
  586.  
  587. GetX:
  588.       Function:  Returns X rotation value.
  589.       Input: None.
  590.       Output: X rotation value string.
  591.       Note: None.
  592.       See also: SetRotation,GetRotation,GetY,GetZ,SetX,SetY,SetZ.
  593.  
  594. GetY:
  595.       Function:  Returns Y rotation value.
  596.       Input: None.
  597.       Output: Y rotation value string.
  598.       Note: None.
  599.       See also: SetRotation,GetRotation,GetX,GetZ,SetX,SetY,SetZ.
  600.  
  601. GetZ:
  602.       Function:  Returns Z rotation value.
  603.       Input: None.
  604.       Output: Z rotation value string.
  605.       Note: None.
  606.       See also: SetRotation,GetRotation,GetY,GetX,SetX,SetY,SetZ.
  607.  
  608. Keyboard:
  609.       Function: Assign an ARexx script to key F6 to F10.
  610.       Input: KEY/K,CMD/K.
  611.       Output: None.
  612.       Note: ex:"Keyboard key=F6 cmd=rexx:test.rex"
  613.       See also: Button.
  614.  
  615. LoadGraphType:
  616.       Function: Load a new type of graphic.
  617.       Input: filename.
  618.       Output: None.
  619.       Note: ex:'LoadGraphType work:jcgraph/graphtype/gugusse3D.grf'
  620.             If no filename is given, a file requester will pops-up.
  621.       See also: GetGraphType.
  622.  
  623. MoveWindow:
  624.       Function: Set the current window's position.
  625.       Input: TOPEDGE/K,LEFTEDGE/K.
  626.       Output: Window position before moving it (LeftEdge and TopEdge).
  627.       Note: Value of -1 in TopEdge or LeftEdge fields will result in no change
  628.             in position.
  629.       See also: SizeWindow.
  630.  
  631. Nop:
  632.       Function: Does absolutly nothing.
  633.       Input: None.
  634.       Output: None.
  635.       Note: None.
  636.       See also: None.
  637.  
  638. Open:
  639.       Function: Opens a JcGraph ASCII data file.
  640.       Input: FILENAME/K.
  641.       Output: None.
  642.       Note: If no filename is given, a requester asking for one will pop-up.
  643.       See also: Close, Quit.
  644.  
  645. Print:
  646.       Function: Dumps the graph to the  printer.
  647.       Input: none.
  648.       Output: 10= no graph rendered.
  649.       Note: None.
  650.       See also: None.
  651.  
  652. Quit:
  653.       Function: Quit JcGraph.
  654.       Input: FORCE/S.
  655.       Output: None.
  656.       Note: Force suppresses the modified project requester.
  657.       See also: Close.
  658.  
  659. Render:
  660.       Function: Render a graph using current settings.
  661.       Input: None.
  662.       Output: None.
  663.       Note: If no data or graph type is loaded, a requester will pops-up
  664.             telling you so.
  665.       See also: None.
  666.  
  667. RequestFile:
  668.       Function: Pops up a file requester.
  669.       Input: TITLE/K,PATH/K,FILE/K,PATTERN/K.
  670.       Output: RC=0->OK, RC=5->CANCEL, RESULT=full path + file.
  671.       Note: None.
  672.       See also: RequestString,RequestNumber,RequestResponse,RequestNotify.
  673.  
  674. RequestNotify:
  675.       Function: Pops a requester with some text and OK gadget.
  676.       Input: message.
  677.       Output: None.
  678.       Note: This is slightly different from the Style Guide;
  679.             ex: 'RequestNotify This is the message'
  680.       See also: RequestString,RequestNumber,RequestResponse,RequestFile.
  681.  
  682. RequestNumber:
  683.       Function: Pops a requester with text, Integer, OK and CANCEL gadgets.
  684.       Input: message.
  685.       Output: if RC=0 -> OK, RC=5 -> CANCEL . Result=Number as string.
  686.       Note: This is slightly different from the Style Guide;
  687.             ex: 'RequestNumber This is the message'
  688.       See also: RequestString,RequestNotify,RequestResponse,RequestFile.
  689.  
  690. RequestResponse:
  691.       Function: Pops a requester asking for a OK/CANCEL response.
  692.       Input: message.
  693.       Output: RC=0 if OK, RC=5 if CANCEL.
  694.       Note: This is slightly different from the Style Guide;
  695.             ex: 'RequestResponse This is the message'
  696.       See also: RequestString,RequestNumber,RequestNotify,RequestFile.
  697.  
  698. RequestString:
  699.       Function: Pops a requester with text, String, OK and CANCEL gadgets.
  700.       Input: message.
  701.       Output: if RC=0 -> OK, RC=5 -> CANCEL . Result=string.
  702.       Note: This is slightly different from the Style Guide;
  703.             ex: 'RequestString This is the message'
  704.       See also: RequestNumber,RequestNotify,RequestResponse,RequestFile.
  705.  
  706. Rx:
  707.       Function: Execute a rexx script asynchronously.
  708.       Input: Rexx script name.
  709.       Output: None.
  710.       Note: This is slightly different from the Style Guide;
  711.             ex: 'Rx work:test.rex'
  712.       See also: None.
  713.  
  714. Save:
  715.       Function: Save the graph using current output format.
  716.       Input: None.
  717.       Output: None.
  718.       Note: None.
  719.       See also: SaveAs.
  720.  
  721. SaveAs:
  722.       Function: Save the graph using current output format with
  723.                 the specified name.
  724.       Input: NAME/K.
  725.       Output: None.
  726.       Note: If no name is given, a file requester will pops-up.
  727.       See also: Save.
  728.  
  729.  
  730. ScreenToBack:
  731.       Function: Brings JcGraph's screen to back.
  732.       Input: None.
  733.       Output: None.
  734.       Note: None.
  735.       See also: ScreenToFront.
  736.  
  737. ScreenToFront:
  738.       Function: Brings JcGraph's screen to front.
  739.       Input: None.
  740.       Output: None.
  741.       Note: None.
  742.       See also: ScreenToBack.
  743.  
  744. SetDataColor:
  745.       Function:
  746.       Input:
  747.       Output:
  748.       Note: Should be activated in version 1.2.
  749.       See also:
  750.  
  751. SetDisplayBeepOn:
  752.       Function: Enable screen flashes when a requester appear.
  753.       Input: None.
  754.       Output: None.
  755.       Note: None.
  756.       See also: SetDisplayBeepOff.
  757.  
  758. SetDisplayBeepOff:
  759.       Function: Disable screen flashes when a requester appear.
  760.       Input: None.
  761.       Output: None.
  762.       Note: None.
  763.       See also: SetDisplayBeepOn.
  764.  
  765. SetFormat:
  766.       Function: Set current JcGraph output file format.
  767.       Input: File format number.
  768.       Output: 0 if ok, 10 otherwise.
  769.       Note:   Format number:
  770.  
  771.               1- IFF ILBM
  772.               2- EPSF Gray
  773.               3- EPSF Color
  774.               4- 3D Geo
  775.               5- Draw 2000
  776.       See also: GetFormat.
  777.  
  778. SetRotation:
  779.       Function: Set X,Y and Z rotation value respectivly.
  780.       Input: x value, y value, z value.
  781.       Output: None.
  782.       Note: ex: "SetRotation 12 32 14"
  783.       See also: SetX, SetY, SetZ, GetX, GetY, GetZ, GetRotation.
  784.  
  785. SetTypeValue:
  786.       Function: Set graph type specific data.
  787.       Input: index of value to be changed, value.
  788.       Output: None.
  789.       Note: Value and inded aren't validated at all, so, be carefull.
  790.       See also: GetTypeValue.
  791.  
  792. SetX:
  793.       Function: Set X rotation value.
  794.       Input: value.
  795.       Output: None.
  796.       Note: ex: "SetX 10"
  797.       See also: SetY, SetZ, GetX, GetY, GetZ, GetRotation, SetRotation.
  798.  
  799. SetY:
  800.       Function: Set Y rotation value.
  801.       Input: value.
  802.       Output: None.
  803.       Note: ex: "SetY 10"
  804.       See also: SetX, SetZ, GetX, GetY, GetZ, GetRotation, SetRotation.
  805.  
  806. SetZ:
  807.       Function: Set Z rotation value.
  808.       Input: value.
  809.       Output: None.
  810.       Note: ex: "SetZ 10"
  811.       See also: SetY, SetX, GetX, GetY, GetZ, GetRotation, SetRotation.
  812.  
  813. SizeWindow:
  814.       Function: Set the current window's size.
  815.       Input: WIDTH/N,HEIGHT/N.
  816.       Output: Window size before sizing it (Width and Height).
  817.       Note: Value of -1 in width or height fields will result in no change
  818.             in size. Interface window can't be sized, so, it will only
  819.             return it's size.
  820.       See also: MoveWindow.
  821.  
  822. Version:
  823.       Function: To get JcGraph's version number.
  824.       Input: None.
  825.       Output: Version number in form 'ProgramName 9.99 (DD/MM/YY)'
  826.       Note: None.
  827.       See also: None.
  828.  
  829. WindowToFront:
  830.       Function: Brings current window to front.
  831.       Input: None.
  832.       Output: None.
  833.       Note: None.
  834.       See also: WindowToBack, ActivateWindow.
  835.  
  836. WindowToBack:
  837.       Function: Brings current window to back.
  838.       Input: None.
  839.       Output: None.
  840.       Note: None.
  841.       See also: WindowToFront, ActivateWindow.
  842.  
  843. 13.Graph type file format:
  844. --------------------------
  845.   I think this is one of the best part of JcGraph (from a programmer's point
  846. of view) it brings me back about 2 years ago: I have seen some Amiga, Mac and
  847. PC charting program and what striked me is that it seemed that there was a piece
  848. of code for each one of the graphs... what a waste! There was surely a way to
  849. draw a general rule for creating all the graphs and after some hours of
  850. refining an inital idea, I came up with this:
  851.  
  852. 1001,             : Graph type identifier.
  853.  
  854. GraphType points:
  855. -----------------
  856. Points are organized in two sets of X,Y values. First X,Y set is for
  857. the bottom of the block, second , for the top.
  858.  
  859. 4,                : Total number of points of one block.
  860.  
  861. 0,0,              : 1. X,Y of the bottom.
  862. 0,20,             : 1. X,Y of the top.
  863.  
  864. 40,0,             : 2. X,Y of the bottom.
  865. 40,20,            : 2. X,Y of the top.
  866.  
  867. 40,40,            : 3. X,Y of the bottom.
  868. 40,20,            : 3. X,Y of the top.
  869.  
  870. 0,40,             : 4. X,Y of the bottom.
  871. 0,20,             : 4. X,Y of the top.
  872.  
  873. Inter-block links:
  874. ------------------
  875. 2,3,1,4,         : If link flag is set, point 2 of the one block will be
  876.                    linked with point 1 of the following X block. 3 linked to
  877.                    4. Just two links per side are allowed.
  878. 3,4,2,1,         : If link flag is set, point 3 of the one block will be
  879.                    linked with point 2 of the following Y block. 4 linked to
  880.                    1. Just two links per side are allowed.
  881.  
  882. GraphType Flags:
  883. ----------------
  884. 2,2,              : X , Y data rows and columns of preview.
  885. 70,               : Next column spacing.
  886. 70,               : Next line spacing.
  887. 2,                : Y  data multiplier.
  888. 0,                : Joined X ? (0 or 1)
  889. 0,                : Joined Y ? (0 or 1)
  890. 0,                : Stacked ? (0 or 1)
  891. 1,                : 3-D ? (0 or 1)
  892. 0,                : Percent (pie chart) ? (0 or 1)
  893. 0,                : Block top only ? (0 or 1)
  894. 0,                : Inter-block only ? (0 or 1)
  895. 0,                : 90 degree rotation of block ? (0 or 1)
  896. 0,                : Next line shear value.
  897. 0,                : ALWAYS 0.
  898. 0,                : SIDEBYSIDE ( 0 or 1)
  899. 0,                : Y shear value.
  900. 0,                : Undefined.
  901. 40,               : Max. X block size.
  902. 40,               : Max. Y block size.
  903. 15,               : Font scale to X (scale to points value)
  904. 15,               : Font scale to Y.
  905. 15,               : Font scale to Z.
  906. 10,               : Z text offset from graph.
  907. 20,               : X text offset from graph.
  908.  
  909. I think this design is a good compromise between flexibility, simplicity and
  910. size. Experiment with it... no validation is done on graph type but anyway,
  911. you should know what you are doing when creating a new graph type.
  912. Of course, this is FAR from perfection and I now see many possible upgrades
  913. to this format that would require a severe re-write of most part of my code
  914. and unless some gigantic mega software compagny pay me to do that, I will
  915. leave this to the reader. Of course, you cannot use this in commercial code
  916. but if you want to share some ideas, write to me, I will be pleased to answer
  917. your letter.
  918.  
  919. 14.The future of JcGraph:
  920. -------------------------
  921.  
  922. It is sad because I haven't had enough registration to be worth continuing
  923. to upgrade JcGraph. Maybe I haven't spread it enough but I guess it's not
  924. just that.  What bugs me the most is that every people that tried my software
  925. seemed to enjoy it a lot.
  926. JcGraph was many things to me:
  927. First, it was a proof that I can take a programming project of good proportion
  928. (for a single person) from the ground up to a commercial quality state (I think so).
  929. Second, it was an answer to those stupid pirates who say "Ah, software are too high
  930. priced and all the money goes to a big guy in a Rolls-Royce". Well, my piece
  931. of code hasn't any equivalent on the Amiga market yet(and in some way, on any market)
  932. . And I have no other mean of transportation than my own
  933. legs. Anyway, if you don't want my software, you can still mail to me, I
  934. stand for communication and I like to ear from people. I'm sorry for all the
  935. people that supported my work but I don't have any more time and money to
  936. spend on upgrading JcGraph and that's why it will now be freely
  937. redistributable. If my bank account wasn't showing -0.13$, I would even
  938. consider refunding all of my registered users but they must understand that
  939. I'm not in the financial position to do so...
  940.  
  941. The sad part is that my future programming efforts will probably be on
  942. the PC side where I can hope to survive. At leat, I've done my part...
  943.  
  944. BUT, if you use it and like it, please send me a postcard of the city/town
  945. you live in with some words (how do you like JcGraph, what are you doing
  946. with it, or anything else you want to tell me about anything).
  947. Thank you much... I'm waiting for your postcard !
  948. (of course, if you find my code worth some money, you can send it too!, it
  949. will sure help me finish my graduation at University of Sherbrooke, CANADA)
  950.  
  951. So, you can consider it POSTCARD-WARE...
  952.  
  953. Any comment can be sent to:
  954.  
  955.             Jean-Christophe ClΘment
  956.             921, rang 3
  957.             St-Simon
  958.             QuΘbec, CANADA
  959.             J0H-1Y0
  960.  
  961. 15.JcGraph's history:
  962. ---------------------
  963.  
  964. april 23 , 1992:(v0.90)
  965.     -Beta release.
  966.  
  967. april 27 , 1992:(v0.901)
  968.     -Corrected little mem alloc bug.
  969.  
  970. april 30 , 1992:(v0.902)
  971.     -Added precision on 2D graphs.
  972.     -Stack graph added.
  973.     -Better support for floating point value.
  974.  
  975. may 14 , 1992:(v0.903)
  976.     -Corrected one small problem with perspective.
  977.  
  978. october 10 , 1992:(v1.100)
  979.     Major upgrade!!
  980.     -Corrected some stupid bugs (no more problem on quit.)
  981.     -Added an ARexx port (40+ commands) almost fully 2.0 style guide compliant.
  982.     -Now supports the standard file requester under WB 2.0 (so that you can
  983.      trap it with the incredible "Magic File Requester" from Stefan Stuntz.
  984.      Boy, this requester is 1/2 as big as JcGraph (80k vs 170k) but worth every
  985.      single bytes!). For those poor people who still use WB < 2.0... Get it (2.0)
  986.      the soonest possible, you won't regret it. But until then, JcGraph will
  987.      use the KD_freq for you!!
  988.     -Well, it's been one months I've been using JcGraph about 5 hour a day
  989.      and it has not crashed on me once. Configuration were varying from 512k
  990.      to 3 full megs. So, I guess I can say it is quite robust now...
  991.     -JcGraph now come with a nice disk sticker!!
  992.     -A nice Color Palette editor has been added based on one done by
  993.      RJ Mical with some aestethic and ergonomic enhancement.
  994.     -Should not have problem with bigger fonts anymore.
  995.     -Preview can now be sized and closed.
  996.     -MANY useful Rexx scripts are included.
  997.     -JcGraph does some more file checking on data.
  998.     -more startup options.
  999.     -other small stuff that you will be happy to discover yourself !!
  1000.  
  1001. january 07 , 1993:(v1.110)
  1002.     -Now save 3D Geo object as 2-sided polygons (about time, eh !!??).
  1003.     -New ARexx script for Advantage "HotLinking".
  1004.  
  1005. february 27, 1993:(v1.12)
  1006.     -small memory alloc patch.
  1007.  
  1008. august 15, 1993:(v1.13)
  1009.     -Now freely distributable.
  1010.     -Some optimization was done (176k to 164k).
  1011.  
  1012. Thanks to:
  1013. Richard Loubier, Pierre-Louis Constantin, Steve Davis, Dominic Giampaolo and
  1014. all those who supported my work on JcGraph.
  1015. Very special thanks to:
  1016. Francis Lai and Claude Lelouch for "La belle Histoire",
  1017. Vangelis and Ridley Scott for "1492:Conquest of paradise"
  1018. which helped me pass trough my University exams!