Sun Java Solaris Communities My SDN Account Join SDN
 
Java Plug-in 1.3 Documentation

HTML Converter Installation and Use

 

HTML Converter Version 1.3.0_01 and Higher:
Installation and Use

Japanese

Introduction
Installation
Running the GUI Version of the HTML Converter

Choosing files within folders to convert
Choosing a backup folder
Generating a log file
Choosing a conversion template
Converting
Quit or convert more files
Details about templates

Running the converter from the command line

Notes:

  1. It is recommended that you use the same version HTML Converter and Java Plug-in.
  2. Backup all files before converting them with this tool.
  3. Cancelling a conversion will not rollback the changes.
  4. Comments within the applet tag are ignored.

Introduction

 Java Plug-in HTML Converter is a utility allowing you to convert any HTML page (file) containing applets to a format that will use the Java Plug-in. The conversion process is as follows:
 
First, HTML that is not part of an applet is transferred from the source file to a temporary file.  Then, when an <APPLET tag is reached, the converter will parse the applet to the first </APPLET tag (not contained in quotes) and merge the applet data with the template. (See details about templates below.) If this completes without error, the original html file is moved to the backup folder and the temporary file is then renamed as the original file's name.
 

The converter effectively converts the files in place.  Thus, once you have run the converter, your files are setup to use the Java Plug-in.

Installation

Step 1: Download the HTML Converter zip file—e.g., htmlconv-1_3_0_01.zip—to the directory of your choice, <HTML Converter Directory>.

Step 2: Unzip the file according to your platform.

On Microsoft Windows: Use WinZip version 7.0 or later to unzip the file.

On the Solaris operating environment: At a terminal console window, cd to the directory containing the zip file, then type (csh):

%unzip htmlconv-1_3_0_01.zip

<HTML Converter Directory> will then contain a file named htmlconv1_3.jar.

Running the GUI version of the HTML Converter

At the command line,  cd to <HTML Converter Directory> and do the following, depending on your platform:

On Microsoft Windows: Launch the converter with this command:

java -jar htmlconv1_3.jar -gui

On Linux or the Solaris operating environment: Launch the converter with this command:

java -jar htmlconv1_3.jar -gui


Choosing files within folders to convert:

To convert all files within a folder, you may type in the path to the folder, or choose the browse button to select a folder from a dialog.  Once you have chosen a path, you may supply any number of file specifiers in the "Matching File Names".  Each specifier must be separated by a comma.  You may use * as a wildcard.  If you put a filename with wildcard, only that single file will be converted. Finally, select the checkbox "Include Subfolders", if you would like all files in nested folders which match the file name to be converted.
 

Choosing a backup folder:

Microsoft Windows

The default backup folder path is the source path with an "_BAK" appended to the name; e.g., if the source path is c:/html/applet.html  (one file to be converted), then the backup path would be c:/html_BAK.  If the source path is c:/html (converting all files in the path), then the backup path would be c:/html_BAK. The backup path may be changed by typing a path in the field next to "Backup files to folder:", or by browsing for a folder.

Unix (Solaris operating environment):

The default backup folder path is the source path with an "_BAK" appended to the name; e.g., if the source path is /home/user1/html/applet.html (one file to be converted), then the backup path would be /home/user1/html_BAK. If the source path is /home/user1/html (converting all files in path) then the backup path would be /home/user1/html_BAK. The backup path may be changed by typing a path in the field next to "Backup files to folder:", or by browsing for a folder.
 

Generating a log file:

If you would like a log file to be generated, choose the checkbox "Generate Log File". Type in a path or browse to choose a folder.  The log file contains basic information related to the converting process.
 

Choosing a conversion template:

A default template will be used if none is chosen.  This template will produce converted html files that will work with IE and Netscape.  If you would like to use a different template, you may choose it from the menu on the main screen.  If you choose other, you will be allowed to choose a file that will be used as the template.  If you choose a file, be sure that it is a template.
 

Converting:

Click the "Convert..." button to begin the conversion process.  A dialog will show the files being processed, the number of files processed, the number of applets found, and number of errors.
 

Quit or Convert More Files:
 
When the conversion is complete, the button in the process dialog will change from "Cancel" to "Done".  You may choose "Done" to close the dialog.  At this point, choose "Quit" to close the Java Plug-in HTML Converter, or select another set of files to convert and choose "Convert..." again.

Details about templates:

The template file is the basis behind converting applets.  It is simply a text file containing tags that represent parts of the original applet.  By
adding/removing/moving the tags in a template file, you can alter the output of the converted file.

Supported Tags:

$OriginalApplet$ This tag is substituted with the complete text of the original applet.
$AppletAttributes$

This tag is substituted with all of the applets attributes (code, codebase, width, height, etc.).

$ObjectAttributes$ This tag is substituted with all the attributes required by the object tag.
$EmbedAttributes$ This tag is substituted with all the attributes required by the embed tag.
$AppletParams$ This tag is substituted with all the applet's <param ...> tags
$ObjectParams$ This tag is substituted with all the <param...> tags required by the object tag.
$EmbedParams$ This tag is substituted with all the <param...> tags required by the embed tag in the form  name=value
$AlternateHTML$ This tag is substituted with the text in the No support for applets area of the original applet
$CabFileLocation$ This is the URL of the cab file that should be used in each template that targets IE.
$NSFileLocation$ This is the URL of the Netscape plugin to be used in each template that targets Netscape.
$SmartUpdate$ This is the URL of the Netscape SmartUpdate to be used in each template that targets Netscape Navigator 4.0 or later.
$MimeType$ This is the MIME type of the Java object.

 

