home *** CD-ROM | disk | FTP | other *** search
/ The Developer Connection…ice Driver Kit for OS/2 3 / DEV3-D1.ISO / devtools / tkbeta / 32bit / ipfc32 / readme < prev   
Encoding:
Text File  |  1993-11-15  |  4.9 KB  |  165 lines
  1.  
  2.                              README for IPFC - 32-bit
  3.                           (c) Copyright IBM Corp. 1993
  4.  
  5. INSTALLATION
  6. ____________
  7.  
  8. After copying the files over, add the line:
  9.  
  10. SET IPFC=X:\DEVTOOLS\32BIT\IPFC32
  11.  
  12. to your CONFIG.SYS where X: is the drive where
  13. you installed the 32-bit tools.
  14.  
  15.  
  16. INTRODUCTION
  17. ____________
  18.  
  19.  
  20.    This README contains information related to the new
  21.    32-bit IPF compiler.  The new compiler provides the
  22.    following enhancements over the previous version:
  23.  
  24.    o   Increased limits
  25.  
  26.    o   Better performance
  27.  
  28.    o   Two new macros: .ce and .nameit
  29.  
  30.    o   One new tag: :hdref.
  31.  
  32.    o   New command-line interface (old interface is still
  33.        supported)
  34.  
  35.    o   Environment variables for specifying the locations
  36.        of imbed files, artwork and artlink files, and
  37.        temporary files
  38.  
  39.    o   Ability to specify an output file on the command line
  40.  
  41.    o   Elimination of dependency on BMTAG.TAG and APSYMBOL.APS
  42.        files.  APSYMBOL.APS is still used, but it is no
  43.        longer a fatal error if it is not available.
  44.  
  45.    o   Misspelling in IPF*.NLS files have been corrected
  46.        ("GRAMMER" is now "GRAMMAR")
  47.  
  48.    o   Output messages from the compiler now indicate "error"
  49.        for severe messages, and "warning" for others
  50.  
  51. NOTE: Due to some incompatibilities between the 16-bit and
  52. the 32-bit programming interface, it was necessary to disable
  53. one of the compression algorithms used for bitmaps and
  54. searches.  In our testing, we have found that this algorithm
  55. is used very seldom, so this should not impact most users.
  56. The result of disabling this algorithm is that you will
  57. occasionally see a small increase in the size of your output
  58. files when compared to the 16-bit compiler.
  59.  
  60. INCREASED LIMITS
  61. ________________
  62.  
  63. The new compiler has increased the vocabulary limit from
  64. 16,000 words to 64,000 words.  The overall document size
  65. and page size have also been increased.  Also, the external
  66. database limit has been increased to 255.
  67.  
  68. We have successfully compiled files of up to 23MG.
  69.  
  70. IMPORTANT NOTES: Due to the design of the compiler, you will
  71. notice significant swapper growth when compiling very large
  72. files.  Also, although there is no limit to the size of a
  73. page when compiled, you might see odd behavior in the help
  74. manager itself.  Usually, this is the absence of scroll bars.
  75. To fix this problem, make your page smaller.
  76.  
  77. BETTER PERFORMANCE
  78. __________________
  79.  
  80. Initial tests indicate that this compiler is from 30% to
  81. 50% faster than the 16-bit compiler.
  82.  
  83. TWO NEW MACROS
  84. ______________
  85.  
  86. Two new macros have been introduced.
  87.  
  88. .ce is used to center a line of text.  Example:
  89.  
  90. .ce Text to center
  91.  
  92. .nameit is used to perform symbol substitution.  Example:
  93.  
  94. .nameit symbol=os2 text='Operating System/2 Version 2.1'
  95.  
  96. You can then use the symbol &os2. in your document and the
  97. text "Operating System/2 Version 2.1" will be placed in
  98. your document.
  99.  
  100. ONE NEW TAG
  101. ___________
  102.  
  103. A new tag has been introduced, the :hdref. tag.  This tag
  104. behaves similar to the Bookmaster tag of the same name.
  105. It creates a hypertext link with the text "Reference."
  106. For example:
  107.  
  108. :hdref refid=10.
  109.  
  110. produces a hyperlink with the text "Reference" that links
  111. to the panel with an id of 10.  This tag is useful when you
  112. have many links and you do not want to type the text of each
  113. link.
  114.  
  115. NEW COMMAND-LINE INTERFACE
  116. __________________________
  117.  
  118. A new command-line interface has been introduced.  To view
  119. it, type IPFC with no parameters.  For help on any
  120. of the options, type IPFC X:? where X is one of the options.
  121.  
  122. NOTE: The old command-line interface is still supported.
  123.  
  124. ENVIRONMENT VARIABLES
  125. _____________________
  126.  
  127. Three environment variables have been introduced for
  128. specifying the location of source files.  The IPFCIMBED
  129. environment variable is used to search for files imbedded
  130. with the .im macro.  The IPFCARTWORK environment variable
  131. is used to specify the location of artwork files and
  132. artlink files.  The TMP environment variable is used to
  133. indicate where the compiler should store the intermediate
  134. files it creates during the compilation.
  135.  
  136. NOTE: The IPFC environment variable has been enhanced to
  137. allow multiple paths.
  138.  
  139. ABILITY TO SPECIFY OUTPUT FILE
  140. ______________________________
  141.  
  142. You may now specify an output file on the command line.
  143. For example:
  144.  
  145. IPFC TEST.IPF C:\FILE.HLP
  146.  
  147. This filename can include path information.
  148.  
  149. NOTE: Be sure that you use the proper extension, if any.
  150. Files compiled as INF files should have the INF extension.
  151.  
  152. ELIMINATION OF BMTAG.TAG
  153. ________________________
  154.  
  155. The BMTAG.TAG file is no longer necessary.  Also the absence
  156. of the APSYMBOL.APS file is no longer a fatal error.  In
  157. addition, some small improvements have been made to the
  158. APSYMBOL.APS file.
  159.  
  160. MISSPELLINGS
  161. ____________
  162.  
  163. New IPF*.NLS files are being shipped with the misspelling of
  164. GRAMMAR corrected.  Old files are still compatible.
  165.