home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 1997 May / Pcwk0597.iso / delphi / jwrite.lzh / README.TXT < prev   
Text File  |  1996-04-30  |  12KB  |  248 lines
  1.         THE J-WRITE COMPONENT LIBRARY - README FILE
  2.  
  3. This file contains:
  4.  
  5. 0. PACKING LIST
  6. 1. INTRODUCTION
  7. 2. ABOUT THE J-WRITE COMPONENT LIBRARY
  8. 3. INSTALLATION PROCEDURES
  9. 4. INSTALLING THE HELP FILE
  10. 5. REMOVING THE COMPONENT LIBRARY.
  11.  
  12. 0. PACKING LIST
  13. ===============
  14.  
  15. - FILE_ID.DIZ                 BBS Information
  16. - ORDER.TXT                   Ordering Information
  17. - README.TXT                  This file
  18. - LICENCE.TXT                 Read this before installation
  19. - JCOMPNTS.HLP                Component Library Help File
  20. - JCOMPNTS.KWF                Delphi Topic Search keyword file
  21. - MANUAL.DOC                  User Manual
  22. - 16-bit\FILEVIEW.DCU         Viewer Classes
  23. - 16-bit\MAILEDIT.DCU         EMail Extensions
  24. - 16-bit\TEXTBUFF.DCU         Document Container Classes
  25. - 16-bit\UUENCODE.DCU         UUEncode Support
  26. - 16-bit\FILEVIEW.DCR         Icons
  27. - 16-bit\MAILEDIT.DCR         Icons
  28. - 16-bit\TEXTBUFF.DCR         Icons
  29. - 16-bit\UUENCODE.DCR         Icons
  30. - 16-bit\KEYEDIT.DCU          Edit Key property editor
  31. - 16-bit\KEYEDIT.DFM          Edit Key property editor resources
  32. - 16-bit\JWRUN.DCU            Support for running DOS Compression programs
  33. - JWRUN.EXE                      "
  34. - JWRUN.PIF                      "
  35. - 32-bit\FILEVIEW.DCU         Viewer Classes
  36. - 32-bit\MAILEDIT.DCU         EMail Extensions
  37. - 32-bit\TEXTBUFF.DCU         Document Container Classes
  38. - 32-bit\UUENCODE.DCU         UUEncode Support
  39. - 32-bit\FILEVIEW.DCR         Icons
  40. - 32-bit\MAILEDIT.DCR         Icons
  41. - 32-bit\TEXTBUFF.DCR         Icons
  42. - 32-bit\UUENCODE.DCR         Icons
  43. - 32-bit\KEYEDIT.DCU          Edit Key property editor
  44. - 32-bit\KEYEDIT.DFM          Edit Key property editor resources
  45. - 32-bit\JWRUN.DCU            Support for running DOS Compression programs
  46. - EXAMPLE\MDIEDIT.DPR         Example file
  47. - EXAMPLE\MDIEDIT.OPT            "
  48. - EXAMPLE\MDIEDIT.RES            "
  49. - EXAMPLE\MAIN.PAS               "
  50. - EXAMPLE\MAIN.DFM               "
  51. - EXAMPLE\CHILDWIN.PAS           "
  52. - EXAMPLE\CHILDWIN.DFM           "
  53. - EXAMPLE\ABOUT.PAS              "
  54. - EXAMPLE\ABOUT.DFM              "
  55.  
  56.  
  57.  
  58. 1. INTRODUCTION
  59. ================
  60.  
  61. Welcome to the J-Write Component Library. The J-Write components are a powerful 
  62. add-on to the Delphi Visual Component Library, and provide a comprehensive set of 
  63. text viewing and editing classes. 
  64.  
  65. The J-Write components have been designed to provide a powerful set of Delphi 
  66. components to support the viewing, printing and editing of text files. Such files 
  67. occur everywhere on most modern computer systems. They may contain network logs, 
  68. configuration information, or technical papers, such as Internet RFCs. 
  69.  
  70. J-Write is fast and handles large files (of the order of megabytes) as fast as it 
  71. handles small files. Just compare it loading and editing a megabyte or more of 
  72. text, with Delphi 2.0's TRichText control and you'll see what speed means.
  73.  
  74. A comprehensive online help file is included in this release. A User Manual is 
  75. also available in Word for Windows format. If you do not have access to Word for 
  76. Windows, then you can still read and print the User Manual using Microsoft's Word 
  77. viewer. This is freeware and available from ftp.microsoft.com, or the MSWORD Forum 
  78. (lib #2) on Compuserve. 
  79.  
  80. This release contains an example application program. This is fully described in 
  81. both the online help file and the User Manual.
  82.  
  83. This release contains both the 16-bit version which is compatible with Delphi 1.x 
  84. only, and a 32-bit version for Delphi 2.0. This, the Shareware version, will only 
  85. work when the Delphi Development Environment is also active. The registered 
  86. version has no such constraints applied and a source code version is also 
  87. available. Support is provided through MWA Software's Web pages on 
  88. http://www.demon.co.uk/mwa-soft.
  89.  
  90. 2. ABOUT J-WRITE THE COMPONENT LIBRARY
  91. ======================================
  92.  
  93. Speed and effectively unlimited file sizes are major design goals of the J-Write 
  94. Components. The J-Write components can access any file whose size may be expressed 
  95. within a 32-bit signed number and, moreover, the time taken to move around a file 
  96. and to edit it is independent of the size of the file. Fast search and replace 
  97. functions complete the basic function set.
  98.  
  99. Word wrap is comprehensively supported, with four separate word wrap algorithms 
  100. (on line breaks only, on window boundaries, on printer page width and after a set 
  101. number of characters). Tab stops can also be set (in logical inches). The 
  102. components can also recognise hard page breaks and calculate where soft page 
  103. breaks occur. In addition, any ANSI font (including True Type) can be used.
  104.  
  105. There is full keyboard and Mouse support. All Edit Keys are configurable by using 
  106. the Delphi Object Inspector, and the Mouse may be used to select text, and to drag 
  107. and drop selected text to any other part of a file.
  108.  
  109. Text files are now commonly used for EMail, and the J-Write Components include 
  110. support for the features necessary when processing EMail. There are uuEncode and 
  111. Decode engines, and text merging facilities including support for prefixing every 
  112. merged-in line with a common text prefix - this may be used to quote from earlier 
  113. EMails. There is even support for calling an external DOS compression utility in 
  114. order to compress a file prior to it being uuencoded and merged into a file being 
  115. edited.
  116.  
  117. If you are evaluating the J-Write Component Library then we hope that it proves 
  118. useful to you. Remember that the source code of all the components is also 
  119. available.
  120.  
  121. 3. INSTALLATION
  122. ===============
  123.  
  124. The following instructions describe how to install the J-Write components and help 
  125. file into the Delphi Desktop. The procedures describe below apply to the 16-bit 
  126. version of the component library. The installation procedures for the 32-bit 
  127. version are essentially identical, except that the Delphi Installation directory 
  128. is typically "C:\Delphi 2.0", and the components are found in the "32-bit" 
  129. subdirectory, instead of the "16-bit" subdirectory.
  130.  
  131. The Shareware version of the J-Write component library is supplied in a single 
  132. (.zip) archive. This must first be expanded into a directory created to hold the J-
  133. Write components. For example, you may have installed Delphi in the directory 
  134. C:\DELPHI and you wish to keep the J-Write components in a subdirectory (JWRITE) 
  135. of the Delphi directory. You should therefore start by creating the directory 
  136. C:\DELPHI\JWRITE and then expand the J-Write archive into that directory. Note 
  137. that you should preserve the archived directory structure when expanding the 
  138. archive. For example, if you are using pkunzip to expand the archive, then you 
  139. should using the ô-dö switch when running pkunzip. Assuming that the J-Write 
  140. archive is in the root directory of the C: drive, the following DOS script may be 
  141. used to expand the J-Write components:
  142.  
  143.     C:
  144.     cd \DELPHI
  145.     md JWRITE
  146.     cd JWRITE
  147.     pkunzip -d C:\JCMPT010.ZIP
  148.  
  149. You may now proceed to install the J-Write components under Delphi, as follows:
  150.  
  151. 1. Backup your 'COMPLIB.DCL' file. You will find this file in the 'BIN' 
  152. subdirectory, in your Delphi directory. For example, if you have installed Delphi 
  153. in "C:\DELPHI", then you will need to take a backup of 
  154. 'C:\DELPHI\BIN\COMPLIB.DCL'. If for any reason, the installation fails, you will 
  155. need to restore a working version COMPLIB.DCL from this backup.
  156.  
  157. 2. Start Delphi and select "Install Components" from the "Options" menu. The 
  158. "Install Components" Dialog box will now appear.
  159.  
  160. 3. Append the path of the J-Write components directory to the "Search Path". You 
  161. will need to separate this path name from the existing search path by a semi-
  162. colon. For example, if the J-Write components were installed in C:\DELPHI\JWRITE, 
  163. then add ";C:\DELPHI\JWRITE\16-BIT" to the end of the existing search path.
  164.  
  165. 4. Click on the "Add" button, and browse for the J-Write components directory. 
  166. Select the "FILEVIEW.DCU" file. 
  167.  
  168. 5. Repeat the "Add" operation and select the "MAILEDIT.DCU" file.
  169.  
  170. 6. Click on "OK". The component library should now be rebuilt. Once this is 
  171. complete, then you will have three new components on the standard palette, and one 
  172. additional component on the "Additional" palette. In the former case, these are 
  173. the "FileViewer", the "FileEditor" and the "MailEditor". In the latter case, this 
  174. is the "ProgressMeter" component. A property editor will also have been installed 
  175. for changing the edit keys.
  176.  
  177. 7. You may now merge the J-Write component library help keywords with the Delphi 
  178. Help System. These procedures are described below.
  179.  
  180. 8. Finally, you may wish also to add the J-Write Components Help File to the 
  181. Delphi program group. 
  182.  
  183. Under Windows 3.1, you may do this by selecting File|New when the Delphi program 
  184. group is active. You need to create a new Program Item, and then enter the name of 
  185. the help file (e.g. C:\DELPHI\JWRITE\JCOMPNT.HLP) as the command line. 
  186.  
  187. Under Windows 95, you should again select the Delphi Program Group in Windows 
  188. Exploring, and, making sure that no icons are selected, select the File|New menu 
  189. item and create a new shortcut. Enter the command line as the path to the help 
  190. file (e.g. C:\DELPHI\JWRITE\JCOMPNT.HLP).
  191.  
  192.  
  193. 4. INSTALLING THE J-WRITE COMPONENTS HELP FILE
  194. ==============================================
  195.  
  196. 1. First close Delphi and then take a backup of the æDELPHI.HDXÆ file. This is 
  197. located in the BIN subdirectory, in your Delphi directory. For example, if you 
  198. have installed Delphi in "C:\DELPHI", then you will need to take a backup of 
  199. 'C:\DELPHI\BIN\DELPHI.HDX'. If the help index installation procedure fails, then 
  200. you may restore the help index from its backup.
  201.  
  202. 2. Now run the ôHelpInstö program located in the Delphi program group. Use 
  203. File|Open to open æDELPHI.HDX.
  204.  
  205. 3. Select Keywords|Add Keyword File, and select the æJCOMPNTS.KWFÆ file from the 
  206. directory in which you installed the J-Write component library.
  207.  
  208. 4. Save the new index using File|Save.
  209.  
  210. Once the J-Write Keyword index has been installed you can search for J-Write 
  211. classes, properties, etc., from the Delphi IDE, using Help|Topic Search. They are 
  212. now part of the same list of keywords, as are DelphiÆs own VCL. Note that the 
  213. first time you try to access a J-Write class, etc. using the Topic Search, you may 
  214. find that you have to browse for the help file. This is contained in the directory 
  215. in which you installed the J-Write Component Library. Thereafter, there should be 
  216. no need to browse for this file again.
  217.  
  218. 5. REMOVING THE J-WRITE COMPONENT LIBRARY
  219. =========================================
  220.  
  221. If you longer wish to use the J-Write Components, then you should perform the 
  222. following before deleting the J-Write components from your system.
  223.  
  224. 1. Backup your 'COMPLIB.DCL' file. You will find this file in the 'BIN' 
  225. subdirectory, in your Delphi directory. For example, if you have installed Delphi 
  226. in "C:\DELPHI", then you will need to take a backup of 
  227. 'C:\DELPHI\BIN\COMPLIB.DCL'.
  228.  
  229. 2. Start Delphi and select "Install Components" from the "Options" menu. The 
  230. "Install Components" Dialog box will now appear.
  231.  
  232. 3. Select FileView from the list of installed units, and click on the Remove 
  233. button. Do the same for MailEdit. 
  234.  
  235. 4. Remove the J-Write components directory from the Search Path.
  236.  
  237. 5. Finally, click on OK and the component library will be rebuilt less the J-Write 
  238. Components.
  239.  
  240. 6. Exit Delphi and run the HelpInst utility from the Delphi Program Group to 
  241. remove the J-Write help files by removing æJCOMPNTS.KWFÆ from the list of 
  242. æDELPHI.HDXÆ keyword files, and delete the J-Write Components Help File icon from 
  243. the Delphi program group, if present.
  244.  
  245.  
  246.  
  247.  
  248.