home *** CD-ROM | disk | FTP | other *** search
/ PC User 2001 August / APC_Aug2001_CD2.iso / features / j2sdk / files / linux / j2sdklin.bin / jdk1.3.1 / lib / htmlconverter.jar / readme.txt < prev   
Encoding:
Text File  |  2001-05-06  |  12.2 KB  |  366 lines
  1. Java(tm) Plug-in HTML Converter  Readme
  2.  
  3. Version: 1.3.1
  4.  
  5.  
  6. *****   BACKUP ALL FILE BEFORE CONVERTING THEM WITH THIS TOOL   *****
  7. *****   CANCELLING A CONVERSION WILL NOT ROLLBACK THE CHANGES.  *****
  8. *****   COMMENTS WITHIN THE APPLET TAG ARE IGNORED    *****
  9.  
  10. -----
  11. Contents of this file
  12. -----
  13. 1)  New Features
  14. 2)  Bug Fixes
  15. 3)  About Java(tm) Plug-in HTML Converter
  16. 4)  The conversion process
  17. 5)  Choosing files within folders to convert
  18. 6)  Choosing backup folder
  19. 7)  Generating a log file
  20. 8)  Choosing a conversion template
  21. 9)  Converting
  22. 10)  More Conversions or Quit
  23. 11)  Using the command line interface method of running the converter
  24. 12)  Details about templates
  25. 13)  Running HTML Converter (Windows & Solaris)
  26.  
  27. -----
  28. 1)  New Features:
  29. ----- 
  30.  
  31.     *   Updated extended templates to support Netscape 6.
  32.     *   Updated all templates to support new Multi-versioning features
  33.         in Java Plug-in.
  34.     *   Enhanced user interface with Swing 1.1 for i18n support.
  35.     *   Enhanced Advanced Option dialog to support new SmartUpdate and 
  36.         MimeType template tags.
  37.     *   Enhanced HTML Converter to be used with both Java Plug-in 1.1.x 
  38.         Java Plug-in 1.2.x and Java Plug-in 1.3.x.
  39.     *   Enhanced SmartUpdate and MimeType support in all conversion 
  40.         templates.
  41.     *   Added "scriptable=false" to the OBJECT/EMBED tag in all
  42.         templates. This is used for disable typelib generation
  43.         when Java Plug-in is not used for scripting.
  44.  
  45.     
  46. -----
  47. 2)  Bugs Fixed:
  48. -----
  49.     *   Enhanced error handling when properties files are not found.
  50.     *   Enhanced HTML conversion so the result EMBED/OBJECT tag can be 
  51.         used in AppletViewer in JDK 1.2.x
  52.     *   Eliminated unnecessary files which were left over from HTML 
  53.         Converter 1.1.x.
  54.     *   Generated EMBED/OBJECT with CODE, CODEBASE, etc attribute names
  55.         instead of JAVA_CODE, JAVA_CODEBASE, etc. This enabled generated
  56.         page to be used in JDK 1.2.x AppletViewer.
  57.     *   Support MAYSCRIPT conversion if it is presented in the APPLET tag.
  58.  
  59.  
  60. -----
  61. 3)  About Java(tm) Plug-in HTML Converter:
  62. -----
  63.   Java(tm) Plug-in HTML Converter is a utility that allows you to convert any 
  64.   HTML page which contains applets to a format that will use the Java(tm) 
  65.   Plug-in.  
  66.  
  67.  
  68. -----
  69. 4)  The conversion process:
  70. -----
  71.   
  72.   The Java(tm) Plug-in HTML Converter will convert any file(s) containing 
  73.   applets to a form that can be used with the Java(tm) Plug-in.  
  74.   
  75.   The process of converting each file is as follows:
  76.   
  77.   First, HTML that is not part of an applet is transferred from the source 
  78.   file to a temporary file.  When an <APPLET tag is reached, the converter 
  79.   will parse the applet to the first </APPLET tag (not contained in qoutes), 
  80.   and merge the applet data with the template. (See Details about templates, 
  81.   below) If this completes without error, the original html file will be moved 
  82.   to the backup folder and the temporary file will then be renamed to the 
  83.   original file's name.  Thus, your original files will never be removed 
  84.   from disk.
  85.   
  86.   Note that the converter will effectively convert the files in place.  So, 
  87.   once you have run the converter, your files will be setup to use the 
  88.   Java(tm) Plug-in.
  89.  
  90.   
  91. -----
  92. 5)  Choosing files within folders to convert:
  93. -----
  94.  
  95. To convert all files within a folder, you may type in the path to the folder, 
  96. or choose the browse button to select a folder from a dialog.  Once you have 
  97. chosen a path, you may supply any number to file specifiers in the "Matching 
  98. File Names".  Each specifier must be separated by a comma.  You may use * as 
  99. a wildcard.  If you put a filename with wildcard, only that single file will
  100. be converted. Lastly, select the checkbox "Include Subfolders", if you would 
  101. like all files in nested folders which match the file name to be converted.
  102.  
  103.  
  104. -----
  105. 6)  Choosing backup folder
  106. -----
  107.  
  108. The default backup folder path is the source path with an "_BAK" appended 
  109. to the name. i.e.  If the source path is c:/html/applet.html  (converting 
  110. one file) then the backup path would be c:/html_BAK.  If the source path 
  111. is c:/html (converting all files in path) then the backup path would be 
  112. c:/html_BAK. The backup path may be changed by typing a path in the field 
  113. next to "Backup files to folder:", or by browsing for a folder.
  114.  
  115. Unix(Solaris): 
  116. The default backup folder path is the source path with an "_BAK" appended to 
  117. the name. i.e.  If the source path is /home/user1/html/applet.html (converting
  118. one file) then the backup path would be /home/user1/html_BAK. If the source
  119. path is /home/user1/html (converting all files in path) then the backup path 
  120. would be /home/user1/html_BAK. The backup path may be changed by typing a path
  121. in the field next to "Backup files to folder:", or by browsing for a folder.
  122.  
  123.  
  124. -----
  125. 7)  Generating a log file
  126. -----
  127.  
  128. If you would like a log file to be generated, choose the checkbox 
  129. "Generate Log File". Type in a path or browse to choose a folder.  The 
  130. log file contains basic information related to the converting process.
  131.  
  132. -----
  133. 8)  Choosing a conversion template
  134. -----
  135.  
  136. If a default template will be used if none is chosen.  This template will 
  137. produce converted html files that will work with IE and Netscape.  If you 
  138. would like to use a different template, you may choose it from the menu on 
  139. the main screen.  If you choose other, you will be allowed to choose a file 
  140. that will be used as the template.  If you choose a file, BE SURE THAT IT 
  141. IS A TEMPLATE.
  142.  
  143. -----
  144. 9)  Converting
  145. -----
  146.  
  147. Click the "Convert..." button to begin the conversion process.  A process 
  148. dialog will show the files being processed, the number for files process, 
  149. the number of applets found, and number of errors found.
  150.  
  151. -----
  152. 10)  More Conversions or Quit
  153. -----
  154.  
  155. When the conversion is complete, the button in the process dialog will change 
  156. from "Cancel" to "Done".  You may choose "Done" to close the dialog.  At this 
  157. point, choose "Quit" to close the Java(tm) Plug-in HTML Converter, or selected
  158. another set of files to convert and choose "Convert..." again.
  159.  
  160.  
  161. -----
  162. 11)  Using the command line interface method of running the converter
  163. -----
  164. COMMAND LINE INTERFACE:
  165.  
  166.     The converted now supports a command line interface. From a command 
  167. line, you may type:
  168.  
  169. java HTMLConverter [ filespecs ] [-simulate] [-options1 value1 [-option2 value2 [...]]]
  170.  
  171. If only "java HTMLConverter" is specified (no filespecs or options) the GUI version 
  172. of the converter will be launched.  Otherwise, the GUI will be suppressed.
  173.  
  174. filespecs:  space delimited list of file specs, * wildcard.  (*.html *.htm)
  175.  
  176. Options:
  177.     source:        Path to files.  (c:\htmldocs in Windows, 
  178.             /home/user1/htmldocs in Unix) Default: <userdir>
  179.             If the path is relative, it is assumed to be relative to the 
  180.             directory that HTMLConverter was launched.
  181.  
  182.     backup:        Path to write backup files.  Default: <userdir>/<source>_bak
  183.             If the path is relative, it is assumed to be relative to the 
  184.             directory that HTMLConverter was launched.
  185.  
  186.     subdirs:    Should files in subdirectories be processed.  Default:  FALSE
  187.  
  188.     template:   Name of template file.  Default:  default.tpl-Standard (IE & Navigator) 
  189.             for Windows & Solaris Only.  USE DEFAULT IF UNSURE.
  190.  
  191.     log:          Path and filename to write log.  (Default <userdir>/convert.log)
  192.  
  193.     progress:   Display standard out progress while converting.  Default: true
  194.  
  195.     simulate:   Display the specifics to the conversion without converting.
  196.             USE THIS OPTION IF UNSURE ABOUT CONVERTING.  YOU WILL BE GIVEN
  197.             A LIST OF DETAILS SPECIFIC TO THE CONVERSION.
  198.  
  199. -----
  200. 12)  Details about templates
  201. -----
  202.  
  203. The template file is the basis behind converting applets.  It is simply a text 
  204. file containing tag the represent parts of the original applet.  By 
  205. add/removing/moving the tags in a template file, you can alter the output 
  206. of the converted file.
  207.  
  208. Supported Tags:
  209.  
  210. $OriginalApplet$    This tag is substituted with the complete text of the 
  211.             original applet.
  212.  
  213. $AppletAttributes$  This tag is substituted with all of the applets attributes.
  214.             (code, codebase, width, height, etc.)
  215.  
  216. $ObjectAttributes$  This tag is substituted with all the attributes required by
  217.             the object tag.
  218.  
  219. $EmbedAttributes$   This tag is substituted with all the attributes required by
  220.             the embed tag.
  221.  
  222. $AppletParams$  This tag is substituted with all the applet's <param ...> tags
  223.  
  224. $ObjectParams$  This tag is substituted with all the <param...> tags required 
  225.         by the object tag.
  226.  
  227. $EmbedParams$    This tag is substituted with all the <param...> tags required by
  228.         the embed tag in the form  NAME=VALUE
  229.  
  230. $AlternateHTML$        This tag is substituted with the text in the No support for 
  231.             applets area of the original applet
  232.                 
  233. $CabFileLocation$   This is the URL of the cab file that should be used in each
  234.             template that targets IE.
  235.                     
  236. $NSFileLocation$    This is the URL of the Netscape plugin that be used in each
  237.             template that targets Netscape
  238.  
  239. $SmartUpdate$        This is the URL of the Netscape SmartUpdate that be used in 
  240.             each template that targets Netscape Navigator 4.0 or later.
  241.  
  242. $MimeType$        This is the MIME type of the Java object
  243.  
  244.  
  245. /*************************/
  246. default.tpl is the default template for the converter. The converted page can 
  247. be used in IE and Navigator on Windows 95 or Windows NT to invoke Java(TM) 
  248. Plug-in. This template can also be used with Netscape on Unix(Solaris)
  249.  
  250. <!-- HTML CONVERTER -->
  251. <OBJECT classid="clsid:E19F9330-3110-11d4-991C-005004D3B3DB"
  252. $ObjectAttributes$ codebase="$CabFileLocation$">
  253. $ObjectParams$
  254. <PARAM NAME="type" VALUE="$MimeType$">
  255. <PARAM NAME="scriptable" VALUE="false">
  256. $AppletParams$<COMMENT>
  257. <EMBED type="$MimeType$" $EmbedAttributes$
  258. $EmbedParams$ scriptable=false pluginspage="$NSFileLocation$"><NOEMBED></COMMENT>
  259.         $AlternateHTML$
  260.     </NOEMBED></EMBED>
  261. </OBJECT>
  262.  
  263. <!--
  264. $ORIGINALAPPLET$
  265. -->
  266. /*************************/
  267.  
  268.  
  269. /*************************/
  270. ieonly.tpl -- the converted page can be used to invoke Java(TM) Plug-in in IE 
  271. on Windows only.
  272.  
  273. <!-- HTML CONVERTER -->
  274. <OBJECT classid="clsid:E19F9330-3110-11d4-991C-005004D3B3DB"
  275. $ObjectAttributes$ codebase="$CabFileLocation$">
  276. $ObjectParams$
  277. <PARAM NAME="type" VALUE="$MimeType$">
  278. <PARAM NAME="scriptable" VALUE="false">
  279. $AppletParams$
  280. $AlternateHTML$
  281. </OBJECT>
  282.  
  283. <!--
  284. $ORIGINALAPPLET$
  285. -->
  286. /*************************/
  287.  
  288.  
  289. /*************************/
  290. nsonly.tpl -- the converted page can be used to invoke Java(TM) Plug-in in 
  291. Navigator on Windows and Solaris.
  292.  
  293. <!-- HTML CONVERTER -->
  294. <EMBED type="$MimeType$" $EmbedAttributes$
  295. $EmbedParams$ scriptable=false pluginspage="$NSFileLocation$"><NOEMBED>
  296. $AlternateHTML$
  297. </NOEMBED></EMBED>
  298.  
  299. <!--
  300. $ORIGINALAPPLET$
  301. -->
  302. /*************************/
  303.  
  304.  
  305. /*************************/
  306. extend.tpl -- the converted page can be used in any browser and any platform. 
  307. If the browser is IE or Navigator on Windows (Navigator only on Solaris), 
  308. Java(TM) Plug-in will be invoked. Otherwise, the browser's default JVM is used.
  309.  
  310.  
  311. <!-- HTML CONVERTER -->
  312. <SCRIPT LANGUAGE="JavaScript"><!--
  313.     var _info = navigator.userAgent; var _ns = false; var _ns6 = false;
  314.     var _ie = (_info.indexOf("MSIE") > 0 && _info.indexOf("Win") > 0 &&
  315. _info.indexOf("Windows 3.1") < 0);
  316. //--></SCRIPT>
  317. <COMMENT><SCRIPT LANGUAGE="JavaScript1.1"><!--
  318.     var _ns = (navigator.appName.indexOf("Netscape") >= 0 &&
  319. ((_info.indexOf("Win") > 0 && _info.indexOf("Win16") < 0 &&
  320. java.lang.System.getProperty("os.version").indexOf("3.5") < 0) ||
  321. _info.indexOf("Sun") > 0));
  322.     var _ns6 = ((_ns == true) && (_info.indexOf("Mozilla/5") >= 0));
  323. //--></SCRIPT></COMMENT>
  324.  
  325. <SCRIPT LANGUAGE="JavaScript"><!--
  326.     if (_ie == true) document.writeln('<OBJECT
  327. classid="clsid:E19F9330-3110-11d4-991C-005004D3B3DB" $ObjectAttributes$
  328. codebase="$CabFileLocation$"><NOEMBED><XMP>');
  329.     else if (_ns == true && _ns6 == false) document.writeln('<EMBED
  330. type="$MimeType$" $EmbedAttributes$
  331. $EmbedParams$ scriptable=false 
  332. pluginspage="$NSFileLocation$"><NOEMBED><XMP>');
  333. //--></SCRIPT>
  334. <APPLET $AppletAttributes$></XMP>
  335. $ObjectParams$
  336. <PARAM NAME="type" VALUE="$MimeType$">
  337. <PARAM NAME="scriptable" VALUE="false">
  338. $AppletParams$
  339. $AlternateHTML$
  340. </APPLET>
  341. </NOEMBED></EMBED></OBJECT>
  342.  
  343.  
  344. <!--
  345. $ORIGINALAPPLET$
  346. -->
  347. /*************************/
  348.  
  349.  
  350. 13)  Running HTML Converter:
  351.  
  352.     Once the installation is done, change directory to the install folder, 
  353. and do the following for your specific platform:
  354.  
  355. For example, on Windows:
  356.  
  357. > cd <HTML Converter Directory>
  358. > java -jar htmlconv-131.jar
  359.  
  360. On Unix(Solaris):
  361.  
  362. %cd <HTML Converter Directory>
  363. %java -jar htmlconv-131.jar
  364.  
  365.  
  366.