HTMLMacro for Java TM
JAX* tag set

Implementation Version: private-20120911-2059

Overview

JAX-* tagset defines a documentation template suitable for release notes of software products, such as JAXB, JAX-WS, etc. This document that you are seeing right now is generated by using this tag set.

To use template, you need to set the following properties on the docgen task invocation.
Property name Description Required?
javaNetProjectName If a project has the java.net project, the name of the java.net project. E.g., "jaxb" No
SPEC_VERSION If a project has the related JCP spec, the version of it. E.g., "2.0" No
IMPL_VERSION If a project has an implementation version to be listed in the doucment. E.g., "2.0.1" No, but you really should have one
IMPL_VERSION_SUFFIX If a project has a suffix to add to the implementation version to be listed in the doucment. E.g., "fcs" No

How to use it?

First, copy tags/wts and tags/jax to somewhere in your project. Perhaps docs/tags/... Also copy docgen.jar in your project. Then expand your build script.

How do I write docs?

JAX-* tagset overrides the <head> and <body> tags to inject necessary templates, so your source HTML should look like:

<html>
<head caption="JAX* tag set">
  <link rel="stylesheet" type="text/css" href="style/default.css"/>
</head>
<body>
  <p>
    Lorem ipsum dolor sit amet, ...

The caption attribute of the head tag specifies the title of the document. The HTML <title> tag is generated by the templte based on this value. The banner and the navigation bar are also generated at the very top of the body.

The nested stylesheet is a part of the template and is necessary to properly render navigation bars and other page elements. These stylehseet related resources should be copied from tags/wts/style.

See the source HTML of this document for more details.

Navigation Bar

This tag set generates the navigation bar at the top, as you see. For this purpose, you need to write an XML file called toc.xml to describe the HTML structure. See the example and hopefully the structure should be faily obvious.