home *** CD-ROM | disk | FTP | other *** search
/ Frozen Fish 1: Amiga / FrozenFish-Apr94.iso / bbs / alib / d9xx / d958 / fed-case.lha / Fed-CASE / Readme < prev    next >
Text File  |  1993-12-04  |  9KB  |  229 lines
  1.  
  2.  
  3.  
  4.  
  5. In this document you will find the product information about Fed-CASE
  6. and a small manual to explain the basic functions off the flowchart-
  7. editor.
  8.  
  9. This demo version is freely distributable. The archive may not be
  10. modified.
  11.  
  12. If you want information about a distributor of Fed-CASE in your
  13. country, write to
  14.  
  15.         Joosen Software Development
  16.         Dr. J.M. den Uylstraat 32
  17.         4908 CT Oosterhout (N-Br)
  18.         The Netherlands
  19.         
  20.         Tel. (31) 1620 35348
  21.  
  22.         e-mail:    christian@ecl008.adsp.sub.org
  23.  
  24.  
  25.  
  26.  
  27.  
  28. Product information FED-CASE
  29. ----------------------------
  30.  
  31.  
  32. What is it about?
  33.  
  34. FED-CASE(©) for the Amiga is a software tool that can assist 
  35. the design of software. 
  36.  
  37. FED-CASE(©) consists of a graphical environment 
  38. to design flows the  flowchart editor and a source code 
  39. generator that generates C source code.
  40.  
  41. FED-CASE(©) package consists of a clearly written manual and 
  42. the software. De manual consists of 160 pages.
  43. The software runs on any amiga with 1 Mb of memory. 
  44. FED-CASE(©) can run under all available Amiga operating 
  45. system releases. FED-CASE(©) is full compatible with Amiga OS 3.x, 
  46. and will have the same look and feel as OS 2.0 and upwards.
  47.  
  48. FED-CASE(©) is easy to use and has logical symbols to define 
  49. the design. 
  50. Because of the fact that FED-CASE(©) represents the design 
  51. in a graphical way the designer has a better overview 
  52. of the function he/she is designing. 
  53. A lot of companies are designing their products from flowchart 
  54. sequence diagrams, these diagrams are drawn manually 
  55. with the aid of rulers. 
  56. Using the FED-CASE(©) flowchart editor will cut down 
  57. their design time.
  58.  
  59. With the build in printer facilities they will get a better 
  60. documentation of their product. 
  61. One other benefit of using the tool is that maintenance 
  62. costs will decrease considerably. 
  63.  
  64. Figures from earlier researches point out that 25-40% of all 
  65. costs made in software engineering are maintenance activities.
  66.  
  67. Although FED-CASE(©) is running on amiga computer systems, 
  68. the generated code can be used to be compiled for any other 
  69. C compiler on any computer system.
  70.  
  71. Features:
  72.  
  73. The flowchart editor offers a graphical environment 
  74. to the designer that gives him the possibility to create 
  75. flowcharts. 
  76. All symbols are on display. 
  77. A number of functions are implemented to edit the flowchart
  78. (insert, move, delete, connect, undo, etcetera). 
  79. A main part of the function can be accessed by menu, 
  80. keyboard short-cut or on display gadgets.
  81.  
  82. A text editor enables the designer to add text to the symbols. 
  83.  
  84. The print option makes a paper copy of the flowcharts. 
  85. The flowcharts are divided into chapters and pages so that 
  86. good documentation is guaranteed. 
  87.  
  88. The paper copy can also be made in such a manner that it is 
  89. possible to use company paper with headings.
  90.  
  91. FED-CASE(©) is a fully localized application. 
  92. This means that it can be adapted to any kind of 
  93. natural language. 
  94.  
  95. FED-CASE will determine what kind of video system it is running
  96. on. It will switch to the appropriate system (NTSC/PAL).
  97. Under OS >2.0 it uses the display database.
  98.  
  99. The package comes along with a number of localized languages, 
  100. but it can be easily adapted to any other language by the user.
  101.  
  102. It is possible to invoke the code generator from the flowchart
  103. editor and view the results in your favourite text editor.
  104.  
  105. The FED-CASE(©) code generator generates C-source code according 
  106. to the C source code definition. This is including the 
  107. declaration and prototyping part of the source code.
  108. The code generator will automatically do the type casting and
  109. argument checking.
  110. An auto-comment function will take care of commenting the C source
  111. code with all kind of helpfull information. The source code
  112. generator will take care of the includes and put all the required
  113. includes into the source code.
  114.  
  115. So you can generate code for any C compiler on any 
  116. target machine. 
  117. It is possible to generate source code for a C compiler 
  118. on an UNIX operating system or a PC operating system.
  119.  
  120. FED-CASE(©) can be installed on harddisk using Commodore's installer.
  121.  
  122.  
  123. FED-CASE, FED-CASE sourcerer,FED-CASE editor are trademarks of
  124. Joosen Software Development, all other brands and product names are
  125. trademarks of their respective holders.
  126.                             
  127.         
  128.  
  129.  
  130. Overview of the functions in the flowchart editor.
  131. --------------------------------------------------
  132.  
  133. To start the program you can click on the icons in the workbench.
  134. If you want to enter the commands from the CLI enter the command
  135. name with no option or filenames. The build in help function will give the 
  136. correct syntax or options. You can also enter "type s:fdc.help" to get the
  137. same help printout.
  138.  
  139. You can move the symbol cursor around by using the cursor-keys, the NUM-pad
  140. or the mouse pointer.
  141. The home, ctrl-home, end, control-end, page down, page up work in the
  142. usual way.
  143.  
  144. You can enter a symbol by using the <enter>-key, mouse button or the
  145. insert-gadget in the symbol window.
  146.  
  147. To delete symbols move de cursor over the symbol and press the <D>-key
  148.  
  149. To connect symbols press the <C>-key. In the status window a message 
  150. will prompt you to select the first symbol to connect from and once 
  151. selected it will prompt you to move the cursor to the symbol to connect to.
  152.  
  153. To add text to a symbol first move the cursor to the right position and
  154. press the <T>-key a small text editor will be available.
  155.  
  156. To open a flow in a current window press the <O>-key
  157. The filerequester appears and you can select a file.
  158.  
  159. The <u>-key undos the last action
  160.  
  161. When you press the <h>-key the chapter edit window opens and you 
  162. can add or rename chapters.
  163.  
  164. If you want to copy a part of the flowchart you can move the cursor to 
  165. the right position. You can do this by using the cursor keys or to move 
  166. the mouse pointer to the symbol position you want and press the right 
  167. mouse button. Hereafter you should  press the <F1>-key. The  program will 
  168. buffer the sequence following the cursor. You can also access this option 
  169. from the menu. To use the menu you have to move the mouse to the top of 
  170. the screen and push and hold the right button on your mouse. The top line 
  171. will change color and reveal a list of items. Move to the symbol menu and 
  172. go down with the mouse. The menu items will change color, when the copy  
  173. field changes color you should release the mouse-button.
  174.  
  175. To paste the buffered sequence move to the position where you would like 
  176. to insert the sequence. The new position can also be in a different flowchart 
  177. edit window. Just select the window  and move the cursor to the desired 
  178. position. and press the <F2>-key.  You can also access this option from 
  179. the menu. 
  180.  
  181. You cannot start code generation from the flowchart editor in the demo
  182. version of the flowchart editor. The code generator is in the same
  183. directory as the flowchart editor. To generate the source code of
  184. one of the examples type in the shell: code <name of flow>.
  185. Press the help keys to view the generated source code.
  186. The program 'more' must be accessable.
  187.  
  188. If you are on a label symbol you can jump to the other end by pressing 
  189. the <F4>-key . The program will try to find the other label symbol position 
  190. and display the page with the cursor on the other label symbol. 
  191.  
  192. Sometimes it is good that you can copy an entire page. A copied page will 
  193. be buffered and can be inserted where you would like it to have. Also in 
  194. an other flowchart edit window. If the current page is the one to be copied, 
  195. just press  the <F6>-key. The page is now copied into a special page buffer.
  196. It is also possible to copy the page from the menu.
  197.  
  198. To move to the previous page you can press the <F9>-key.
  199. The flowchart editor will move to the previous page. Adjust the page number 
  200. in the top border of the flowchart edit window and draw the flowchart in it.
  201.  
  202. To move to the next pages you  can press the <F10>-key.       
  203. The flowchart editor will move to the next page. Adjust the page number in 
  204. the top border of the flowchart edit window and draw the flowchart in it.
  205.  
  206. If you want to create a new chapter you can press the <H>-key
  207. and you will come  in the chapter edit window. You can also access the chapter 
  208. edit window if you use the menu. To do this move the mouse pointer to the top 
  209. of the screen and hold the right mouse button . Move to the chapter menu and 
  210. move to the edit field. Release the mouse button and the chapter edit window 
  211. will be on display.
  212.  
  213. To print a flowchart on a printer you must enter the <P>-key on the keyboard. 
  214. The flowchart editor will use the default printer that you have defined in 
  215. your preferences of your amiga system. After this you will be in the printer 
  216. window within this window you can change some of the page definitions. 
  217. The flowchart editor will print on every page the author's name, the name 
  218. of the flowchart, the date of creation and the revision. You can change 
  219. these options. If you do not want these fields printed leave them blank. 
  220. You can also print the flowchart starting a certain page and let the printing 
  221. stop at a certain page.
  222.  
  223. If you want to exit the current flowchart, you can press the <X>-key on your 
  224. keyboard. The flowchart editor will terminate the current flowchart, if 
  225. there have been changes the flowchart editor will prompt you if this 
  226. flowchart should not be saved before exiting. If you do not want to save 
  227. you can select the YES-gadget. If you select the NO-gadget the system will 
  228. display a file-requester.
  229.