default.tpl is the default template for the converter. The converted page can be used in IE and Navigator on Microsoft Windows to invoke Java Plug-in. This template can also be used with Netscape on Unix(Solaris operating environment)

<!-- HTML CONVERTER -->
<OBJECT classid="clsid:E19F9330-3110-11d4-991C-005004D3B3DB"
$ObjectAttributes$ codebase="/products/plugin/1.3/docs/$CabFileLocation$">
$ObjectParams$
<PARAM NAME="type" VALUE="$MimeType$">
<PARAM NAME="scriptable" VALUE="false">
$AppletParams$<COMMENT>
<EMBED type="$MimeType$" $EmbedAttributes$
$EmbedParams$ scriptable=false pluginspage="$NSFileLocation$"><NOEMBED>
</COMMENT>
$AlternateHTML$
 </NOEMBED></EMBED>
</OBJECT>

<!--
$ORIGINALAPPLET$
-->

ieonly.tpl -- the converted page can be used to invoke Java Plug-in in IE on Microsoft Windows only.

<!-- HTML CONVERTER -->
<OBJECT classid="clsid:E19F9330-3110-11d4-991C-005004D3B3DB"
$ObjectAttributes$ codebase="/products/plugin/1.3/docs/$CabFileLocation$">
$ObjectParams$
<PARAM NAME="type" VALUE="$MimeType$">
<PARAM NAME="scriptable" VALUE="false">
$AppletParams$
$AlternateHTML$
</OBJECT>

<!--
$ORIGINALAPPLET$
-->

nsonly.tpl -- the converted page can be used to invoke Java Plug-in in Navigator on Microsoft Windows and the Solaris operating environment.

<!-- HTML CONVERTER -->
<EMBED type="$MimeType$" $EmbedAttributes$
$EmbedParams$ scriptable=false pluginspage="$NSFileLocation$"><NOEMBED>
$AlternateHTML$
</NOEMBED></EMBED>

<!--
$ORIGINALAPPLET$
-->

extend.tpl -- the converted page can be used in any browser and any platform. If the browser is IE or Navigator on Microsoft Windows (Navigator on the Solaris operating environment), Java Plug-in will be invoked. Otherwise, the browser's default JVM is used.
 
<!-- HTML CONVERTER -->
<SCRIPT LANGUAGE="JavaScript"><!--
var _info = navigator.userAgent; var _ns = false; var _ns6 = false;
var _ie = (_info.indexOf("MSIE") > 0 && _info.indexOf("Win") > 0 &&
_info.indexOf("Windows 3.1") < 0);
//--></SCRIPT>
<COMMENT><SCRIPT LANGUAGE="JavaScript1.1"><!--
var _ns = (navigator.appName.indexOf("Netscape") >= 0 &&
((_info.indexOf("Win") > 0 && _info.indexOf("Win16") < 0 &&
java.lang.System.getProperty("os.version").indexOf("3.5") < 0) ||
_info.indexOf("Sun") > 0));
var _ns6 = ((_ns == true) && (_info.indexOf("Mozilla/5") >= 0));
//--></SCRIPT></COMMENT>

<SCRIPT LANGUAGE="JavaScript"><!--
if (_ie == true) document.writeln('<OBJECT
classid="clsid:E19F9330-3110-11d4-991C-005004D3B3DB" $ObjectAttributes$
codebase="/products/plugin/1.3/docs/$CabFileLocation$"><NOEMBED><XMP>');
else if (_ns == true && _ns6 == false) document.writeln('<EMBED
type="$MimeType$" $EmbedAttributes$
$EmbedParams$ scriptable=false 
pluginspage="$NSFileLocation$"><NOEMBED><XMP>');
//--></SCRIPT>
<APPLET $AppletAttributes$></XMP>
$ObjectParams$
<PARAM NAME="type" VALUE="$MimeType$">
<PARAM NAME="scriptable" VALUE="false">
$AppletParams$
$AlternateHTML$
</APPLET>
</NOEMBED></EMBED></OBJECT>

<!--
$ORIGINALAPPLET$
-->

Running the converter from the command line:

Format:

java -jar htmlconv1_3.jar [ filespecs ] [-simulate] [-options1 value1 [-option2 value2 [...]]]

filespecs:  space delimited list of file specs, * wildcard.  (*.html *.htm)

Options: Description
source: Path to files; e.g., c:\htmldocs in Microsoft Windows, /home/user1/htmldocs in Unix. Default is <userdir>
If the path is relative, it is assumed to be relative to the directory from which the HTMLConverter was launched.
backup: Path to the directory where you want backup files to be stored.  Default: <userdir>/<source>_bak
If the path is relative, it is assumed to be relative to the directory from which the HTMLConverter was launched.
subdirs: Sets whether files subdirectories should be processed or not.  Default:  false
template:

Name of template file to use.  Default:  Standard (IE & Navigator) for Windows & Solaris Only

Note: Use the default if you are unsure.

log: Path and filename for the log.  Default: <userdir>/convert.log
progress: Set to display standard out progress during conversion.  Default: true
simulate:

Set to preview a conversion without actually doing the conversion.

Note: Use this option if you are unsure about a conversion. You will be shown detail information about the conversion had it been done.