home *** CD-ROM | disk | FTP | other *** search
/ DOS Wares / doswares.zip / doswares / DATABASE / CLARION / README.DOC < prev    next >
Encoding:
Text File  |  1995-04-04  |  13.3 KB  |  346 lines
  1.  
  2.  
  3.                    Clarion for DOS 3.1
  4.                   Release 3100
  5. Table of Contents.
  6.  
  7.    1. Introduction
  8.    2. Additional Document Files
  9.    3. What's new for 3.1
  10.    4. Technical Support
  11.    5. Reporting Problems and Feature Requests
  12.    6. Tutorial on disk
  13.    7. Tidbits on database drivers
  14.    8. Btrieve.exe required
  15.    9. Btrieve Distribution Licensing
  16.   10. Installation notes
  17.   11. Failed installation
  18.   12. Running under OS/2
  19.   13. Running under Windows 3.1
  20.   14. Performance Considerations
  21.   15. Miscellaneous Notes
  22.  
  23. Section 1. Introduction
  24. ───────────────────────
  25.  
  26. Clarion for DOS 3.1 is an exciting new product from TopSpeed Corporation.
  27. This product represents a significant step forward from its predecessor,
  28. Clarion Database Developer 3.0 (CDD).  Clarion for DOS is a new product, with
  29. a new name, new manuals, and new features.  It is reworked from the ground up
  30. and achieves a new level of quality and stability.  Clarion for DOS is
  31. completely compatible with its predecessor, CDD, and also attains a much
  32. higher level of compatibility with the earlier Clarion Professional Developer
  33. 2.1.
  34.  
  35.  
  36. Section 2. Additional Document Files
  37. ────────────────────────────────────
  38.  
  39. In your CLARION3/DOC subdirectory, you will find some additional
  40. documentation files as follows:
  41.  
  42.      APPCNV.DOC        Application conversion to 3.1 from both CPD 2.1 and CDD
  43.             3.0.
  44.      CLACNV.DOC        Source code conversion from CPD 2.1 to 3.1.
  45.      EXAMPLES.DOC   A guide to the Clarion for DOS example programs
  46.      LRM21TO3.DOC   Clarion language changes from CPD 2.1 to CDD 3.0.
  47.      MEMORY.DOC        Sample memory configurations.
  48.      NEWFOR31.DOC   A quick index to new 3.1 features, for 3.0 users.
  49.      POOLLMT.DOC    A discussion of compiler pool limits, and how to avoid
  50.             exceeding them.
  51.      RUNERROR.DOC   Information on runtime error files.
  52.      VESA.DOC        Information on VESA drivers used for displaying graphics
  53.             in Super VGA mode.
  54.  
  55. Please note that any information in these DOC files supersedes the printed
  56. manuals when they differ.  Also the online HELP supersedes the printed
  57. manuals.
  58.  
  59.  
  60. Section 3. What's New for 3.1
  61. ─────────────────────────────
  62.  
  63.  
  64.      Clarion for DOS 3.1 has many exciting new features which include:
  65.  
  66.       *    CPD 2.1 app conversion with full execution compatibility
  67.  
  68.       *    Multi-line, colorized list box and template support
  69.  
  70.       *    High performance Universal Browse template
  71.  
  72.       *    Data Dictionary Access from the Application Generator
  73.  
  74.       *    Binary Coded Decimal (BCD) math to eliminate rounding errors
  75.            with Decimal data types
  76.  
  77.       *    Easier to use dual list box Help system
  78.  
  79.       *    New TopSpeed file driver
  80.  
  81.       *    Ability to print Image fields on reports
  82.  
  83.       *    Natural order of computation for Formulas
  84.  
  85.       *    Auto-populate mode for List Boxes
  86.  
  87.       *    Ability to print Data Dictionary contents
  88.  
  89.       *    Ability to create Data Dictionaries from Data files (Import)
  90.  
  91.       *    Clarion for Windows Data Dictionary import (.TXD import)
  92.  
  93.  
  94. For a complete description of the new features, see the file NEWFOR31.DOC
  95. which will direct you to all the pages in the documentation that detail the
  96. new features.
  97.  
  98.  
  99. Section 4. Technical Support
  100. ────────────────────────────
  101.  
  102. Both Getting Started and the User's Guide list the technical support phone
  103. and fax numbers, at the end of chapter one.  Additionally, you'll find a
  104. great many members of the TopSpeed/Clarion community, known as Team TopSpeed,
  105. who you can access in the TOPSPEED forum, on CompuServe.  This group of
  106. experts are ready and willing to answer questions and otherwise help you.
  107. They're a tremendous resource.  We here at TopSpeed hope you'll become an
  108. active member of the forum, and help other new members, in turn, as you
  109. master Clarion for DOS.
  110.  
  111. To access the forum, after connecting to CompuServe, type GO TOPSPEED at any
  112. ! prompt.
  113.  
  114.  
  115. Section 5. Reporting Problems and Feature Requests
  116. ──────────────────────────────────────────────────
  117.  
  118. TopSpeed has provided a Bug Reporting program (called "SUPPORTD.EXE"), so
  119. that you can add incident reports and suggestions for new features to our
  120. database. You'll find this program in the \CLARION3\SUPPORT sub-directory.
  121. We are vitally interested in all reports and suggestions for improving
  122. Clarion for DOS. Please make use of this program.
  123.  
  124. For a comprehensive list of bugs, with its status and work-around, download
  125. the PROBLEMS.TPS file from Compuserve or Clarionet. Outside of the U.S.,
  126. contact your local distributor.
  127.  
  128.  
  129. To report a problem follow this approach:
  130.  
  131. STEP 1: Isolate the Problem!
  132.  
  133.      If you are using the Application Generator, you will want to create a
  134.      NEW application and import the individual Procedure(s) that cause the
  135.      problem. If it is hand code, reduce it to the bare minimum!
  136.  
  137. STEP 2: Remove hard coded Paths from file specifications!
  138.  
  139.      If the Dictionary being used contains Hardcoded Path specifications, you
  140.      will need to make a copy of the DCT and remove all path specifications.
  141.  
  142. STEP 3: Explain the Problem and How to Reproduce!
  143.  
  144.      COMPLETELY FILL OUT AN INCIDENT REPORT USING THE SUPPORTD PROGRAM.
  145.      Explain the problem and the steps needed to reproduce the problem. If
  146.      necessary include the specific keystrokes needed.
  147.  
  148. STEP 4: Uploading the Problem!
  149.  
  150.      Once you have created the incident report using the SUPPORTD program,
  151.      upload the zip file to the TopSpeed Forum on CompuServe Library 3 "Bug
  152.      Uploads". If you do not have a CompuServe Account you can upload the Zip
  153.      file to the Tech Support BBS (14.4KB access at (305)785-9172 ). If you
  154.      do not have a modem, you can mail us a diskette.
  155.  
  156.  
  157. Please note that TopSpeed does not accept bug reports via the telephone or
  158. via CompuServe messages.  PLEASE USE THE SUPPORTD PROGRAM TO SUBMIT BUGS.
  159. Using the SUPPORTD program allows TopSpeed to automate bug processing and
  160. tracking, ensuring that all bug reports are tracked throughout their life
  161. cycle.    This assures that TopSpeed produces the highest quality product
  162. possible.
  163.  
  164.  
  165.  
  166. Section 6. Tutorial on disk
  167. ───────────────────────────
  168.  
  169. For your convenience, a completed version of the Tutorial program that you
  170. create using the Getting Started book is installed in the directory
  171. \CLARION3\TUTORIAL.  You will need to generate, compile, and link both parts
  172. of the Tutorial before you can run it.    You must generate, compile, and link,
  173. LOOKUPS.APP before you do CONTACTS.APP.
  174.  
  175.  
  176. Section 7. Tidbits on database drivers
  177. ──────────────────────────────────────
  178.  
  179. The new Btrieve driver does more validation to ensure that the physical file
  180. matches the clarion definition. This may cause applications that work in 3009
  181. to produce an Invalid File Definition Error in 3.1. This is normally caused
  182. when a Btrieve key is defined in the physical file as a single field, but is
  183. defined as multiple fields in the Clarion definition. Eg:
  184.  
  185. Physical File                Current Clarion Definition
  186. =============                ==========================
  187.  
  188.   key 1     string(25)              field1   STRING(10)
  189.                       field2   STRING(15)
  190.                       key1     KEY (field1, field2)
  191.  
  192. In this case you need to change your key definition to be on a single string
  193. field.
  194.  
  195. Physical File Current Clarion Definition
  196. ────────────────────────────────────────
  197.  
  198.   key 1     string(25)              field0   STRING(25)
  199.                       grp     GROUP,OVER(field0)
  200.                       field1     STRING(10)
  201.                       field2     STRING(15)
  202.                            END
  203.                       key1     KEY (field0)
  204.  
  205. This will allow your app to work without changes, but tell the driver the
  206. real key you are working with.
  207.  
  208. Section 8. Btrieve.exe
  209. ──────────────────────
  210.  
  211. Btrieve MUST be resident before loading a Dictionary or Application file in
  212. the Clarion Environment.  If you do not load Btrieve before loading the
  213. environment an error window will be displayed.
  214.  
  215.   CD31.BAT   - Main batch file used to start Clarion for DOS 3.1.
  216.            Loads Btrieve, resets it, runs Clarion3.exe and removes
  217.            Btrieve from memory upon exit.
  218.   BLOAD.BAT  - Loads Btrieve with the required parameters
  219.   BSTOP.EXE  - Removes Btrieve from memory
  220.   BRESET.EXE - Resets Btrieve.exe
  221.  
  222. Section 9.  Btrieve Licensing
  223. ─────────────────────────────
  224.  
  225. According to our license agreement with Novell/BTI you may freely distribute
  226. Btrieve.exe to your customers.    You may also distribute the utilities
  227. Bstop.exe and Breset.exe, these are Clarion written programs that unload the
  228. Btrieve TSR and force a reset, respectively.
  229.  
  230.  
  231.  
  232. Section 10. Installation Notes
  233. ──────────────────────────────
  234.  
  235. The installation program creates the following default directory tree
  236. structure.
  237.  
  238.     \CLARION3        - All Clarion .DLLs and .EXEs
  239.     \CLARION3\LIB    - Libraries for all memory models
  240.  
  241. The directories below are created if you choose install entire system:
  242.  
  243.      \CLARION3\OPTIONS     -    Set Runtime switches and International support
  244.      \CLARION3\TUTORIAL     -    Completed copies of the tutorial examples
  245.      \CLARION3\DOC     -    Documentation files
  246.      \CLARION3\EXAMPLE     -    Example Applications, Dictionaries and source
  247.                   code.
  248.      \CLARION3\VESA     -    VESA (video) drivers / card specific
  249.      \CLARION3\SUPPORT     -    SUPPORTD bug reporting program.
  250.  
  251. *NOTE: Your DOS PATH must include the directory where Clarion for DOS  was
  252. installed. The default install directory is \Clarion3.
  253.  
  254. If you do not install in the default C:\CLARION3 directory, please note that
  255. you will have to specify new path names for the dictionary and template files
  256. for the EXAMPLE programs when you load them.
  257.  
  258.  
  259. Section 11. Failed Installation
  260. ───────────────────────────────
  261.  
  262. If installation fails after you type A:INSTALL, try typing A:INSTALL /S to
  263. slow down the read/write heads on the floppy drive.
  264.  
  265.      If you use the /S option you must do the following to complete the
  266.      installation:
  267.  
  268.     1. Change directory to the location you installed Clarion
  269.            i.e. CD \Clarion3
  270.     2. Run config.bat with drive and path where you installed Clarion
  271.            i.e. Config C: \Clarion3
  272.  
  273.  
  274.  
  275. Section 12. Running under OS/2
  276. ──────────────────────────────
  277.  
  278. If you plan to run Clarion for DOS under IBM's OS/2 Warp, earlier versions of
  279. OS/2, or other OS/2 derivatives such as Citrix WinView, you should change the
  280. DOS Settings to the following:
  281.  
  282.            Idle Seconds = 1
  283.            DPMI API Translation = DISABLED
  284.  
  285. These DOS Settings are also recommended for running applications created with
  286. Clarion for DOS.
  287.  
  288. Also, if you are running under OS/2 Warp, you must set the Smooth Mouse to
  289. OFF, for both Clarion for DOS and for applications created with Clarion For
  290. DOS.
  291.  
  292.  
  293. Section 13. Running under Windows 3.1
  294. ─────────────────────────────────────
  295.  
  296. When running under Windows 3.1 or Windows for Workgroups 3.11, we recommend
  297. the following settings in Clarion's System Options (choose Options from the
  298. System Setup sub-menu of the Clarion menu) - all three video toggles should
  299. be disabled (checkboxes next to Use Smooth Mouse Cursor, Use Graphical Fonts,
  300. and Graphical Intro. Screen should not be checked).
  301.  
  302. We also recommend running in full screen mode under Windows.
  303.  
  304.  
  305. Section 14. Performance Considerations
  306. ──────────────────────────────────────
  307.  
  308. The key to good performance for running both Clarion for DOS, and the
  309. programs you create with it, is having ample memory.  Clarion for DOS
  310. automatically runs in protected mode and supports Extended Memory (memory
  311. beyond 1MB, known as XMS memory).  Increasing XMS memory will generally
  312. increase overall performance.  One method of increasing XMS when you start up
  313. Clarion for DOS is to relinquish some XMS memory normally used by disk cache
  314. programs.  To accomplish this, use the CD31X.BAT file to start up Clarion for
  315. DOS instead of the normal CD31.BAT file.  CD31X.BAT will issue an XBCAST
  316. command to tell disk cache programs to relinquish some XMS memory for use by
  317. Clarion.  Since some disk cache programs are incompatible with this
  318. mechanism, discontinue use of CD31X.BAT if you experience any problems.
  319.  
  320. The standard Clarion for DOS 3.1 product does not have the ability to create
  321. programs that run in protected mode and use XMS memory.     However, you can
  322. purchase a separate TopSpeed product, the Clarion DOS Extender, which will
  323. enable Clarion for DOS to create programs that run in protected mode.  If you
  324. are experiencing performance problems with a program you have created due to
  325. its size, you should consider using the Clarion DOS Extender.
  326.  
  327.  
  328. Section 15. Miscellaneous Notes
  329. ───────────────────────────────
  330.  
  331.   *  If you use the Paradox file driver note that it is not registered by
  332.      default.  You must register it by going to the Database Drivers menu
  333.      under the System Options menu under the Clarion menu.  Also note that
  334.      the Paradox driver is a single user only driver and does not support
  335.      multiple user access.
  336.  
  337.   *  There appears to be problems in the QEMM 7.5 DOS Extender from
  338.      Quarterdeck that cause Clarion for DOS to hang up.     Do not use QEMM 7.5
  339.      with Clarion for DOS.  Use EMM386, which comes with DOS, instead.
  340.  
  341.   *  THE .APP FILE FORMAT HAS CHANGED FOR VERSION 3.1. Once you open an
  342.      application in Clarion for DOS 3.1, the file is updated and earlier
  343.      versions of Clarion for DOS (Clarion Database Developer) will not read
  344.      them.  You should backup you programs before loading them into 3.1.
  345.  
  346.