home *** CD-ROM | disk | FTP | other *** search
/ Delphi 5 for Professionals / DELPHI5.iso / AddOns / Components / ABBREVIA / README.TXT < prev    next >
Encoding:
Text File  |  1998-12-16  |  11.1 KB  |  275 lines
  1. ======================================================================
  2.                   Last Minute News on Abbrevia 1.06
  3. ======================================================================
  4.  
  5. 100. Delphi 3, Delphi 4, and C++Builder 3 Package Notes
  6. 200. Installing for Both C++Builder 1.0 and C++Builder 3.0
  7. 300. Component Installation in C++Builder 1.0
  8. 400. Help Installation
  9. 500. Running the Examples Under Delphi 1
  10. 600. Changes/Additions
  11. 700. Known Problems
  12. 999. Corrections to the Manual
  13.  
  14. 100. Delphi 3 and C++Builder 3 Package Notes
  15. ======================================================================
  16.  
  17. 101. Package naming
  18. -------------------
  19. To avoid version conflicts with applications using different versions of the
  20. Abbrevia packages, each new version of Abbrevia will come with packages using
  21. slightly different names. See DEPLOY.TXT for package naming conventions used
  22. by TurboPower.
  23.  
  24. 102. Installation
  25. -----------------
  26. Abbrevia help and the design-time package are automatically installed into
  27. Delphi 3, Delphi 4, and BCB 3 if Abbrevia is installed using the setup program.
  28. If you are upgrading by using a patch, you will need to use the "Install
  29. Packages" menu option to install the Abbrevia design-time package
  30. (B###_D##.DPL). In order for the run-time package (B###_R##.DPL) to be
  31. "seen" by the IDE (and by the design-time package) you need to copy it to
  32. the Windows system directory (\System for Win95 or \System32 for NT) or add
  33. the Abbrevia directory to your system path.
  34.  
  35. 103. Delphi 3 and Delphi 4
  36. --------------------------
  37. Be sure to alter Delphi's library path so that it includes the path to the
  38. Abbrevia source files (Tools|Environment Options - Library Page) so that
  39. Delphi can find the Abbrevia source files. Or, add the Abbrevia path to
  40. your system Path environment.
  41.  
  42. 104. C++Builder 3.0
  43. -------------------
  44. Abbrevia is compatible with BCB. Although the printed manual is
  45. Delphi-specific, we have provided C++ examples and a BCB help file
  46. for C++Builder users. If you choose to install the BCB help file and
  47. examples then you will find the help file in the ABBREVIA\HELP\CBUILDER
  48. directory and the examples in ABBREVIA\EXAMPLES\CBUILDER (BCB 1.0) or in
  49. ABBREVIA\EXAMPLES\CBUILDR3 (BCB 3.0).
  50.  
  51. To insure that all projects built with Abbrevia will compile and link cleanly
  52. you need to add the Abbrevia path to your default Library and Include paths.
  53. You can do this through the Directories/Conditionals page of the Project
  54. Options dialog. Simply add your Abbrevia path to those already listed. Be
  55. sure to separate all paths with a semi-colon. For example, your Include path
  56. might look like this:
  57.  
  58. C:\abbrevia;$(BCB)\include;$(BCB)\include\vcl
  59.  
  60. Once you have modified the Include and Library paths you should check the
  61. "Default" check box at the bottom of the Project Options dialog. When you
  62. click OK the new path settings will be saved as the default for any new
  63. projects. (If you open the Project Options dialog without a project open
  64. then the Default check box does not appear since you are writing directly
  65. to the default project.)
  66.  
  67. The installation program copies the following files to your CBuilder3
  68. and/or Windows directories:
  69.  
  70. \CBuilder3\Lib
  71.  
  72. B106_R35.LIB
  73. B106_R35.BPI
  74.  
  75. \Windows\System (or Winnt\System32)
  76.  
  77. B106_R35.BPL
  78.  
  79. NOTE: The Abbrevia library files (LIB and BPI) don't have to be in the
  80. CBuilder3\Lib directory. You can move them to any location you want as
  81. long as you update the C++Builder Library paths accordingly.
  82.  
  83.  
  84. 200. Installing for Both C++Builder 1.0 and C++Builder 3.0
  85. ======================================================================
  86. If you install the C++Builder 3 packages, then header files for Abbrevia
  87. will be installed as well. If you plan to use Abbrevia with BCB 1 then you
  88. should copy the Abbrevia source files to a separate directory before
  89. adding them to the C++Builder 1 component palette. C++Builder 1 will create
  90. new headers when you install Abbrevia to the component palette, overwriting
  91. any existing headers. In either case you can create new headers by compiling
  92. AbReg.pas from the command line as follows:
  93.  
  94. <BCBRootDir>\BIN\DCC32 -jphn abreg.pas
  95.  
  96. Be sure that you specify the directory where C++Builder 1 resides if you
  97. are building the headers for use in C++Builder 1, and the C++Builder 3
  98. directory if you are building the headers for use in C++Builder 3.
  99.  
  100.  
  101. 300. Component Installation in C++Builder 1.0
  102. ======================================================================
  103. The installation process under BCB 1.0 is the same as it is for Delphi 2.0.
  104. You can refer to the manual for steps to install under Delphi 2.0 or you can
  105. perform the following steps:
  106.  
  107. 1. Choose Component | Install from the BCB main menu.
  108.  
  109. 2. Click on the Add button and then the Browse button.
  110.  
  111. 3. Navigate to the directory where you have installed Abbrevia.
  112.  
  113. 4. Locate the ABREG.PAS file and click the Open button.
  114.  
  115. 5. Click the OK Button to rebuild the component library.
  116.  
  117.  
  118. 400. Help Installation
  119. ======================================================================
  120. The Abbrevia installation program should automatically install Abbrevia help
  121. so that it is accessible from within the IDE. In the event you need to
  122. manually install Abbrevia help you can perform the following.
  123.  
  124. 401. Delphi 3 and Delphi 4
  125. ------------------------------
  126. To manually install the Abbrevia help into Delphi 3 and 4, perform the
  127. following steps:
  128.  
  129. Edit the Delphi3.cnt (or Delphi4.cnt) file (in the Delphi Help directory)
  130. and add the following line to the "index" section:
  131.  
  132.     :Index Abbrevia Reference =abbrevia.hlp
  133.  
  134. The first time you attempt to access Abbrevia help, Delphi/Windows won't be
  135. able to locate the help file and will ask if you want to find the file
  136. yourself.  Answer yes to this question and browse for the Abbrevia help file
  137. (ABBREVIA.HLP), which should be in the Abbrevia directory. This step will only
  138. be required the first time you access Abbrevia's help.
  139.  
  140. 402. C++Builder 3.0
  141. -------------------
  142. Run C++Builder's OpenHelp utility found in the CBuilder3\Bin directory (do
  143. NOT run OpenHelp from BCB 1.0 if you had BCB 1.0 installed previously).
  144. Perform these steps:
  145.  
  146. 1. Open the CBuilder\Help\BCB.OHP project.
  147.  
  148. 2. Click on the Index tab.
  149.  
  150. 3. Click on the Add to Project button.
  151.  
  152. 4. Locate the Abbrevia help file (ABBRBCB.HLP) and click Open.
  153.  
  154. 5. Save the project and close OpenHelp.
  155.  
  156. Abbrevia help will now be accessible from the C++Builder IDE. Note that
  157. under Windows NT you must have Administrator rights on your machine to
  158. install the integrated help.
  159.  
  160. 403. Installing Integrated Help in C++Builder 1.0
  161. -------------------------------------------------
  162. If you chose the option to install the C++Builder help files then the
  163. install program copies the Abbrevia help and contents files to the
  164. \ABBREVIA\HELP\CBUILDER directory.
  165.  
  166. To install the integrated help files you must run the OpenHelp utility that
  167. comes with C++Builder. You can run OpenHelp from the C++Builder folder or
  168. find it in \PROGRAM FILES\COMMON FILES\BORLAND\OPENHELP. The C++Builder
  169. installation program automatically adds this directory to the drive where
  170. Windows is installed (this might not be the drive where you installed
  171. C++Builder). To install the Abbrevia help files in BCB follow these steps:
  172.  
  173. 1. Run OPENHELP.EXE. The available help files are shown in a list box at the
  174.    bottom left. Click on the Add button below the list box.
  175.  
  176. 2. The File Open dialog is displayed. Navigate to the directory where you
  177.    have Abbrevia help installed. Select the ABBRVBCB.HLP file and click OK.
  178.  
  179. 3. ABBRVBCB.HLP is added to the list of available help files. Click on
  180.    ABBRVBCB.HLP in the list box and then click the '>' button. This adds the
  181.    Abbrevia help file to the 'Selected Help Files' list box on the right
  182.    side of the window. Due to a bug in OpenHelp, you might have to click the
  183.    '>' button twice. Be sure that ABBRVBCB.HLP shows up in the 'Selected Help
  184.    Files' list box before continuing.
  185.  
  186. 4. Click Apply and then click OK to close OpenHelp. You must click on Apply
  187.    first and then OK, due to a bug in OpenHelp.
  188.  
  189. NOTE: Due to bugs in OpenHelp you may not be able to successfully install
  190. Abbrevia help in C++Builder 1.0.
  191.  
  192.  
  193. 500. Running the Examples Under Delphi 1
  194. ======================================================================
  195. When running or saving the example programs in Delphi 1, ignore the
  196. "Method XXX has an incompatible parameter list" error that Delphi 1.0
  197. displays by selecting the "NO" button.
  198.  
  199. This error is generated because of a bug in Delphi's handling of the
  200. $IFDEF's within the NeedPassword event handler declaration. If you do
  201. not use IFDEF's within a form's declaration in your own applications,
  202. this should not be an issue.
  203.  
  204.  
  205. 600. Changes/Additions
  206. ======================================================================
  207. See Ab.101 for changes from Abbrevia 1.00 to 1.01.
  208. See Ab.102 for changes from Abbrevia 1.01 to 1.02.
  209. See Ab.103 for changes from Abbrevia 1.02 to 1.03.
  210. See Ab.104 for changes from Abbrevia 1.03 to 1.04.
  211. See Ab.105 for changes from Abbrevia 1.04 to 1.05.
  212. See Ab.106 for changes from Abbrevia 1.05 to 1.06.
  213.  
  214.  
  215. 700. Known Problems
  216. ======================================================================
  217.  
  218. Installing several component libraries into Delphi 2.0 may result in a
  219. stack overflow during the link phase. We have been able to successfully
  220. build the component library by pulling out just about any other
  221. component registration unit. That makes it sound like some limit within
  222. Delphi 2.0 is being exceeded.
  223.  
  224. We also found that the command line compiler doesn't, for the moment,
  225. exhibit this problem. To use this approach, you would need to manually
  226. add the Abbrevia registration units (and such) to the CMPLIB32.DPR file
  227. manually, as shown below.  Compile with "DCC32 CMPLIB32", then rename
  228. CMPLIB32.DLL to CMPLIB32.DCL.
  229.  
  230. CMPLIB32.DPR:
  231.  
  232. uses
  233.   ...
  234.   SampReg,
  235.   abreg,
  236.   LibMain;
  237.   ...
  238.   {$R 'c:\Delphi2\Lib\SampReg.dcr'}
  239.   {$R 'c:\abbrevia\abreg.dcr'}
  240.    ...
  241.   RegisterModule('SampReg', SampReg.Register);
  242.   RegisterModule('abreg', abreg.Register);
  243.  
  244.  
  245. Note: You can have Delphi save the default COMPLIB32.DPR after a rebuild
  246. of the component library by selecting the "Save library source code"
  247. option from the Library tab of the Environment Options dialog.
  248.  
  249.  
  250. 999. Corrections to the Manual
  251. ======================================================================
  252.  
  253. p. 50-51,99-100    TAbArchiveItemFailureEvent definition has been changed - the
  254.         ProcessType parameter is no longer a const parameter.
  255.  
  256.  
  257. pp. 116-119    Low level class documentation is provided in the help file.
  258.         An example of the use of low level classes is provided
  259.         in the UsingApi example.
  260.  
  261. TAbZipItem.FileComment is documented in the help file.
  262.  
  263. When building a spanned disk set, you should always have AutoSave set to False.
  264.  
  265. The following new methods were added in Abbrevia 1.04:
  266.  
  267. TAbZipOutline.CloseArchive
  268. TAbZipOutline.OpenArchive
  269. TAbZipBrowser.CloseArchive
  270. TAbZipBrowser.OpenArchive
  271.  
  272. These methods are not documented in the manual. See the Abbrevia help file
  273. for a description of these methods.
  274.  
  275.