home *** CD-ROM | disk | FTP | other *** search
/ Club Amiga de Montreal - CAM / CAM_CD_2.iso / files / 712b.lha / Struct-Saver_v1.20 / Struct-Saver.doc.pp / Struct-Saver.doc
Text File  |  1992-12-28  |  5KB  |  131 lines
  1.  
  2.                             Struct-Saver 1.20
  3.                             *****************
  4.  
  5.             (sorry for this nice name, I had no better idea yet)
  6.  
  7.                       Documentation by Thies Wellpott
  8.                       (excuse my bad English, please)
  9.  
  10.  
  11. 1. Copyright
  12. ************
  13.  
  14. Struct-Saver is FreeWare (c) 1992 Thies Wellpott. You may copy it for free
  15. provided that
  16.         - no profit is made with it
  17.         - Struct-Saver is not included with commercial software without
  18.           written agreement from the owner of the copyright
  19.         - Struct-Saver is distributed with this documentation file,
  20.           "Struct-Saver.doc" and both files are unmodified
  21.  
  22. The source code is for personal use only. It need not to be distributed
  23. along with the program, but if it is the whole source code must be kept
  24. with it.
  25.  
  26.  
  27. 1.1. Warrenty
  28. *************
  29.  
  30. YOU USE THIS PROGRAM COMPLETELY ON YOUR OWN RISK! If you destroy any file,
  31. your computer, your car or even the whole universe or any part of it while
  32. using it, do not blame me, it is not my fault!
  33.  
  34.  
  35. 2. Introduction
  36. ***************
  37.  
  38. Imagine the following situation:
  39.  
  40. You own OS 2.0 and have written a program using gadtools` great menu and
  41. gadget tools. The program is nice, useful and you think it is worth running
  42. under Kickstart 1.2/1.3, too. You check the things that must be changed and
  43. suddenly your eyes see the menu definitions. Argh! Kickstart 1.2/1.3
  44. requires the whole menu structure defined byte by byte, a nice work for
  45. your holidays.
  46.  
  47. Here comes the trick: YOU own OS 2.0 and gadtools builds up the whole menu
  48. definition in your memory! Start your program and start Struct-Saver, enter
  49. the filename, select your options and then press "Menus". Activate your
  50. program window while Struct-Saver counts down its timer. Wait a few seconds
  51. and you have a complete menu structure definition you may use with
  52. Kickstart 1.2/1.3.
  53.  
  54. Until now the source code is available only for C-programmers. Another
  55. problem are the gadgets. Gadtools uses the Intuition boopsi. You get the
  56. gadget structures but they are incomplete. I realized this after having
  57. coded the gadget-structure-save routines and I do not want to throw them
  58. away.
  59.  
  60.  
  61. 3. Usage
  62. ********
  63.  
  64. Struct-Saver is runnable from Workbewnch and from CLI/Shell and requires
  65. OS 2.0 (because it is for OS 2.0 users/programmers). If Struct-Saver cannot
  66. load the file "S:Struct-Saver.config" the screen beeps. Then a window
  67. opens.
  68.  
  69. Short description of the mega big menu:
  70.  
  71. "Save configuration" saves the current config. (wait time, line length,
  72. options, window position) to "S:Struct-Saver.config".
  73. "About" displayes program information.
  74. "Quit" quits.
  75.  
  76. Now have a closer look at the gadgets:
  77.  
  78. "Filename" sets the name of your source-code filename (the gadget is a
  79. string gadget, perhaps you missed the arrows? :-) ).
  80. "Wait time" sets the countdown time.
  81. "Line len" sets the maximum length of one line of the source code. You can
  82. format your source a bit with this.
  83. "use defines" uses the define-names (JAM1, BOOLGADGET, etc.) instead of
  84. hexadecimal or decimal numbers. The 1.2/1.3 defines are used, because the
  85. source code is for 1.2/1.3 !
  86. "expanded" formats the source code for better legibility. Between the
  87. structures there is a blank line and matching values have their own line.
  88.  
  89. "Gadgets" and "Menus" are the action gadgets. If you click on either the
  90. title bar counts down a timer from "Wait time" to zero. Then the gadgets or
  91. menus of the CURRENTLY ACTIVE WINDOW will be saved. During the saving the
  92. Intuition base is locked (you cannot move your mouse pointer) to prevent
  93. changes from the menu or the gadgets.
  94.  
  95.  
  96. 4. Tutorial
  97. ***********
  98.  
  99.   1. Start Struct-Saver
  100.   2. Set the wait time to 2 seconds
  101.   3. Enter the name "ram:testsrc.00" as filename
  102.   4. Disable both options (no checkmark visable)
  103.   5. Click "Menus", wait until the title bar displays "Saving done." You
  104.      have saved your first source code with Struct-Saver. Congratulations!
  105.  
  106.   6. Enter the name "ram:testsrc.10"
  107.   7. enable "use defines"
  108.   8. repeat point 5.
  109.  
  110.   9. Enter the name "ram:testsrc.01"
  111.  10. disable "use defines", enable "expanded"
  112.  11. repeat point 5.
  113.  
  114.  12. Enter the name "ram:testsrc.11"
  115.  17. enable both options
  116.  14. repeat point 5.
  117.  
  118. Compare the four source codes to realize the differences. (Note: the source
  119. code defines the menu of Struct-Saver, perhaps you noticed.)
  120.  
  121.  
  122.  
  123. Send bug reports, hints, and ideas to (sorry, no e-mail available):
  124.  
  125.         Thies Wellpott
  126.         Moorhauser Weg 14
  127.         2948 Schortens 1
  128.  
  129.         Germany
  130.  
  131.