jon 01/07/09 11:14:35
Modified: docs/site jakarta-site2.html
xdocs/site jakarta-site2.xml
Added: docs/site jakarta-site-tags-example.html
jakarta-site-tags.html
xdocs/site jakarta-site-tags-example.xml
jakarta-site-tags.xml
Log:
added more documentation to the Jakarta Site...showing which tags can be
used and how. this was on request from craig because he complained that
this wasn't documented. well, now it is.
-jon
Revision Changes Path
1.26 +18 -0 jakarta-site2/docs/site/jakarta-site2.html
Index: jakarta-site2.html
===================================================================
RCS file: /home/cvs/jakarta-site2/docs/site/jakarta-site2.html,v
retrieving revision 1.25
retrieving revision 1.26
diff -u -r1.25 -r1.26
--- jakarta-site2.html 2001/05/17 06:32:54 1.25
+++ jakarta-site2.html 2001/07/09 18:14:28 1.26
@@ -592,6 +592,24 @@
<table border="0" cellspacing="0"
cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="Tag Documentation"><strong>Tag Documentation</strong></a>
+ </font>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ <tr><td>
+ <blockquote>
+ <p>
+ The list of tags which you can use within your XML/XHTML file are
+ documented on another <a href="./jakarta-site-tags.html">page</a>.
+</p>
+ </blockquote>
+ </p>
+ </td></tr>
+ <tr><td><br/></td></tr>
+ </table>
+ <table border="0" cellspacing="0"
cellpadding="2" width="100%">
+ <tr><td bgcolor="#525D76">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Modification of the Website"><strong>Modification of the
Website</strong></a>
</font>
</td></tr>
1.1 jakarta-site2/docs/site/jakarta-site-tags-example.html
Index: jakarta-site-tags-example.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
<!-- Content Stylesheet for Site -->
<!-- start the processing -->
<!-- ====================================================================== -->
<!-- Main Page Section -->
<!-- ====================================================================== -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<meta name="author" value="Jon
S. Stevens">
<meta name="email" value="[EMAIL PROTECTED]">
<meta name="author" value="Mr. Smith">
<meta name="email" value="[EMAIL PROTECTED]">
<title>The Jakarta Site - </title>
</head>
<body bgcolor="#ffffff" text="#000000" link="#525D76">
<table border="0" width="100%" cellspacing="0">
<!-- TOP IMAGE -->
<tr>
<td colspan="2">
<a href="http://jakarta.apache.org";><img
src="http://jakarta.apache.org/images/jakarta-logo.gif"; align="left" border="0"/></a>
</td>
</tr>
</table>
<table border="0" width="100%" cellspacing="4">
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr>
<!-- LEFT SIDE NAVIGATION -->
<td valign="top" nowrap="true">
<p><strong>Essentials</strong></p>
<ul>
<li> <a href="../index.html">Front Page</a>
</li>
<li> <a href="http://jakarta.apache.org/site/news.html";>News
& Status</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/mission.html";>Mission</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/guidelines.html";>Guidelines Notes</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/faqs.html";>FAQs</a>
</li>
</ul>
<p><strong>Download</strong></p>
<ul>
<li> <a
href="http://jakarta.apache.org/site/binindex.html";>Binaries</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/sourceindex.html";>Source Code</a>
</li>
</ul>
<p><strong>Get Involved</strong></p>
<ul>
<li> <a
href="http://jakarta.apache.org/site/getinvolved.html";>Overview</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/cvsindex.html";>CVS Repositories</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/mail.html";>Mailing Lists</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/library.html";>Reference Library</a>
</li>
<li> <a href="http://jakarta.apache.org/site/bugs.html";>Bug
Database</a>
</li>
</ul>
<p><strong>SubProjects</strong></p>
<ul>
<li> <a href="../alexandria/index.html">Alexandria</a>
</li>
<li> <a href="../ant/index.html">Ant</a>
</li>
<li> <a href="../avalon/index.html">Avalon</a>
</li>
<li> <a href="../commons/index.html">Commons</a>
</li>
<li> <a href="../ecs/index.html">ECS</a>
</li>
<li> <a href="../james/index.html">James</a>
</li>
<li> <a href="../jetspeed/index.html">Jetspeed</a>
</li>
<li> <a href="../jmeter/index.html">JMeter</a>
</li>
<li> <a href="../log4j/index.html">Log4J</a>
</li>
<li> <a href="../oro/index.html">ORO</a>
</li>
<li> <a href="../regexp/index.html">Regexp</a>
</li>
<li> <a href="../slide/index.html">Slide</a>
</li>
<li> <a href="../struts/index.html">Struts</a>
</li>
<li> <a href="../taglibs/index.html">Taglibs</a>
</li>
<li> <a href="../tomcat/index.html">Tomcat</a>
</li>
<li> <a href="../turbine/index.html">Turbine</a>
</li>
<li> <a href="../velocity/index.html">Velocity</a>
</li>
<li> <a href="../watchdog/index.html">Watchdog</a>
</li>
</ul>
<p><strong>Misc</strong></p>
<ul>
<li> <a
href="http://jakarta.apache.org/site/whoweare.html";>Who We Are</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/acknowledgements.html";>Acknowledgements</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/roles.html";>Management</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/jakarta-site2.html";>About This Site</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/contact.html";>Contact</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/legal.html";>Legal</a>
</li>
</ul>
</td>
<td align="left" valign="top">
<table
border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Section 1"><strong>Section 1</strong></a>
</font>
</td></tr>
<tr><td><br/></td></tr>
<tr><td>
<blockquote>
<p>
This is section 1.
</p>
<table>
<tr>
<td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top"
align="left">
<font color="#000000" size="-1" face="arial,helvetica,sanserif">
This is a table
</font>
</td>
</tr>
</table>
<ul>
<li>This is an unordered list.</li>
</ul>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
<table border="0" cellspacing="0"
cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Section 2"><strong>Section 2</strong></a>
</font>
</td></tr>
<tr><td><br/></td></tr>
<tr><td>
<blockquote>
<p>
This is section 2.
</p>
<ol>
<li>This is an ordered list.</li>
</ol>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
<table border="0" cellspacing="0"
cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Section 3"><strong>Section 3</strong></a>
</font>
</td></tr>
<tr><td><br/></td></tr>
<tr><td>
<blockquote>
<p>
This is section 3.
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
Anything within this tag is rendered as a "box"
with blue lines and <pre></pre> tags around it.
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
</table>
</div>
<table border="0"
cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#828DA6">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Subsection of Section 3"><strong>Subsection of Section
3</strong></a>
</font>
</td></tr>
<tr><td><br/></td></tr>
<tr><td>
<blockquote>
<p>
This is the subsection 3.
</p>
</blockquote>
</td></tr>
<tr><td><br/></td></tr>
</table>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
</td>
</tr>
<!-- FOOTER -->
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr><td colspan="2">
<div align="center"><font color="#525D76" size="-1"><em>
Copyright © 1999-2001, Apache Software Foundation
</em></font></div>
</td></tr>
</table>
</body>
</html>
<!-- end the processing -->
1.1 jakarta-site2/docs/site/jakarta-site-tags.html
Index: jakarta-site-tags.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd";>
<!-- Content Stylesheet for Site -->
<!-- start the processing -->
<!-- ====================================================================== -->
<!-- Main Page Section -->
<!-- ====================================================================== -->
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
<meta name="author" value="Jon
S. Stevens">
<meta name="email" value="[EMAIL PROTECTED]">
<title>The Jakarta Site - The jakarta-site tags</title>
</head>
<body bgcolor="#ffffff" text="#000000" link="#525D76">
<table border="0" width="100%" cellspacing="0">
<!-- TOP IMAGE -->
<tr>
<td colspan="2">
<a href="http://jakarta.apache.org";><img
src="http://jakarta.apache.org/images/jakarta-logo.gif"; align="left" border="0"/></a>
</td>
</tr>
</table>
<table border="0" width="100%" cellspacing="4">
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr>
<!-- LEFT SIDE NAVIGATION -->
<td valign="top" nowrap="true">
<p><strong>Essentials</strong></p>
<ul>
<li> <a href="../index.html">Front Page</a>
</li>
<li> <a href="http://jakarta.apache.org/site/news.html";>News
& Status</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/mission.html";>Mission</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/guidelines.html";>Guidelines Notes</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/faqs.html";>FAQs</a>
</li>
</ul>
<p><strong>Download</strong></p>
<ul>
<li> <a
href="http://jakarta.apache.org/site/binindex.html";>Binaries</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/sourceindex.html";>Source Code</a>
</li>
</ul>
<p><strong>Get Involved</strong></p>
<ul>
<li> <a
href="http://jakarta.apache.org/site/getinvolved.html";>Overview</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/cvsindex.html";>CVS Repositories</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/mail.html";>Mailing Lists</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/library.html";>Reference Library</a>
</li>
<li> <a href="http://jakarta.apache.org/site/bugs.html";>Bug
Database</a>
</li>
</ul>
<p><strong>SubProjects</strong></p>
<ul>
<li> <a href="../alexandria/index.html">Alexandria</a>
</li>
<li> <a href="../ant/index.html">Ant</a>
</li>
<li> <a href="../avalon/index.html">Avalon</a>
</li>
<li> <a href="../commons/index.html">Commons</a>
</li>
<li> <a href="../ecs/index.html">ECS</a>
</li>
<li> <a href="../james/index.html">James</a>
</li>
<li> <a href="../jetspeed/index.html">Jetspeed</a>
</li>
<li> <a href="../jmeter/index.html">JMeter</a>
</li>
<li> <a href="../log4j/index.html">Log4J</a>
</li>
<li> <a href="../oro/index.html">ORO</a>
</li>
<li> <a href="../regexp/index.html">Regexp</a>
</li>
<li> <a href="../slide/index.html">Slide</a>
</li>
<li> <a href="../struts/index.html">Struts</a>
</li>
<li> <a href="../taglibs/index.html">Taglibs</a>
</li>
<li> <a href="../tomcat/index.html">Tomcat</a>
</li>
<li> <a href="../turbine/index.html">Turbine</a>
</li>
<li> <a href="../velocity/index.html">Velocity</a>
</li>
<li> <a href="../watchdog/index.html">Watchdog</a>
</li>
</ul>
<p><strong>Misc</strong></p>
<ul>
<li> <a
href="http://jakarta.apache.org/site/whoweare.html";>Who We Are</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/acknowledgements.html";>Acknowledgements</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/roles.html";>Management</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/jakarta-site2.html";>About This Site</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/contact.html";>Contact</a>
</li>
<li> <a
href="http://jakarta.apache.org/site/legal.html";>Legal</a>
</li>
</ul>
</td>
<td align="left" valign="top">
<table
border="0" cellspacing="0" cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="The jakarta-site tags"><strong>The jakarta-site tags</strong></a>
</font>
</td></tr>
<tr><td><br/></td></tr>
<tr><td>
<blockquote>
<p>
The Jakarta-Site module supports a set of XML/XHTML tags which it will
render specially. These tags can be used to make your website
documentation render the way that you want it to as well as look better.
These tags are defined in the site.vsl file which is the stylesheet that
is used to transform the XML files into the HTML files. If you would
like to add more tags and support of those tags to the site.vsl file,
please feel free. This can be done by either posting patches to the file
to the general@jakarta mailing list or by committing them yourself.
</p>
<p>
Please note that the stylesheet is intentionally quite simple. The
reason is that we are not trying to create another Stylebook or Docbook
system, which are known to be overly complicated. We are simply trying
to create a simple markup language that allows authors to quickly
generate the website for the Jakarta Project and their own projects. You
are welcome to adopt our system for your own website.
</p>
<p>
Return to the <a href="./jakarta-site2.html">Jakarta-Site</a> documentation.
</p>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
<table border="0" cellspacing="0"
cellpadding="2" width="100%">
<tr><td bgcolor="#525D76">
<font color="#ffffff" face="arial,helvetica,sanserif">
<a name="Example XML Document"><strong>Example XML Document</strong></a>
</font>
</td></tr>
<tr><td><br/></td></tr>
<tr><td>
<blockquote>
<p>
Anakia XML files must be composed of a XML/XHTML syntax that is parsable
by a standard XML parser (such as Xerces or Crimson). There is currently
no DTD for Anakia, however if there is a parse error in the file, Anakia
will report the error and line number of the error according to what the
parser reported.
</p>
<p>
Here is an example XML document:
</p>
<div align="left">
<table cellspacing="4" cellpadding="0" border="0">
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#ffffff"><pre>
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Jon S. Stevens</author>
<author email="[EMAIL PROTECTED]">Mr. Smith</author>
<title></title>
</properties>
<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>
</pre></td>
<td bgcolor="#023264" width="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
<tr>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" height="1"><img src="/images/void.gif" width="1"
height="1" vspace="0" hspace="0" border="0"/></td>
<td bgcolor="#023264" width="1" height="1"><img src="/images/void.gif"
width="1" height="1" vspace="0" hspace="0" border="0"/></td>
</tr>
</table>
</div>
<p>
Explaining things:
</p>
<ol>
<li>
It is possible to have one or more <author> tags.
</li>
<li>
It is possible to have one or more <section> tags.
</li>
<li>
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.
</li>
<li>
Other markup within a <section> does not need to be enclosed
within <p> tags, although, it doesn't hurt anything to do so.
</li>
<li>
<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.
</li>
<li>
<table> tags do not need to have any sort of style information
because they are rendered specially according to the site.vsl file.
</li>
<li>
<ol> and <ul> tags can be embedded as is.
</li>
<li>
<source> tags are special. 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:<strong>
<source><![CDATA[ content here <a
href="">foo</a>]]></source></strong>. 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.
</li>
</ol>
<p>
The output of the example XML file above is shown <a
href="./jakarta-site-tags-example.html">here</a>. View source in your
browser to see the generated HTML markup.
</p>
</blockquote>
</p>
</td></tr>
<tr><td><br/></td></tr>
</table>
</td>
</tr>
<!-- FOOTER -->
<tr><td colspan="2">
<hr noshade="" size="1"/>
</td></tr>
<tr><td colspan="2">
<div align="center"><font color="#525D76" size="-1"><em>
Copyright © 1999-2001, Apache Software Foundation
</em></font></div>
</td></tr>
</table>
</body>
</html>
<!-- end the processing -->
1.10 +7 -0 jakarta-site2/xdocs/site/jakarta-site2.xml
Index: jakarta-site2.xml
===================================================================
RCS file: /home/cvs/jakarta-site2/xdocs/site/jakarta-site2.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- jakarta-site2.xml 2001/04/16 20:23:32 1.9
+++ jakarta-site2.xml 2001/07/09 18:14:33 1.10
@@ -308,6 +308,13 @@
</p>
</section>
+<section name="Tag Documentation">
+<p>
+ The list of tags which you can use within your XML/XHTML file are
+ documented on another <a href="./jakarta-site-tags.html">page</a>.
+</p>
+</section>
+
<section name="Modification of the Website">
<p>
People who have accounts on apache.org can check in their changes to the
1.1 jakarta-site2/xdocs/site/jakarta-site-tags-example.xml
Index: jakarta-site-tags-example.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Jon S. Stevens</author>
<author email="[EMAIL PROTECTED]">Mr. Smith</author>
<title></title>
</properties>
<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><![CDATA[
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>
1.1 jakarta-site2/xdocs/site/jakarta-site-tags.xml
Index: jakarta-site-tags.xml
===================================================================
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Jon S. Stevens</author>
<title>The jakarta-site tags</title>
</properties>
<body>
<section name="The jakarta-site tags">
<p>
The Jakarta-Site module supports a set of XML/XHTML tags which it will
render specially. These tags can be used to make your website
documentation render the way that you want it to as well as look better.
These tags are defined in the site.vsl file which is the stylesheet that
is used to transform the XML files into the HTML files. If you would
like to add more tags and support of those tags to the site.vsl file,
please feel free. This can be done by either posting patches to the file
to the general@jakarta mailing list or by committing them yourself.
</p>
<p>
Please note that the stylesheet is intentionally quite simple. The
reason is that we are not trying to create another Stylebook or Docbook
system, which are known to be overly complicated. We are simply trying
to create a simple markup language that allows authors to quickly
generate the website for the Jakarta Project and their own projects. You
are welcome to adopt our system for your own website.
</p>
<p>
Return to the <a href="./jakarta-site2.html">Jakarta-Site</a> documentation.
</p>
</section>
<section name="Example XML Document">
<p>
Anakia XML files must be composed of a XML/XHTML syntax that is parsable
by a standard XML parser (such as Xerces or Crimson). There is currently
no DTD for Anakia, however if there is a parse error in the file, Anakia
will report the error and line number of the error according to what the
parser reported.
</p>
<p>
Here is an example XML document:
</p>
<source><![CDATA[
<?xml version="1.0"?>
<document>
<properties>
<author email="[EMAIL PROTECTED]">Jon S. Stevens</author>
<author email="[EMAIL PROTECTED]">Mr. Smith</author>
<title></title>
</properties>
<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>
]]></source>
<p>
Explaining things:
</p>
<ol>
<li>
It is possible to have one or more <author> tags.
</li>
<li>
It is possible to have one or more <section> tags.
</li>
<li>
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.
</li>
<li>
Other markup within a <section> does not need to be enclosed
within <p> tags, although, it doesn't hurt anything to do so.
</li>
<li>
<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.
</li>
<li>
<table> tags do not need to have any sort of style information
because they are rendered specially according to the site.vsl file.
</li>
<li>
<ol> and <ul> tags can be embedded as is.
</li>
<li>
<source> tags are special. 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:<strong>
<source><![CDATA[ content here <a
href="">foo</a>]]></source></strong>. 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.
</li>
</ol>
<p>
The output of the example XML file above is shown <a
href="./jakarta-site-tags-example.html">here</a>. View source in your
browser to see the generated HTML markup.
</p>
</section>
</body>
</document>
![http://jakarta.apache.org/images/jakarta-logo.gif"](http://jakarta.apache.org/images/jakarta-logo.gif"){kind=link}
