The Jakarta Site - About the Jakarta Web Site

DO NOT EDIT THE .html files in /www/jakarta.apache.org. Please follow the directions below for updating the website.

The Jakarta website is based on .xml files which are transformed into .html files using XSLT via an Ant task.

In order to make modifications to the Jakarta website, you need to first check out the jakarta-site2 module from SVN:

svn co https://svn.apache.org/repos/asf/jakarta/site/

Once you have the site checked out locally, cd into your jakarta-site2 directory and execute:

ant

This will build the documentation into the docs/ directory. The output will show you which files got re-generated. If you would like to make modifications to the website documents, you simply need to edit the files in the xdocs/ directory.

The files in xdocs/stylesheets are the global files for the site. If you make a modification to site.xml, it will affect the navigation for the website, style.xsl is the template that controls the look and feel for the overall website. Once you have built your documentation and confirmed that your changes are ok, you can check your .xml and your .html files back into SVN.

Then in the /www/jakarta.apache.org/ directory you should:

svn update index.html site

The jakarta-site tags

The Jakarta-Site module supports a set of XML/XHTML tags which it will render specially. Here is an example XML document:

<?xml version="1.0" encoding="ISO-8859-1"?> <document> <properties> <author email="nospam.AT.foo.DOT.com">Jon S. Stevens</author> <author email="mrsmith.AT.foo.DOT.com">Mr. Smith</author> <title></title> </properties> <meta name="keyword" content="jakarta, java"/> <body> <section name="Section 1"> <p> This is section 1. </p> <table> <tr> <td>This is a table</td> </tr> </table> <ul> <li>This is an unordered list.</li> </ul> </section> <section name="Section 2"> <p> This is section 2. </p> <ol> <li>This is an ordered list.</li> </ol> </section> <section name="Section 3"> <p> This is section 3. </p> <source> Anything within this tag is rendered as a "box" with blue lines and <pre></pre> tags around it. </source> <subsection name="Subsection of Section 3"> <p> This is the subsection 3. </p> </subsection> </section> </body> </document>

Explaining things:

It is possible to have one or more <author> tags.
It is possible to have one or more <section> tags.
Within the <section> tag, it is possible to have one or more <p> tags. Any free form text should go between the <p> tags and can contain more XHTML markup.
Other markup within a <section> does not need to be enclosed within <p> tags, although, it doesn't hurt anything to do so.
<subsection> tags are only embedded within <section> tags and provide extra indentation for a subsection. They follow the same rules that a <section> tag follows.
<table> tags do not need to have any sort of style information because they are rendered specially according to the site.vsl file.
<ol> and <ul> tags can be embedded as is.
<meta> tags are placed as children of the <document> and are passed through unchanged to the html document.
<source> tags are special. <source> tags are only embedded within <section> and <subsection> tags. If you are embedding other XML/XHTML markup within the source tags, then you need to place a CDATA section within the source section. Example: <source><![CDATA[ content here <a href="">foo</a>]]></source>. Note: in the example, we have a <pre> tag in the <source> tag and it is not within a CDATA. The reason for this is that it really is within a CDATA within the XML source file, but is not in the example above because one cannot embed a CDATA within a CDATA.

The output of the example XML file above is shown here. View source in your browser to see the generated HTML markup.

2011/12/21 - Jakarta has been retired.

For more information, please explore the Attic.