home *** CD-ROM | disk | FTP | other *** search
/ C!T ROM 2 / ctrom_ii_b.zip / ctrom_ii_b / PROGRAM / CLIPPER / GENCLP20 / GENCLP.DOC < prev    next >
Text File  |  1993-04-17  |  11KB  |  256 lines
  1.  
  2. PACKAGE
  3. =======
  4.  - GENCLP.DOC    This file
  5.  - GEN.BAT    Start up the generator to generate English sources
  6.  - NGEN.BAT    Start up the generator to generate Dutch sources
  7.  - GENCLP.EXE    The generator
  8.  - VHA.CH    Include file needed at compile-time
  9.  - GEN.LIB    English user-interface library needed at link-time
  10.  - NGEN.LIB    Dutch user-interface library needed at link-time
  11.  - ORDER.FRM    Form to order PERSONAL registration-number
  12.  - GENLIB.NG    Norton guide of (N)GEN.LIB
  13.  
  14.  
  15. GENCLP version 2.0
  16. ==================
  17.  - Creates error-free multi-user Clipper program sources (Object-Oriented-
  18.    like) for a complete working system
  19.  - Creates sources of GEN.LIB or NGEN.LIB
  20.  - Checks consistency of defined system
  21.  - Creates compile/link MAKE files
  22.  - Includes meta-data repository
  23.  
  24.  
  25. SOURCES
  26. =======
  27.  - Full standard Clipper code
  28.  - Full generator-independent
  29.  - Full customizable
  30.  - Efficient recordlocking mechanisms for effective networking
  31.  - Automatic color-screen detection and support
  32.  - Multi-page screen support (PgUp/PgDn) without disturbing GET validations
  33.  - Quik screen exit (PgDn) without disturbing GET validations
  34.  - Automatic DBF and NTX creation on first start up
  35.  - Helpscreens on strategic moments
  36.  - Re-index facility
  37.  - Recycling of deleted records (eliminates use of PACK command)
  38.  - Data integrity support to maintain unique keys in DBF
  39.  - Key search facility
  40.  - Controlled DBF print facility
  41.  - Look and feel menu-structures
  42.  - Prepared to use authorization mechanisms
  43.  - Structured modular
  44.  
  45.  
  46. INSTALLATION GUIDELINES
  47. =======================
  48.  1. Copy GENCLP files to harddisk
  49.  
  50.  2. Set FILES=65 in CONFIG.SYS (or higher)
  51.  
  52.  3. Set CLIPPER=F65 in AUTOEXEC.BAT (or higher)
  53.  
  54.  4. Restart your PC after changing CONFIG.SYS or AUTOEXEC.BAT
  55.  
  56.  
  57. GETTING STARTED
  58. ===============
  59.  1. After correct installation, start the generator by entering GEN (GEN.BAT)
  60.     to generate English sources or NGEN (NGEN.BAT) to generate Dutch sources.
  61.  
  62.  2. The program will create a demo setup, which includes:
  63.     - Demosystem description
  64.     - Field definitions
  65.     - File definitions
  66.     - File/field relationships
  67.     - File/keyfield specifications
  68.  
  69.  3. After a few moments the mainmenu will appear:
  70.     - Application generator     : Start application definition/generation
  71.     - Generate (N)GEN.LIB sources: Generate sources of (N)GEN.LIB
  72.     - Re-index             : Re-index the generator files
  73.  
  74.  4. After selecting "Application generator" the predefined demosystem descrip-
  75.     tion will be shown. Use F1 for information.
  76.  
  77.  5. After [Enter] the second menu will appear:
  78.     - Define fields      : Add/change/delete field definitions
  79.     - Define files      : Add/change/delete file  definitions
  80.     - Generate application: Create complete system sources
  81.  
  82.  6. After selecting "Define fields" or "Define files" use F1 for information.
  83.  
  84.  7. After selecting "Define files" you may select a file and press [Enter].
  85.     A menu will appear to assign fields to the selected file and to assign
  86.     keyfields to the selected file. Prior to assigning keyfields, fields have
  87.     to be assigned to the file and prior to assigning fields to the file,
  88.     you must have defined fields.
  89.  
  90.  8. After selecting "Generate application" a consistency check will be
  91.     performed, which may result in the following error messages:
  92.  
  93.     - E010: No files for system <systemname>
  94.     - E020: No fields for file <filename>
  95.     - E030: No keyfields for file <filename>
  96.     - E040: Fieldname must not be equal to filename: <filename>
  97.     - E050: Fieldname must not begin with systemname: <systemname>
  98.     - E060: Filename must not begin with systemname: <systemname>
  99.  
  100.     These messages are self-explaining
  101.  
  102.     If no errors occur, the sources will be generated. The result is scrolling
  103.     on the screen while the generation is proceeding. The process can be
  104.     aborted by pressing [Esc]. After completion, the following files will exist
  105.     exist in the current directory:
  106.  
  107.     - BAT file for compile and link
  108.     - RMK file for rmake
  109.     - LNK file for link
  110.     - BAT file for start up
  111.     - PRG program files
  112.     - CH include file
  113.  
  114.  9. Start <sysname>MAKE.BAT to compile and link the generated sources.
  115.     Make sure that the Clipper-compiler, -linker and -rmake utility files
  116.     are accessible.
  117.     Make sure that the generated <sysname>.CH is accessible during compile and
  118.     link.
  119.     Make sure that the (N)GEN.LIB and VHA.CH are accessible during compile and
  120.     link.
  121.     (N)GEN.LIB must be the first library in the linklist before CLIPPER.LIB
  122.     and EXTEND.LIB during linking. This is because of the (slightly) customized
  123.     GET system, that has to overrule the default Clipper GET system (this is
  124.     already in place in the generated <sysname>MAKE.BAT file).
  125.  
  126.  10. Start <sysname>.BAT to start the generated system.
  127.  
  128.  
  129. REGISTRATION-NUMBER
  130. ===================
  131.  - When you have received a PERSONAL registration-number, you must change
  132.    the GEN.BAT and/or the NGEN.BAT files.
  133.  
  134.    GEN.BAT (English version) change line:
  135.       ┌────────────────────────────────┐
  136.       │genclp E                │
  137.       └────────────────────────────────┘
  138.    Into:
  139.       ┌────────────────────────────────┐
  140.       │genclp E xxx...               │
  141.       └────────────────────────────────┘
  142.    Where xxx... is your PERSONAL registration number.
  143.  
  144.  
  145.    NGEN.BAT (Dutch version) change line:
  146.       ┌───────────────────────────────┐
  147.       │genclp N               │
  148.       └───────────────────────────────┘
  149.    Into:
  150.       ┌───────────────────────────────┐
  151.       │genclp N xxx...              │
  152.       └───────────────────────────────┘
  153.    Where xxx... is your PERSONAL registration number.
  154.  
  155.    Your registration-number is secret. It is not allowed to make it known
  156.    to anybody. Only if you respect this obligation, the ShareWare concept
  157.    will work, which means that you will be supplied with new and improved
  158.    professional products at a very low price (10 US-dollar for this generator).
  159.  
  160.  
  161. QUESTIONS AND ANSWERS
  162. =====================
  163.  Q. What is GENCLP?
  164.  A. GENCLP is a Clipper source-code generator.
  165.  
  166.  Q. Do I depend on the generator after the sources have been generated?
  167.  A. No, after the sources have been generated, you are fully independed
  168.     of the generator. The only thing you must do is linking (N)GEN.LIB
  169.     to you application as the first library (before CLIPPER.LIB and
  170.     EXTEND.LIB). You can change the sources in any way you wish. Even the
  171.     (N)GEN.LIB functions can be modified as all sources of (N)GEN.LIB can
  172.     be generated with the generator.
  173.  
  174.  Q. Which Clipper version is supported?
  175.  A. The generator sources are in Clipper 5.01, but as all future Clipper
  176.     5.x versions are downward compatible, the generator can be used for
  177.     all these future Clipper releases. In case any compatibility problem
  178.     might occur, a modified version of GENCLP will be released, which does
  179.     not need a new registration-number.
  180.  
  181.  Q. Does GENCLP also support other XBase dialects, such as FoxPro?
  182.  A. The generator has not been designed for this purpose, but as the
  183.     sources of (N)GEN.LIB can be generated and as the generated sources
  184.     may be changed, you might change the programs to be accepted by any
  185.     other Xbase-dialect compiler or interpreter.
  186.  
  187.  Q. How can I customize the messages and texts to my native language?
  188.  A. Change all text-strings in the sources of (N)GEN.LIB to your preferred
  189.     language and rebuild the library.
  190.     Create preprocessor directives to change all text-strings in the generated
  191.     sources to your preferred language and place these directives in VHA.CH.
  192.     After compile and link, the generated system will pop-up in your native
  193.     language.
  194.  
  195.  Q. Is a screen-painter available?
  196.  A. No, the generator has been designed to speed up the development of
  197.     applications. Therfore the generator itself calculates an optimal default
  198.     screen layout. As the screen build-up code can easily be isolated in the
  199.     generated source, you can customize it there. In most cases however, you
  200.     won't need to change the generated screen layout. This is the quickest
  201.     way of setting up a system.
  202.  
  203.  Q. Why is there no packing function available in the generated system?
  204.  A. Because you don't need one. A mechanism is implemented in the generated
  205.     sources, that recycles deleted records if there are any, so in systems
  206.     with growing or stable databases, no deleted records will mess up your
  207.     system. If you have ceasing databases, one might wonder if packing is
  208.     required, as the system is doomed to disapear (when the database is empty).
  209.     If you create your own packing function, it won't harm the system.
  210.  
  211.  Q. Can I use the generated system on a network?
  212.  A. Without any problem. The generated sources are fully multi-user prepared
  213.     with an adequate record-locking mechanism.
  214.  
  215.  Q. Are referential database relationship rules supported?
  216.  A. No, GENCLP has been designed to set up correctly working related programs,
  217.     which can easily be modified to customize the system in a very flexible
  218.     way. Referential database relations can be added to the generated system-
  219.     skeleton after having showed and discussed the system with your user.
  220.     Prototyping is the keyword.
  221.  
  222.  Q. How much must I pay for the registration-number?
  223.  A. To get a PERSONAL registration-number, you have to send a 10 US-dollar
  224.     banknote to:
  225.  
  226.          JGM van Hoof
  227.          Asterdkraag 19
  228.          4823 GC  BREDA
  229.          The Netherlands
  230.  
  231.     Or transfer Dutch fl. 20,-- to Postbank 333 49 15 of JGM van Hoof, Breda.
  232.     In a few days you will receive your PERSONAL registration-number
  233.  
  234.  
  235. CREDITS
  236. =======
  237.  I am a professional software developer for over 15 years. I try to develop
  238.  high quality ShareWare products and distribute these around the world at the
  239.  lowest possible price. Regular companies would pay 100 to 1000 times as much
  240.  when they have the same products developed by a software-house.
  241.  
  242.  Of course this concept only works if registration fees are payed. And if
  243.  registration-numbers are kept secret.
  244.  
  245.  If this obligation is respected, I will go on improving the generator to
  246.  a most sophisticated one with lots of additional options like referential
  247.  database relationship support, extensive report- and query-support, improved
  248.  national language support etc. I will also keep track with futher Clipper
  249.  releases and lead the generator into Aspen's world of ObjectVision, Windows
  250.  and New Technology.
  251.  
  252.  Suggestions on this generator or new products are welcome.
  253.  
  254.  
  255.  Jack van Hoof.
  256.