Download

The Java2HTML Tool

Contents

• Introduction
• Feature List
• Ant
• API
• Installing
• Requirements
• Options
• Example Usage:-
  • example1
  • example2
  • example3 TreeDemo.java.html#80
• Known Limitations and Future Extensions
• Support
• Change History
• License Agreement
• Credits
• Payment

Introduction

Java2HTML is a simple-to-use open-source tool which converts a bunch of Java Source Code into a colourized and browsable HTML representation. Go to download (Version 1.5) to get the tool now and/or see some example outputs. You must read the License Agreement before downloading this software.

Java2HTML is used by thousands of organizations to publish their source code on the internet, including  Sun Microsystems (Java Pet Store Demo 1.3.2) and Oracle ( LOBSample).

Java2HTML is open source hosted on SourceForge. Please get involed.

Feature List

Main features include:-

• Converts Java Code into Colourized HTML.
• Specify TAB Spacing.
• Specify style and colour options of all Java keywords types via standard cascading style sheets.
• JavaDoc Look'n Feel.
• Links Class references into source code for Class definitions.
• Links external Class references into 'JavaDoc' output.
• Optional Line Number feature.
• API

Ant

Java2HTML can be used from within Ant. View the Java2HTML Task documentation to see  how to do this.

API

Java2HTML can be used from within a Java program by using the Java2HTML API . This is only available in 1.3Beta onwards. 

View the Java2HTML API example to see how to use it.

Installing

Installing, assumes a certain level of technical knowledge.

• Unzip Java2HTML.zip into a temporary directory, using either WinZIP or the JDK jar tool (using "jar-xf Java2HTML.zip")
  
  
• Copy j2h.jar and one of the scripts to an appropriate area on your file system (e.g. C:\Tools\Java2HTML)
  
  
• Place the installation directory in your PATH.
  
  
• Edit the script to reflect the installation directory, or create an appropriate script if you are not using a DOS/Unix based operating system.
  
  
• Use of the scripts is optional, alternatively you can place the j2h.jar location in your class path, and type "java j2h" in its place or if you are using Java 2, you can type, "java -jar j2h.jar".
  
  
• Type, "j2h" to see if your installation has succeeded. You should see a usage description if it is has been successful.
  
• Alternatively you can now use Java2HTML from within Ant.
  

Requirements

• Java2HTML is written in Java and therefore needs a Java 1.1 or above compatible JVM.

Options

Type, " j2h" (if using the script) with no arguments to get a list of options.

In addition, Java2HTML will produce a "stylesheet.css", in the output directory which can be edited to change the colour or style scheme. (Warning: this will get overwritten if it already exists when you run j2h)

Example Usage

To review the output of running Java2HTML, view the index.html produced in the output directory with your favorite web browser.

I highly recommend the use of the -jd option. You will nearly always want to link into the standard Java libraries, so you will typically supply the following parameter, "-jd C:\JDK1.2\DOCS\API". Use the -jd option for each set of Java Doc you have access to.

Assuming you are using the Dos or Unix scripts "j2h.bat" or "j2h", type the examples for the specified effects.

• j2h -js C:\JDK1.2\src
  
  This will produce HTML representation under output in the current directory, for the JDK1.2 public source code.
  
• j2h -js \home\billgates\dev\cooljavaproject -jd \usr\jdk1.2\docs\api \www\docs\jdk1.2\docs\api
  
  This will produce HTML representation under output for the cooljavaproject source code with links into the standard Java Doc output for the JDK1.2 libraries.
  
  
• j2h -n COOL_PROJECT -t 8
  
  This will produce HTML representation under output for any Java Source files in the current directory, with tabs set to 8 spaces and a title of COOL_PROJECT.
  
  
• j2h -m 4 COOL_PROJECT
  
  This will produce HTML representation under output for any Java Source files in the current directory, with line numbers and a title of COOL_PROJECT.
  
  
• j2h -js C :\dev\project1 -js C: \dev\project2 -jd C :\jdk1.2\docs\api -jd C: \JavaXML\docs\api
  
  This will produce HTML representation under output for any Java Source files under C:\dev\project1 or C:\dev\project2 with Java Doc links to the standard JDK1.2 API and the SUN Microsystems XML libraries.
  
  

Example Outputs

Examples are from the SUN Microsystems JDK 1.4 Demos. If you experience any problems whilst browsing these links, please email a description of the problem to support@java2html.com

• Example Output 1
  
  Shows Source code for JDK 1.4 Java 2D Demo, created with the following command:-

  j2h -js C:\jdk1.4\demo\jfc\Java2D -d examples\Java2D_demo -jd C:\jdk1.4\docs\api http://java.sun.com/products/jdk/1.4/docs/api -n JAVA2D_DEMO
   

• Example Output 2 (with line numbers)
  
  Shows Source code for JDK 1.4 SwingSet2 Demo, created with the following command:-

  j2h -js C:\jdk1.4\demo\jfc\SwingSet2 -d examples\SwingSet2_demo -jd C:\jdk1.4\docs\api http://java.sun.com/products/jdk/1.4/docs/api -n SwingSet2_DEMO -m 4
  
  

• Example Output 3 - TreeDemo.java.html#80

Note: These examples use the web_reference feature of the -jd option, to point the web documentation at the Sun Java website. It would be more typical in general use to point the web_reference at your own local copy of the documentation.

Known Limitations and Future Extensions

If you have any ideas or requests please check out the SourceForge Java2HTML Open Discussion Forum.

• Support for Apples Macs and a java properties file to specify options.
  
  
• Method and Object Instance hyper links.
  
  
• Make use of a proper installer package.
  
  
• Hyper links of references within comments and strings
  
  
• Style sheet option, to prevent the overwriting of a customized stylesheet.
  
  
• Better handling of non-conformant java code.
  
  
• Extend Java2HTML to deal with other languages such as JSP, SQLJ, XML, SQL scripts, Perl and C/C++ and/or extend the architecture to allow third parties to implement additional language sources.
  
  
• HTML driven Search Facility.
  
  
• Tony O'Hagan suggested providing a -link option so that JavaDoc can be linked directly from a URL.

Support

Please report bugs to support@java2html.com, before emailing make sure that the bug is not listed in Known Limitations and Possible Extensions.

Change History

Changes

License Agreement

GNU General Public License Version 2

Credits

• Sun MicroSystems, thanks for making Java.
  
  
• Peter Van der Linden, Maintainer of the Java FAQ, and author of "Just Java 1.2" as well as many other good books.
  
  
• The people who put together JavaCC, especially Siram Sankar for his help.
  
  
• Guys on the JavaCC newsgroup, including David Williams for his Java 1.2 extensions.
  
  
• Thanks to the people at JARS for giving this tool (version 1.0.3) a, "rated JARS Top 25%", although it actually got 895 out of a 1000, losing marks on presentation :-(
  
  
• Jason Shattu, the original creator of Java2HTML.
  
  
• Other good things out there:-
  
  • Bruce Blackshaw's Java FTP Client 
  • David Shattu's Easy Password Manager
  • Getting Married? - Why not set up a  free wedding website at www.WeddingPath.com

Payment

Java2HTML is distributed as free software but should a user or company make significant use of it, they are encouraged to make a $50 contribution which gives them registration status and helps towards future development costs. Please click on the following link.