Download

The Java2HTML Tool

Contents

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

Introduction

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

Java2HTML output has been tested with Microsoft Internet Explorer 4, 5, 6 and Netscape Navigator 4, running on NT and Solaris.

For discussions regarding Java2HTML please subscribe to to our mailing list by emailing:- java2html.discussion-subscribe@vaegar.force9.co.uk 

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

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 (1.3Beta onwards)

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.
  

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.3 Demos. If you experience any strange problems whilst browsing these links, please email a description of the problem to bugs@java2html.com

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

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

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

  j2h -js C:\jdk1.3.1\demo\jfc\SwingSet2 -d examples\SwingSet_demo -jd C:\jdk1.3.1\docs\api http://java.sun.com/products/jdk/1.3/docs/api -n SwingSet_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

Please send requests for enhancements to ideas@java2html.com If I use your ideas I will give you a credit in this document.

• Ant Task coming soon.
  
  
• 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.
  
  
• Possibly publish the source code with an appropriate license.
  
  
• HTML driven Search Facility.
  
  
• Allow an option to specify a file which would contain a list of directories and/or files to be included in the Java2HTML process. This would allow users to be exact about what they want processed. Thanks for David Karr for that.
  
  
• Tony O'Hagan suggested providing a -link option so that JavaDoc can be linked directly from a URL.

Support

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

Change History

interface A {
    class B {};  // <-- ';' is problematic
}

class Foo {
  SomeObject thing = something;; // <-- Extra semi-colon
}

License Agreement

You should carefully read the following terms and conditions before using this software package. Your use of this software package indicates your acceptance of this license agreement. This is a legal agreement (this "Agreement") between you (either an individual or an entity) and the proprietor of this software. This Agreement is part of the software package.

1. GRANT OF LICENSE. The proprietor hereby grants you a personal, non-exclusive, non-transferable license to use one copy of this Software. This grant of license gives the right to use the software on your computer. You may not decompile, disassemble, or reverse engineer this software, and you may not create derivative works of the this software. You may modify, translate or adapt the generated HTML code. You are not granted any right, title, or interest in the the software except the right to use it in accordance with this Agreement.

2. REDISTRIBUTION Redistribution of the software ZIP file is allowed by shareware and freeware sites or CDROM media and similar without the permission of the proprietor. Redistribution for commercial purposes or reselling is not allowed.

3. WARRANTY. This software and the accompanying files are provided "AS IS," without a warranty of any kind.

4. COPYRIGHT. Copyright is owned by Polygon Enterprises and is protected by United Kingdom copyright law and international treaty provisions.

5. TERMINATION The license will terminate immediately without notice from the proprietor if you fail to comply with any provision of this license. Upon termination, you must destroy all copies of the software and its components on any and all forms of media.

6. LIMITATION OF LIABILITY IN NO EVENT WILL THE PROPRIETOR OR ITS SUPPLIERS BE LIABLE FOR ANY LOST REVENUE, PROFIT, OR FOR DIRECT, SPECIAL, INDIRECT, CONSEQUENTIAL, INCIDENTAL OR PUNITIVE DAMAGES HOW EVER CAUSED AND REGARDLESS OF THEORY OF LIABILITY, ARISING OUT OF THE USE OF OR INABILITY TO USE THE SOFTWARE, EVEN IF THE PROPRIETOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GOVERNING LAW This agreement is made under, shall be governed by and construed in accordance with, the laws of the United Kingdom.

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, thanks for the encouragement.
  
  
• The lads at MetaMata, especially Siram Sankar for his help on JavaCC and the Java Grammar.
  
  
• 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 (myself), This Web Site maintainer.
  

Enquiries and General Comments

Please send any enquires or general comments to jason.shattu@java2html.com

last updated: February 23 2003