home *** CD-ROM | disk | FTP | other *** search
/ Power-Programmierung / CD1.mdf / xbase / tools / codsmith / cs.doc next >
Encoding:
Text File  |  1992-09-18  |  7.9 KB  |  250 lines
  1.  
  2. CodeSmith and its documentation are copyright 1990-1992 by:
  3.  
  4. Don Allred
  5. P.O. Box 56885
  6. Sherman Oaks, CA 91413
  7.  
  8. All rights are reserved.
  9.  
  10.  
  11. The purchaser of CodeSmith is granted a license to use it, to make
  12. copies of the original distribution disk for backups, and to install
  13. it on one or more systems as long as there is no possibility that it
  14. will be used on more than one of those systems at a time. This does
  15. not constitute a site license; it is intended to allow a single
  16. programmer to install CodeSmith on all of the machines that he uses,
  17. but only to allow him to use it on one of those machines at once. In
  18. essence, CodeSmith is licensed to a single user, who is the only
  19. person permitted to use it.
  20.  
  21. This license applies to the development of software using CodeSmith,
  22. not to the redistribution of that software. Software in executable
  23. form that includes code produced by CodeSmith may be sold, given
  24. away, or otherwise redistributed with no additional fees to, and no
  25. special license required from, Don Allred. You may not, however,
  26. redistribute CodeSmith in part or in whole.
  27.  
  28. Clipper is a registered trademark of the Nantucket Corporation.
  29.  
  30.  
  31.  
  32.  
  33.      SYSTEM REQUIREMENTS
  34.  
  35. To develop applications using CodeSmith, you must have a computer
  36. running MS-DOS, and capable of compiling and linking Clipper 5.01
  37. programs. You must have a copy of Clipper 5.01 and a linker
  38. compatible with Microsoft object modules and libraries.  We have
  39. tested CodeSmith with these linkers:
  40.  
  41.      BLINK, Inc. BLINKER version 1.5, 1.51 & 2.0
  42.      Hyperkinetix Warplink version 2.0
  43.      Pocket Soft .RTLink version 3.13 & 5.00
  44.  
  45. Programs created with CodeSmith must run on an IBM PC or compatible
  46. computer.
  47.  
  48.  
  49.      INTRODUCTION
  50.  
  51. CodeSmith is a Clipper 5.01 application generator, a program which
  52. writes programs. It's goal is to provide you the developer with near
  53. instant complete single database, multiple screen, network/single
  54. user applications without writing a line of code.
  55.  
  56. This is done by designing a data screen with CodeSmith's internal
  57. screen painter. You can define fields, text, lines, boxes, colors,
  58. pictures, valids, whens, index keys and even insert your own custom
  59. code! 
  60.  
  61. Your design can be based on all or part of an existing database, one
  62. or more previous designs or you can begin from scratch. In any case
  63. CodeSmith will write the programs to manage your new/old database.
  64.  
  65. CodeSmith generates the full and complete source code for your
  66. application design with no hidden libraries. The only system 
  67. requirements are those needed by Clipper itself.
  68.  
  69. In addition to generating a complete application, you can also
  70. generate a "basic application" which is almost identical to the full
  71. application except there is no main menu. In this way you may create
  72. applications which can be called from within your main application by
  73. inserting a function call with a user defined field. 
  74.  
  75. Code fragments consisting of your screens and procedures to create
  76. your DBF structure in Summer '87 and 5.01 can also be generated. A
  77. real useful tool when changing an existing application or when you
  78. just need a screen.
  79.  
  80.  
  81. So that you can get an idea of what to expect from CodeSmith, let's
  82. quickly generate a sample application using a design provided. Later
  83. we will go over each command in CodeSmith and create an application
  84. from scratch.
  85.  
  86.  
  87.  
  88.      GENERATING THE SAMPLE APPLICATION
  89.  
  90. From the DOS prompt type CS <Enter>.
  91.  
  92. Using the arrows keys, highlight SAMPLE.CS1 and press <Enter>.
  93.  
  94. Now you should have an on screen representation of the sample
  95. application.  Press <M> (that's just the letter M) for the Main Menu.
  96.  
  97. Using the arrow keys, move down to and highlight Generate Full
  98. Application then  press <Enter>.
  99.  
  100. Application Name? The name SAMPLE is already typed in so just press
  101. <Enter>.
  102.  
  103. Database Name? Again the name SAMPLE is provided so press <Enter>.
  104.  
  105. Alias Name? Same thing, just press <Enter>.
  106.  
  107. Multi-User? Select YES
  108.  
  109. Create Generic Files Too?  Select YES.  
  110.  
  111. Lastly CodeSmith asks for the name of your custom PRG to add to the
  112. make and link files. Press <Enter> to skip.
  113.  
  114. Accept, Re-Try, Cancel?   Select Accept
  115.  
  116. CodeSmith will now generate about 5,000 lines of 5.01 program code. A
  117. listing of the file names being generated is shown so that you can
  118. monitor its progress.
  119.  
  120. When finished you see a prompt about compiling and linking the
  121. application.
  122.  
  123. Press <ESC> four times, then press YES to Exit to DOS.
  124.  
  125.  
  126. Here is what we just created:
  127.  
  128. SAMPLE.PRG      Main Menu
  129.  
  130. SAMPLADD.PRG    Add Records
  131.  
  132. SAMPLGET.PRG    View/Search/Edit Record
  133.  
  134. SAMPLHLP.PRG    Help File
  135.  
  136. SAMPLE.MAK      Rmake Make file      
  137.  
  138. SAMPLE.LNK      Blinker Link File
  139.  
  140. SAMPLE.RTL      RTlink Link File
  141.  
  142. SAMPLE.WL       WarpLink Link File
  143.  
  144. GO.BAT          Generic, used to compile                 
  145.                 and link application.
  146.  
  147. CS.CH           Generic Header File. 
  148.                 Contains system colors.
  149. CSGENRL.PRG     Generic Functions and                 
  150.                 Procedures
  151.  
  152. CSLABEL.PRG     Generic Label Maker
  153.  
  154. CSVIEW.PRG      Generic Browser
  155.  
  156. CSREPORT.PRG    Generic Report Writer
  157.  
  158. CSQBE.PRG       Generic Query by Example
  159.                 Complex Filter Builder
  160.  
  161. CSLOCKS.PRG     Networking Functions
  162.  
  163.  
  164. To compile and link our sample application, at the DOS prompt type GO
  165. SAMPLE.
  166.  
  167. GO.BAT will tell Rmake to process SAMPLE.MAK which will compile all
  168. programs into object files. Next it will tell SAMPLE.RTL to link the
  169. application using RTlink. 
  170.  
  171. If you have a problem compiling or linking make sure that your
  172. Clipper, libraries, include files and linker are in the path. 
  173.  
  174. If prefer to use Blinker or WarpLink, just go into GO.BAT and move
  175. the REM statement.
  176.  
  177.  
  178.  
  179.                OWN YOUR OWN
  180.  
  181. CodeSmith and it's applications support 25, 43 and 50 line displays.
  182. The default for both is the current display mode. If for example you
  183. are currently in 25 line mode and you want to generate an application
  184. for 50 line VGA displays, use the <L> setmode()/ Lines option. This
  185. will give you twice the screen area to work with. The finished
  186. application defaults to the current mode so begin application by
  187. typing SAMPLE 50.  
  188.  
  189.  
  190. At first glance it may appear that CodeSmith has a lot of options to
  191. deal with, but not really. With the exception of entering INDEX KEYS,
  192. (you can't search without an index) the others can be ignored. With a
  193. little practice you can create a full working application in a few
  194. minutes while your customer watches. Now your customer can begin data
  195. entry, impressed at how efficient you are, while you return to your
  196. office and . . .
  197.  
  198. CodeSmith is intended to relieve you of the mundane aspects of
  199. programming. I use it for all my simple applications and as a 
  200. starting point for complex applications.
  201.  
  202. CodeSmith is being actively developed with changes on a daily basis.
  203. Future versions will include relations and developer defined pop-up
  204. validation functions. Let me know what you need. 
  205.  
  206. The current (July 1992) upgrade policy is 50% of whatever you paid for
  207. your first version. 
  208.  
  209. Beta testers get free upgrades. 
  210.  
  211. CodeSmith may be purchased directly from me for $59.00 with the
  212. manual of $49.00 without the manual. 
  213.  
  214.  
  215.  
  216.         Order now and receive at NO EXTRA CHARGE:
  217.  
  218.                    CodeSmith TBrowse Tool 
  219.      
  220.                            Generates Source Code
  221.  
  222.                     TBrowse objects - database or array
  223.  
  224.                       Achoice() pop-up valid functions    
  225.                               
  226.  
  227.  
  228. If you have any problems, please give me a call, I want you to be
  229. productive. 
  230.  
  231. I welcome your comments and suggestions. 
  232.  
  233. Don Allred
  234. P.O. Box 56885
  235. Sherman Oaks, CA 91413
  236. U.S.A.
  237. (818) 783-5837 Voice
  238. (818) 783-1277 FAX
  239.  
  240.  
  241. Max Bressel
  242. SOFTSOL                    Tel.:+49-40-7665764
  243. Salzburger Haeuser 4       Fax :+49-40-7665664
  244. 2100 Hamburg 90            BBS :+49-40-7665527/8
  245. Germany                    CIS :100112,3401
  246.  
  247.  
  248. Happy Programming!
  249.  
  250. July 24, 1992