krysalis-menu/forrestdocs/src/documentation/content/xdocs/samples ascii-art.xml,NONE,1.1 cocoon-pyramid.aart,NONE,1.1 document-v13.xml,NONE,1.1 faq.xml,NONE,1.1 ihtml-sample.ihtml,NONE,1.1 index.xml,NONE,1.1 linking.xml,NONE,1.1 openoffice-writer.sxw,NONE,1.1 sample.xml,NONE,1.1 sdocbook.xml,NONE,1.1 static.xml,NONE,1.1 wiki-sample.cwiki,NONE,1.1
Glen Stampoultzis <[email protected]> Wed, 24 Nov 2004 23:11:31 +0000
| Newsgroups | gmane.comp.krysalis.metamorphosis.cvs |
|---|---|
| Message-ID | <[email protected]> |
Update of /cvsroot/metamorphosis/krysalis-menu/forrestdocs/src/documentation/content/xdocs/samples
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv17026/forrestdocs/src/documentation/content/xdocs/samples
Added Files:
ascii-art.xml cocoon-pyramid.aart document-v13.xml faq.xml
ihtml-sample.ihtml index.xml linking.xml openoffice-writer.sxw
sample.xml sdocbook.xml static.xml wiki-sample.cwiki
Log Message:
Initial commit
--- NEW FILE: index.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>Samples</title>
</header>
<body>
<section>
<title>If something goes wrong..</title>
<p>Patches are welcome: <a href="http://forrest.apache.org/faq.html">Forrest FAQ</a></p>
</section>
</body>
</document>
--- NEW FILE: faq.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE faqs PUBLIC "-//APACHE//DTD FAQ V2.0//EN" "http://forrest.apache.org/dtd/faq-v20.dtd">
<faqs>
<title>Frequently Asked Questions</title>
<faqsection id="docs">
<title>Documentation</title>
<faq id="forrest">
<question>
How can I help write documentation?
</question>
<answer>
<p>
This project uses <a href="ext:forrest">Apache Forrest</a> to
generate documentation from XML. Please download a copy of Forrest,
which can be used to <a
href="ext:forrest/validation">validate</a>, <a
href="ext:forrest/webapp">develop</a> and render a project site.
</p>
</answer>
</faq>
<!-- More faqs or parts here -->
</faqsection>
<!-- More faqs or parts here -->
</faqs>
--- NEW FILE: ascii-art.xml ---
<?xml version="1.0"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>Ascii Art sample</title>
</header>
<body>
<section>
<title>Sample Ascii Art</title>
<p>To create a <code>.png</code> image like the one below with ASCII art, just save
the text file with the <code>.aart</code> extension and then link from any page
as an image (<code><image src="asci-art-file.png"/></code>).</p>
<p><img src="cocoon-pyramid.png" alt="cocoon pyramid of management-(logic-content-style)"/></p>
<p>Here is the source file that has created the above image.</p>
<source>
+-------------------+
| Management |
+-+-------+-------+-+
| | |
| | |
+-------+ +----+----+ +-------+
| logic +--+ content +--+ style |
+-------+ +---------+ +-------+
</source>
<p>An ascii art pad recognized following ascii characters:</p>
<ul>
<li> '-' horizontal SVG line</li>
<li>'|' vertical SVG line</li>
<li> '+' corner</li>
<li> \ oblique line</li>
<li> String starting with letter, digit, or '_' is converted to a SVG text.</li>
</ul>
</section>
</body>
<footer>
<legal>Copyright 2002-2004 The Apache Software Foundation</legal>
</footer>
</document>
--- NEW FILE: ihtml-sample.ihtml ---
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<!--
Copyright 2002-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<html>
<head>
<title>Interpreted HTML (ihtml) demonstration page</title>
</head>
<body>
<h1><a name="intro" />Interpreted HTML (ihtml) demonstration page</h1>
<p>This HTML document is used as the source for this page, and translated
to the intermediate Apache Forrest xdocs document structure. The sitemap then
does the normal aggregation with the navigation content and application of
the skin.
</p>
<p>
Note that this source file has the .ihtml filename extension. All requests to
the sitemap for *.html are served by looking for matching *.ihtml source,
or by the
<a href="http://forrest.apache.org/faq.html#link_raw">"raw content"</a>
method, or by the normal processing of structured xml xdocs format, or by
other specialised xml processing.
</p>
<p>
The ihtml is being interpreted by Forrest and transformed to the
intermediate Apache xdocs document structure. That stylesheet cannot deal
with every possibility in unstructured html, so it tries to guess how to
build <section> elements and such.
It needs <h1> (<h2> etc.) headings in the source ihtml
(and the page must start with a h1 element). Patches are welcome to enhance
that transformer.
</p>
<p>All linked-to pages are also available, for example
<a href="../test2.html">this one</a>.</p>
<p>
You can still take advantage of Forrest's
<a href="http://forrest.apache.org/docs/linking.html">"<b>site:<b>"
method of linking</a>, for example:
<a href="site:index"><a href="site:index"></a>
</p>
<hr>
<p><b>Note:</b> XHTML can also be used, but it is just treated as interpreted
html. Future versions of Forrest will take much more advantage of XHTML.
</p>
<hr>
<h1><a name="examples" />Some example uses of ihtml</h1>
<p>
There are situations when the Apache Forrest xdocs DTD is not sufficient.
This interpreted html enables such extra capabilities.
</p>
<h2><a name="js" />Embedded applets and Javascript</h2>
<p>
See the
<a href="javascript:alert('Opened with Javascript via the body of the source html.')">Javascript alert pop-up</a>
</p>
<h2><a name="forms" />HTML forms for user interaction</h2>
<p>
Search the Forrest website via Google:
<!-- Search Google -->
<form target="_blank" action="http://www.google.com/search" method="get">
<input value="forrest.apache.org" name="as_sitesearch" type="hidden">
<input type=hidden name=ie value=UTF-8>
<input type=hidden name=oe value=UTF-8>
<a href="http://www.google.com/">
<img src="http://www.google.com/logos/Logo_40wht.gif"
border="0" alt="Google Search" align="middle" width="150" height="55"></a>
<input type="text" name="as_q" size="25" maxlength="255" value="ihtml">
<input type="submit" name="btnG" value="Google Search">
</form>
<!-- Search Google -->
</p>
<p>
See a demonstration of "ihtml" and "html forms" with our
<a href="http://forrest.apache.org/mirrors.cgi">Forrest download mirror</a>
facility and the
<a href="http://forrest.apache.org/howto/howto-asf-mirror.html">explanation</a> howto document.
</p>
<h2><a name="invalid" />Invalid HTML</h2>
<p>
This paragraph has a missing closing tag for the <p> element.
<h2><a name="blink" />Other non-standard html-type abilities</h2>
<p>
Use other HTML <blink>delights and tricks</blink>.
</p>
</body>
</html>
--- NEW FILE: sdocbook.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE article PUBLIC "-//OASIS//DTD Simplified DocBook XML V1.0//EN"
"http://www.oasis-open.org/docbook/xml/simple/1.0/sdocbook.dtd">
<article>
<title>Simplified DocBook example</title>
<subtitle>Sample Page subtitle</subtitle>
<titleabbrev>Title abbrev</titleabbrev>
<articleinfo>
<author>
<authorblurb>
<title>Author blurb Title</title>
<para>Author blurb paragraph</para>
</authorblurb>
<firstname>John</firstname>
<othername>Q</othername>
<surname>Public</surname>
</author>
<date>01-August-2003</date>
</articleinfo>
<abstract>
<title>Abstract title</title>
<para>Abstract paragraph</para>
</abstract>
<epigraph>
<attribution>Epigraph Attribution</attribution>
<literallayout>Literal layout</literallayout>
<para>Epigraph paragraph</para>
</epigraph>
<example>
<title>Example title</title>
<para>Example paragraph</para>
</example>
<figure>
<title>Figure title</title>
<literallayout>Literal layout</literallayout>
</figure>
<figure>
<title>Figure Image</title>
<mediaobject>
<imageobject>
<imagedata fileref="../images/project-logo.gif" />
</imageobject>
</mediaobject>
</figure>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Informal Table head entry</entry>
<entry>head entry 2</entry>
</row>
</thead>
<tfoot>
<row>
<entry>Table foot entry</entry>
<entry>foot entry 2</entry>
</row>
</tfoot>
<tbody>
<row>
<entry>1</entry>
<entry>2</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<itemizedlist>
<listitem>
<para>list item</para>
</listitem>
</itemizedlist>
<note>
<para>Note</para>
</note>
<orderedlist>
<listitem>
<para>Ordered list item</para>
</listitem>
</orderedlist>
<para>Article paragraph</para>
<programlisting>Program listing</programlisting>
<sidebar>
<para>Sidebar</para>
</sidebar>
<variablelist>
<varlistentry>
<term>Term</term>
<listitem>
<para>Definition</para>
</listitem>
</varlistentry>
</variablelist>
<table>
<title>Table</title>
<tgroup cols="2">
<colspec align="center" />
<thead>
<row>
<entry align="center">Head entry</entry>
<entry align="center">Head entry</entry>
</row>
</thead>
<tbody>
<row>
<entry>1</entry>
<entry>2</entry>
</row>
<row>
<entry>3</entry>
<entry>4</entry>
</row>
</tbody>
</tgroup>
</table>
<section>
<title>Section title</title>
<para>Section paragraph</para>
</section>
<appendix>
<title>Appendix title</title>
<para>Appendix paragraph</para>
</appendix>
<bibliography>
<bibliomixed>Bibliography</bibliomixed>
</bibliography>
</article>
--- NEW FILE: linking.xml ---
<?xml version="1.0" encoding="UTF-8"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://apache.org/forrest/dtd/document-v20.dtd">
<document>
<header>
<title>Demonstration of linking</title>
</header>
<body>
<section id="overview">
<title>Overview</title>
<p>Forrest has many powerful techniques for linking between documents
and for managing the site navigation. This document demonstrates those
techniques.
The document "<a href="ext:linking">Menus and Linking</a>"
has the full details.
</p>
</section>
<section id="uri-space">
<title>Building and maintaining consistent URI space</title>
<p>
When Forrest builds your site, it starts from the front page. Like
a robot, it traverses all of the links that it finds in the documents
and builds the corresponding pages. Any new links are further traversed.
</p>
<p>
Sometimes those links lead to documents that are generated directly
from xml source files, sometimes they are generated from other source
via an intermediate xml format. Other times the links lead to raw
un-processed content.
</p>
<p>
The site navigation configuration file "<code>site.xml</code>" provides
a way to manage this URI space. In the future, when documents are
re-arranged and renamed, the site.xml configuration will enable this
smoothly.
</p>
</section>
<section id="resource-space">
<title>Mapping the local resource space to the final URI space</title>
<p>
For the generated files, the top-level of the
URI space corresponds to the "<code>content/xdocs/</code>" directory,
i.e. the location of the "<code>site.xml</code>" configuration file.
</p>
<p>
For the raw un-processed content, the top-level of the URI space
corresponds to the "<code>content/</code>" directory.
</p>
<p>
A diagram will help.
</p>
<source><![CDATA[
The resource space ==============> The final URI space
------------------ -------------------
Generated content ...
content/xdocs/index.xml index.html
content/xdocs/samples/index.xml samples/index.html
content/xdocs/samples/faq.xml samples/faq.html
Raw un-processed content ...
content/hello.pdf hello.pdf
content/test1.html test1.html
content/samples/test3.html samples/test3.html
content/samples/subdir/test4.html samples/subdir/test4.html
]]></source>
<p>Now for some examples ...</p>
</section>
<section id="generated">
<title>Basic link to internal generated pages</title>
<p>
When this type of link is encountered, Forrest will look for a
corresponding xml file, relative to this document (i.e. in
<code>content/xdocs/samples/</code>).
</p>
<p>A generated document in the current directory, which corresponds to
<code>content/xdocs/samples/sample.html</code> ...
</p>
<source><![CDATA[<a href="sample.html">]]><a href="sample.html">sample.html</a><![CDATA[</a>]]></source>
<p>In a sub-directory, which corresponds to
<code>content/xdocs/samples/subdir/index.html</code> ...
</p>
<source><![CDATA[<a href="subdir/index.html">]]><a href="subdir/index.html">subdir/index.html</a><![CDATA[</a>]]></source>
</section>
<section id="raw">
<title>Basic link to raw un-processed content</title>
<p>
Raw content files are not intended for any processing, they are just
linked to (e.g. plain html, pre-prepared PDFs, zip archives).
The "<code>content/</code>" directory corresponds to the
top-level of the URI space.
</p>
<p>A raw document in the current directory, which corresponds to
<code>content/samples/test3.html</code> ...
</p>
<source><![CDATA[<a href="test3.html">]]><a href="test3.html">test3.html</a><![CDATA[</a>]]></source>
<p>A raw document in a sub-directory, which corresponds to
<code>content/samples/subdir/test4.html</code> ...
</p>
<source><![CDATA[<a href="subdir/test4.html">]]><a href="subdir/test4.html">subdir/test4.html</a><![CDATA[</a>]]></source>
<p>A raw document at the next level up, which corresponds to
<code>content/test1.html</code> ...
</p>
<source><![CDATA[<a href="../test1.html">]]><a href="../test1.html">../test1.html</a><![CDATA[</a>]]></source>
<p>A raw document at the next level up, which corresponds to
<code>content/hello.pdf</code> ...
</p>
<source><![CDATA[<a href="../hello.pdf">]]><a href="../hello.pdf">../hello.pdf</a><![CDATA[</a>]]></source>
</section>
<section id="url">
<title>Full URL to external documents</title>
<p>A full URL ...</p>
<source><![CDATA[<a href="http://forrest.apache.org/">]]><a href="http://forrest.apache.org/">http://forrest.apache.org/</a><![CDATA[</a>]]></source>
<p>A full URL with a fragment identifier ...</p>
<source><![CDATA[<a href="http://forrest.apache.org/faq.html#link_raw">]]><a href="http://forrest.apache.org/faq.html#link_raw">http://forrest.apache.org/faq.html#link_raw</a><![CDATA[</a>]]></source>
<p>
Note that Forrest does not traverse external links to look for
other links.
</p>
</section>
<section id="site">
<title>Using site.xml to manage the links</title>
<p>As you will have discovered, using pathnames with ../../ etc. will
get very nasty. Real problems occur when you use a smart text editor
that tries to manage the links for you. For example, it will have
trouble linking to the raw content files which are not yet in their
final location.
</p>
<p>
Links and filenames are bound to change and re-arrange. It is
essential to only change those links in one central place, not in every
document.
</p>
<p>
The "<code>site.xml</code>" configuration file to the rescue. It maps
symbolic names to actual resources.
</p>
<section id="site-simple">
<title>Basic link to internal generated pages</title>
<p>This single entry ...</p>
<source><![CDATA[<index label="Index" href="index.html"/>]]></source>
<p>
enables a simple link to a generated document, which corresponds to
<code>content/xdocs/index.xml</code> ...
</p>
<source><![CDATA[<a href="site:index">]]><a href="site:index">site:index</a><![CDATA[</a>]]></source>
</section>
<section id="site-compound">
<title>Group some items</title>
<p>This compound entry ...</p>
<source><![CDATA[
<samples label="Samples" href="samples/" tab="samples">
<faq label="FAQ" href="faq.html"/>
...
</samples>
]]></source>
<p>
enables a link to a generated document, which corresponds to
<code>content/xdocs/samples/index.xml</code> ...
</p>
<source><![CDATA[<a href="site:samples">]]><a href="site:samples">site:samples</a><![CDATA[</a>]]></source>
<p>
and a link to a generated document, which corresponds to
<code>content/xdocs/samples/faq.xml</code> ...
</p>
<source>
<![CDATA[<a href="site:faq">]]><a href="site:faq">site:faq</a><![CDATA[</a>]]>
which can also be a complete reference
<![CDATA[<a href="site:samples/faq">]]><a href="site:samples/faq">site:samples/faq</a><![CDATA[</a>]]>
</source>
</section>
<section id="site-fragment">
<title>Fragment identifiers</title>
<p>This compound entry ...</p>
<source><![CDATA[
<samples label="Samples" href="samples/" tab="samples">
<sample label="Apache document" href="sample.html">
<top href="#top"/>
<section href="#section"/>
</sample>
...
</samples>
]]></source>
<p>
enables a link to a fragment identifier within the
<code>samples/sample.html</code> document ...
</p>
<source><![CDATA[<a href="site:samples/sample/section">]]><a href="site:samples/sample/section">site:samples/sample/section</a><![CDATA[</a>]]></source>
</section>
<section id="site-raw">
<title>Define items for raw content</title>
<p>This entry ...</p>
<source><![CDATA[<hello_print href="hello.pdf"/>]]></source>
<p>
enables a link to a raw document, which corresponds to
<code>content/hello.pdf</code> ...
</p>
<source><![CDATA[<a href="site:hello_print">]]><a href="site:hello_print">site:hello_print</a><![CDATA[</a>]]></source>
<p>This entry ...</p>
<source><![CDATA[<test3 href="samples/test3.html"/>]]></source>
<p>
enables a link to a raw document, which corresponds to
<code>content/samples/test3.html</code> ...
</p>
<source><![CDATA[<a href="site:test3">]]><a href="site:test3">site:test3</a><![CDATA[</a>]]></source>
</section>
<section id="site-ext">
<title>External links</title>
<p>This compound entry ...</p>
<source><![CDATA[
<external-refs>
<forrest href="http://forrest.apache.org/">
<linking href="docs/linking.html"/>
<webapp href="docs/your-project.html#webapp"/>
</forrest>
</external-refs>
]]></source>
<p>
enables a link to an external URL ...
</p>
<source><![CDATA[<a href="ext:forrest">]]><a href="ext:forrest">ext:forrest</a><![CDATA[</a>]]></source>
<p>
and a link to another external URL ...
</p>
<source>
<![CDATA[<a href="ext:linking">]]><a href="ext:linking">ext:linking</a><![CDATA[</a>]]>
which can also be a complete reference
<![CDATA[<a href="ext:forrest/linking">]]><a href="ext:forrest/linking">ext:forrest/linking</a><![CDATA[</a>]]>
</source>
<p>
and a link to another external URL with a fragment identifier ...
</p>
<source>
<![CDATA[<a href="ext:webapp">]]><a href="ext:webapp">ext:webapp</a><![CDATA[</a>]]>
which can also be a complete reference
<![CDATA[<a href="ext:forrest/webapp">]]><a href="ext:forrest/webapp">ext:forrest/webapp</a><![CDATA[</a>]]>
</source>
</section>
</section>
</body>
</document>
--- NEW FILE: sample.xml ---
<?xml version="1.0"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>The Apache Forrest xdocs document-v2.0 DTD</title>
<notice>The content of this document doesn't make any sense at all.</notice>
<abstract>This is a demonstration document using all possible elements in
the current Apache Forrest xdocs <code>document-v20.dtd</code>
</abstract>
</header>
<body>
<note>
This is a demonstration document using all possible elements in the
current Apache Forrest xdocs <code>document-v20.dtd</code>
(See the <a href="#changes">DTD changes</a> section at the bottom.)
</note>
<section id="sample">
<title>Sample Content</title>
<p><strong>Hint:</strong> See the xml source to see how the various
elements are used and see the
<!-- FOR-321 workaround
<a href="ext:dtd-docs">DTD reference documentation</a>.
-->
<a href="http://forrest.apache.org/docs/dtd-docs.html">DTD reference documentation</a>.
</p>
<section id="block-inline">
<title>Block and inline elements</title>
<p>This is a simple paragraph. Most documents contain a fair amount of
paragraphs. Paragraphs are called <code><p></code>.</p>
<p xml:space="preserve"
>With the <code><p xml:space="preserve"></code> attribute, you can declare
that whitespace should be preserved, without implying it is in any other
way special.</p>
<p>
This next paragraph has a class attribute of 'quote'. CSS can
be used to present this <code><p class='quote'></code> in
a different style than the other paragraphs. The handling of
this quoted paragraph is defined in the <extra-css>
element in the skinconf.xml.
</p>
<p class="quote">
Anyway, like I was sayin', shrimp is the fruit of the sea. You can
barbecue it, boil it, broil it, bake it, sautee it. Dey's uh,
shrimp-kabobs, shrimp creole, shrimp gumbo. Pan fried, deep fried,
stir-fried. There's pineapple shrimp, lemon shrimp, coconut shrimp,
pepper shrimp, shrimp soup, shrimp stew, shrimp salad, shrimp and
potatoes, shrimp burger, shrimp sandwich. That- that's about it.
</p>
<p>A number of in-line elements are available in the DTD, we will show them
inside an unordered list (<code><ul></code>):</p>
<ul>
<li>Here is a simple list item (<code><li></code>).</li>
<li>Have you seen the use of the <code><code></code> element in the
previous item?</li>
<li>Also, we have <code><sub></code> and <code><sup></code>
elements to show content <sup>above</sup> or <sub>below</sub> the text
baseline.</li>
<li>There is a facility to <em>emphasize</em> certain words using the
<code><em></code> <strong><code><strong></code></strong>
elements.</li>
<li>We can use
<icon height="22" width="26" src="../images/icon.png" alt="feather"/>
<code><icon></code>s too.</li>
<li>Another possibility is the <code><img></code> element:
<img src="../images/icon.png" alt="another feather" height="22" width="26"/>,
which offers the ability to refer to an image map.</li>
<li>We have elements for hyperlinking:
<dl>
<dt><code><a href="faq.html"></code></dt>
<dd>Use this to
<a href="faq.html" title="Example of a document via link">link</a>
to another document. As per normal, this will open the new document
in the same browser window.</dd>
<dt><code><a href="#section"></code></dt>
<dd>Use this to
<a href="#section" title="Example of a document via local anchor">link</a>
to the named anchor in the current document.
</dd>
<dt><code><a href="faq.html#forrest"></code></dt>
<dd>Use this to
<a href="faq.html#forrest" title="Example of a document via link and anchor">link</a>
to another document and go to the named anchor. This will open
the new document in the same browser window.
</dd>
<dt>Targetted window control with jump and fork.</dt>
<dd>See demonstration
<a href="#link-class">using class attribute on links</a>.
</dd>
</dl></li>
<li>Oh, by the way, a definition list <code><dl></code> was used inside
the previous list item. We could put another
<ul>
<li>unordered list</li>
<li>inside the list item</li>
</ul>
<table>
<caption>A sample nested table</caption>
<tr><td>Or even tables.. </td><td>
<table><tr><td>inside tables..</td></tr></table>
</td></tr>
<tr><td>or inside lists, but I believe this liberty gets quickly quite
hairy as you see.</td></tr>
</table>
</li>
</ul>
<p>So far for the in-line elements, let's look at some paragraph-level
elements.</p>
<fixme author="SN">The <code><fixme></code> element is used for stuff
which still needs work. Mind the <code>author</code> attribute!</fixme>
<note>Use the <code><note></code> element to draw attention to something, e.g. ...The <code><code></code> element is used when the author can't
express himself clearly using normal sentences ;-)</note>
<warning>Sleep deprivation can be the result of being involved in an open
source project. (a.k.a. the <code><warning></code> element).
</warning>
<note label="Important">If you want your own labels for notes and
warnings, specify them using the <code>label</code> attribute.
</note>
<p>Apart from unordered lists, we have ordered lists too, of course.</p>
<ol>
<li>Item 1</li>
<li>Item 2</li>
<li>This should be 3 if my math is still OK.</li>
</ol>
</section>
<section id="presentations">
<title>Various presentation formats</title>
<p>This sample document, written in document-v20 XML can be presented
via Forrest in a number of different formats. The links in the
following list show this document in each of the currently available
formats.</p>
<p>Each of the formats can be made available as a link near the top of
the page. Actual placement of those links depends on the skin
currently in use. Those links are enabled in the skinconf.xml via the
<disable-XXX-link> elements in the skinconf.xml</p>
<table>
<tr>
<th>Presentation Format</th>
<th>Description</th>
<th>skinconf.xml Element</th>
</tr>
<tr>
<td><a href="sample.html">HTML</a></td>
<td>This document in HTML format. </td>
<td>Always generated by default. Cannot be turned off.</td>
</tr>
<tr>
<td><a href="sample.xml">XML</a></td>
<td>This document in its raw XML format.</td>
<td><disable-xml-link>. By default, set to true, meaning
that this link will not be shown.</td>
</tr>
<tr>
<td><a href="sample.pdf">PDF</a></td>
<td>This document as Adobe PDF</td>
<td><disable-pdf-link>. By default, set to false, meaning
that this link will be shown.</td>
</tr>
<tr>
<td>Text</td>
<td>This document as straight text.</td>
<td><disable-txt-link>. By default, set to true, meaning
that this link will not be shown. NOT YET IMPLEMENTED.</td>
</tr>
<tr>
<td><a href="sample.pod">POD</a></td>
<td>This document as Perl POD (Plain Old Documentation). Text with
minimal formatting directives. If on a *nix system with perl
installed, see "man perlpod".</td>
<td><disable-pod-link>. By default, set to true, meaning
that this link will not be shown.</td>
</tr>
</table>
</section>
<section id="section">
<title>Using sections</title>
<p>You can use sections to put some structure in your document. For some
strange historical reason, the section title is an attribute of the
<code><section></code> element.</p>
</section>
<section id="sub-section">
<title>Sections, the sequel</title>
<p>Just some second section.</p>
<section id="sub-sub-section">
<title>Section 2.1</title>
<p>Which contains a subsection (2.1).</p>
</section>
</section>
<section id="source">
<title>Showing preformatted source code</title>
<p>Enough about these sections. Let's have a look at more interesting
elements, <code><source></code> for instance:</p>
<source>
// This example is from the book _Java in a Nutshell_ by David Flanagan.
// Written by David Flanagan. Copyright (c) 1996 O'Reilly & Associates.
// You may study, use, modify, and distribute this example for any purpose.
// This example is provided WITHOUT WARRANTY either expressed or implied.
import java.applet.*; // Don't forget these import statements!
import java.awt.*;
public class FirstApplet extends Applet {
// This method displays the applet.
// The Graphics class is how you do all drawing in Java.
public void paint(Graphics g) {
g.drawString("Hello World", 25, 50);
}
}</source>
<p>CDATA sections are used within
<code><source></code> elements so that you can write pointy
brackets without needing to escape them with messy
<code>&lt;</code> entities ...
</p>
<source><![CDATA[
<pointy>
easy
</pointy>
]]></source>
<p>Please take care to still use a sensible line-length within your
source elements.</p>
</section>
<section id="table">
<title>Using tables</title>
<p>And now for a table:</p>
<table>
<caption>Table caption</caption>
<tr>
<th>heading cell 1</th>
<th>heading cell 2</th>
<th>heading cell 3</th>
</tr>
<tr>
<td>data cell</td>
<td colspan="2">this data cell spans two columns</td>
</tr>
<tr>
<td>
Tables can be nested:
</td>
<td>
<table>
<tr>
<th>column 1</th>
<th>column 2</th>
</tr>
<tr>
<td>cell A</td>
<td>cell B</td>
</tr>
</table>
</td>
<td>
<ul><li>and can include most other elements</li><li>such as lists</li></ul>
</td>
</tr>
</table>
</section>
<anchor id="second-figure-anchor"/>
<section id="figure">
<title>Using figures</title>
<p>And a <code><figure></code> to end all of this.
Note that this can also be implemented with an
<code><img></code> element.
</p>
<figure src="../images/project.png" alt="The fine Forrest logo" width="220" height="65"/>
</section>
<section id="link-class">
<title>Using class attribute on links</title>
<p>The document-v13 had elements <fork> and <jump>. In
document-v20, those elements no longer exist but the functionality can
be duplicated by using the @class attribute.
Even though the opening of separate windows should be under the
control of the user, these techniques can still be employed.</p>
<table>
<tr>
<th><p>Document V1.3</p></th>
<th><p>Document V2.0</p></th>
</tr>
<tr>
<td><p><fork href="faq.html"></p></td>
<td><a class="fork" href="faq.html"><a class="fork"
href="faq.html"></a></td>
</tr>
<tr>
<td><p><jump href="faq.html"></p></td>
<td><p><a class="jump" href="faq.html"><a class="jump"
href="faq.html"></a></p></td>
</tr>
</table>
</section>
</section>
<section id="changes">
<title>DTD changes</title>
<p>See the generated
<!-- FOR-321 workaround
<a href="ext:dtd-docs">DTD reference documentation</a>.
-->
<a href="http://forrest.apache.org/docs/dtd-docs.html">DTD reference documentation</a>.
</p>
<section id="changes-20">
<title>Changes between document-v13 and document-v20</title>
<ul>
<li>Renamed <strong><link></strong>
to <strong><a></strong>
</li>
<li>Removed <strong><fork></strong>
and <strong><jump></strong> in favour of the
<strong><a></strong> element. See demonstration
<a href="#link-class">using class attribute on links</a>.
</li>
</ul>
</section>
<section id="changes-13">
<title>Changes between document-v12 and document-v13</title>
<p>
All v1.2 docs will work fine as v1.3 DTD. The main change is the
addition of a @class attribute to every element, which enables the
"extra-css" section in the skinconf to be put to good use.
</p>
</section>
<section id="changes-12">
<title>Changes between document-v11 and document-v12</title>
<p>
doc-v12 enhances doc-v11 by relaxing various restrictions that were
found to be unnecessary.
</p>
<ul>
<li>
Links ((link|jump|fork) and inline elements (br|img|icon|acronym) are
allowed inside title.
</li>
<li>
Paragraphs (p|source|note|warning|fixme), table and figure|anchor are
allowed inside li.
</li>
<li>
Paragraphs (p|source|note|warning|fixme), lists (ol|ul|dl), table,
figure|anchor are allowed inside definition lists (dd) and tables (td
and dh).
</li>
<li>
Inline content
(strong|em|code|sub|sup|br|img|icon|acronym|link|jump|fork) is
allowed in strong and em.
</li>
</ul>
</section>
</section>
</body>
<footer>
<legal>This is a legal notice, so it is <strong>important</strong>.</legal>
</footer>
</document>
--- NEW FILE: static.xml ---
<?xml version="1.0"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
<document>
<header>
<title>Static content - including raw un-processed files and documents</title>
</header>
<body>
<section>
<title>Linking to static content</title>
<p>
You can include raw HTML, PDFs, plain-text, and other files.
They are included in the Forrest-built site, by placing them in the
<code>src/documentation/content/</code> directory and
they will be copied over automatically. You can link to them as
normal, e.g.
<strong><a href="test3.html"></strong><a href="test3.html">test3.html</a><strong></a></strong>
and
<strong><a href="../hello.pdf"></strong><a href="../hello.pdf">hello.pdf</a><strong></a></strong>
</p>
<p>
You can also have sub-directories such as
<code>src/documentation/content/samples/subdir/</code> which
reflects your main
<code>xdocs/</code> tree. The raw files will then end up
beside your documents.
</p>
<p>
More information in the
<a href="site:linking">Linking demonstration</a>.
</p>
</section>
</body>
</document>
--- NEW FILE: wiki-sample.cwiki ---
!!!Forrest's JSPWiki Support
Forrest now has partial support for documentation in JSPWiki format, thanks to the
[Chaperon parser|http://chaperon.sf.net/]. Wiki is a simple text format that can
be learned in minutes. This page provides an overview of the syntax that
Forrest supports, namely a subset of that used by the
[JSPWiki|http://www.jspwiki.org/Wiki.jsp?page=TextFormattingRules].
There is also a
[ChaperonTestPage|http://www.jspwiki.org/Wiki.jsp?page=ChaperonTestPage] which
might provide some more hints (view its source).
!!Important Note
It is very easy to create broken documents by using this loose wiki syntax.
Be sure to follow it explicitly.
!!Quick reference
{{{
---- = Make a horizontal ruler. Extra '-' is ignored.
\\ = force a line break, \\\=force line break and clear.
[link] = creates a hyperlink to an internal WikiPage called 'Link'.
[this is also a link] = creates a hyperlink to an internal WikiPage called
'ThisIsAlsoALink'.
[click here|link] = creates a hyperlink to an internal WikiPage called
'Link', but displays the text 'click here' to the
user instead of 'Link'.
[1] = Makes a reference to a footnote numbered 1.
[#1] = Marks the footnote number 1.
[[link] = creates text '[link]'
!heading = small heading with text 'heading'
!!heading = medium heading with text 'heading'
!!!heading = large heading with text 'heading'
Note: Be careful with the hierarchy of headings,
e.g. do not jump from level-3 to level-1.
''text'' = prints 'text' in italic.
__text__ = prints 'text' in bold.
{{text}} = prints 'text' in monospaced font.
* text = makes a bulleted list item with 'text'
# text = makes a numbered list item with 'text'
;term:ex = makes a definition for 'term' with the explanation 'ex'
}}}
!!Limitations
These are the known limitations of the Forrest JSPWiki capability ...
* The "definition" syntax (;term:ex) is not supported.
* [[link] = creates text '[link]' (is not working).
!!!Samples
The following sections are samples. View the source to see their use
(no, not the source of this HTML page, but the actual wiki source from which
this page was generated).
!!Writing text
You don't need to know anything about the Wiki text formatting rules to use
Wiki. Just write normal text, and then use an empty line to mark a paragraph.
It is just like writing an email. Add more fancy items as you become more
comfortable.
!!Hyperlinks
The link can also be a direct URL starting with http:, ftp:, mailto:, https:, or news:, in which case the link points to
an external entity. For example, to point at the java.sun.com home page, use
{{{[http://java.sun.com/]}}}
which becomes [http://java.sun.com/]
{{{[Java home page|http://java.sun.com/]}}}
which becomes [Java home page|http://java.sun.com/]
Almost any kind of characters can be used inside a {{{[WikiName]}}} as long
as they are letters or numbers.
!!Adding pictures
For security reasons uploading images is not permitted, but you can embed
any image in the wiki code by putting the image available somewhere on the web in one of the allowed formats, and then
just linking to it.
For example, this is an inlined PNG image: [../images/icon.png].
If you specify a link text e.g. {{{[this one here|http://example.com/example.png]}}} then it becomes
the ALT text for those who either can't or don't want to view images.
!!Bulleted lists
Use an asterisk (*) in the first column to make bulleted lists. Use more asterisks for deeper indentation. For example:
{{{
* One
* Two
* Three
** Three.One
}}}
creates
* One
* Two
* Three
** Three.One
!!Numbered lists
Just like with bulleted lists, but use a hash (#) instead of the asterisk. Like this:
{{{
# One
# Two
# Three
## Three.One
}}}
creates
# One
# Two
# Three
## Three.One
If you want to write the list item on multiple lines, just add one or more spaces on the next line and the line will be
automatically added to the
previous item. If this sounds complicated, edit this page for an example, below.
* This is a single-line item.
* This is actually a multi-line item.
We continue the second sentence on a line on a line of its own.
We might as well do a third line while we're at it...
Notice, however, as all these sentences get rendered inside a single item!
* The third line is again a single-line item.
!!Definition lists and comments
A simple way to make definition lists is to use the ';:' -construct:
;__Construct__:''Something you use to do something with''
Another nice use for the ';:' is that you can use it to comment shortly on other people's text, by having an empty
'term' in the definition, like this:
{{{
;:''Comment here.''
}}}
Which would be seen as
;:''Comment here.''
!!Text effects
You may use __bold__ text or ''italic'' text, by using two underscores (_) and two single quotes ('), respectively. If
you're on a Windows computer, make sure that you are using the correct quote sign, as there is one that looks the same,
but really isn't.
!!Preformatted text
If you want to add preformatted text (like code) just use three consecutive braces ({) to open a block, and three
consecutive braces (}) to close a block. See the Tables example below.
!!Tables
You can do simple tables by using using pipe symbols ('|'). Use double pipe
symbols to start the heading of a table, and single pipe symbols to then
write the rows of the table. End with a line that is not a table.
For example:
{{{
|| Heading 1 || Heading 2
| ''Italic Text'' | Plain Text
| [Forrest Home Page|http://forrest.apache.org/] | [http://forrest.apache.org/]
}}}
renders the following table. Note how you can use links also inside tables.
|| Heading 1 || Heading 2
| ''Italic Text'' | Plain Text
| [Forrest Home Page|http://forrest.apache.org/] | [http://forrest.apache.org/]
--- NEW FILE: openoffice-writer.sxw ---
(This appears to be a binary file; contents omitted.)
--- NEW FILE: cocoon-pyramid.aart ---
+-------------------+
| Management |
+-+-------+-------+-+
| | |
| | |
+-------+ +----+----+ +-------+
| logic +--+ content +--+ style |
+-------+ +---------+ +-------+
--- NEW FILE: document-v13.xml ---
<?xml version="1.0"?>
<!--
Copyright 2002-2004 The Apache Software Foundation
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.3//EN" "http://forrest.apache.org/dtd/document-v13.dtd">
<document>
<header>
<title>The Apache Forrest xdocs document-v1.3 DTD</title>
<notice>The content of this document doesn't make any sense at all.</notice>
<abstract>This is a demonstration document using all possible elements in
the current Apache Forrest xdocs <code>document-v13.dtd</code>
</abstract>
</header>
<body>
<note>
This is a demonstration document using all possible elements in the
current Apache Forrest xdocs <code>document-v13.dtd</code>
(See the <link href="#changes">DTD changes</link> section at the bottom.)
</note>
<section id="sample">
<title>Sample Content</title>
<p><strong>Hint:</strong> See the xml source to see how the various
elements are used and see the
<!-- FOR-321 workaround
<link href="ext:dtd-docs">DTD reference documentation</link>.
-->
<link href="http://forrest.apache.org/docs/dtd-docs.html">DTD reference documentation</link>.
</p>
<section id="block-inline">
<title>Block and inline elements</title>
<p>This is a simple paragraph. Most documents contain a fair amount of
paragraphs. Paragraphs are called <code><p></code>.</p>
<p xml:space="preserve"
>With the <code><p xml:space="preserve"></code> attribute, you can declare
that whitespace should be preserved, without implying it is in any other
way special.</p>
<p>
This next paragraph has a class attribute of 'quote'. CSS can
be used to present this <code><p class='quote'></code> in
a different style than the other paragraphs. The handling of
this quoted paragraph is defined in the <extra-css>
element in the skinconf.xml.
</p>
<p class="quote">
Anyway, like I was sayin', shrimp is the fruit of the sea. You can
barbecue it, boil it, broil it, bake it, sautee it. Dey's uh,
shrimp-kabobs, shrimp creole, shrimp gumbo. Pan fried, deep fried,
stir-fried. There's pineapple shrimp, lemon shrimp, coconut shrimp,
pepper shrimp, shrimp soup, shrimp stew, shrimp salad, shrimp and
potatoes, shrimp burger, shrimp sandwich. That- that's about it.
</p>
<p>A number of in-line elements are available in the DTD, we will show them
inside an unordered list (<code><ul></code>):</p>
<ul>
<li>Here is a simple list item (<code><li></code>).</li>
<li>Have you seen the use of the <code><code></code> element in the
previous item?</li>
<li>Also, we have <code><sub></code> and <code><sup></code>
elements to show content <sup>above</sup> or <sub>below</sub> the text
baseline.</li>
<li>There is a facility to <em>emphasize</em> certain words using the
<code><em></code> <strong><code><strong></code></strong>
elements.</li>
<li>We can use
<icon height="22" width="26" src="../images/icon.png" alt="feather"/>
<code><icon></code>s too.</li>
<li>Another possibility is the <code><img></code> element:
<img src="../images/icon.png" alt="another feather" height="22" width="26"/>,
which offers the ability to refer to an image map.</li>
<li>We have elements for hyperlinking:
<dl>
<dt><code><link href="faq.html"></code></dt>
<dd>Use this to
<link href="faq.html" title="Example of a document via link">link</link>
to another document. As per normal, this will open the new document
in the same browser window.</dd>
<dt><code><link href="#section"></code></dt>
<dd>Use this to
<link href="#section" title="Example of a document via local anchor">link</link>
to the named anchor in the current document.
</dd>
<dt><code><link href="faq.html#forrest"></code></dt>
<dd>Use this to
<link href="faq.html#forrest" title="Example of a document via link and anchor">link</link>
to another document and go to the named anchor. This will open
the new document in the same browser window.
</dd>
<dt><code><jump href="faq.html"></code></dt>
<dd>Use this to
<jump href="faq.html" title="Example of a document via jump">jump</jump>
to another document and optionally go to a named
<jump href="faq.html#forrest" title="Example of a document via jump to anchor">anchor</jump>
within that document. This will open the new document in the same
browser window. So what is the difference between link and jump?
The jump behaves differently, in that it will replace any frames
in the current window.
This is the equivalent of
<code><a ... target="_top"></code>
</dd>
<dt><code><fork href="faq.html"></code></dt>
<dd>Use this to
<fork href="faq.html" title="Example of a document via fork">fork</fork>
your webbrowser to another document. This will open the document
in a new, unnamed browser window.
This is the equivalent of
<code><a ... target="_blank"></code>
</dd>
</dl></li>
<li>Oh, by the way, a definition list <code><dl></code> was used inside
the previous list item. We could put another
<ul>
<li>unordered list</li>
<li>inside the list item</li>
</ul>
<table>
<caption>A sample nested table</caption>
<tr><td>Or even tables.. </td><td>
<table><tr><td>inside tables..</td></tr></table>
</td></tr>
<tr><td>or inside lists, but I believe this liberty gets quickly quite
hairy as you see.</td></tr>
</table>
</li>
</ul>
<p>So far for the in-line elements, let's look at some paragraph-level
elements.</p>
<fixme author="SN">The <code><fixme></code> element is used for stuff
which still needs work. Mind the <code>author</code> attribute!</fixme>
<note>Use the <code><note></code> element to draw attention to something, e.g. ...The <code><code></code> element is used when the author can't
express himself clearly using normal sentences ;-)</note>
<warning>Sleep deprivation can be the result of being involved in an open
source project. (a.k.a. the <code><warning></code> element).
</warning>
<note label="Important">If you want your own labels for notes and
warnings, specify them using the <code>label</code> attribute.
</note>
<p>Apart from unordered lists, we have ordered lists too, of course.</p>
<ol>
<li>Item 1</li>
<li>Item 2</li>
<li>This should be 3 if my math is still OK.</li>
</ol>
</section>
<section id="presentations">
<title>Various presentation formats</title>
<p>This sample document, written in document-v13 XML can be presented
via Forrest in a number of different formats. The links in the
following list show this document in each of the currently available
formats.</p>
<p>Each of the formats can be made available as a link near the top of
the page. Actual placement of those links depends on the skin
currently in use. Those links are enabled in the skinconf.xml via the
<disable-XXX-link> elements in the skinconf.xml</p>
<table>
<tr>
<th>Presentation Format</th>
<th>Description</th>
<th>skinconf.xml Element</th>
</tr>
<tr>
<td><link href="document-v13.html">HTML</link></td>
<td>This document in HTML format. </td>
<td>Always generated by default. Cannot be turned off.</td>
</tr>
<tr>
<td><link href="document-v13.xml">XML</link></td>
<td>This document in its raw XML format.</td>
<td><disable-xml-link>. By default, set to true, meaning
that this link will not be shown.</td>
</tr>
<tr>
<td><link href="document-v13.pdf">PDF</link></td>
<td>This document as Adobe PDF</td>
<td><disable-pdf-link>. By default, set to false, meaning
that this link will be shown.</td>
</tr>
<tr>
<td>Text</td>
<td>This document as straight text.</td>
<td><disable-txt-link>. By default, set to true, meaning
that this link will not be shown. NOT YET IMPLEMENTED.</td>
</tr>
<tr>
<td><link href="document-v13.pod">POD</link></td>
<td>This document as Perl POD (Plain Old Documentation). Text with
minimal formatting directives. If on a *nix system with perl
installed, see "man perlpod".</td>
<td><disable-pod-link>. By default, set to true, meaning
that this link will not be shown.</td>
</tr>
</table>
</section>
<section id="section">
<title>Using sections</title>
<p>You can use sections to put some structure in your document. For some
strange historical reason, the section title is an attribute of the
<code><section></code> element.</p>
</section>
<section id="sub-section">
<title>Sections, the sequel</title>
<p>Just some second section.</p>
<section id="sub-sub-section">
<title>Section 2.1</title>
<p>Which contains a subsection (2.1).</p>
</section>
</section>
<section id="source">
<title>Showing preformatted source code</title>
<p>Enough about these sections. Let's have a look at more interesting
elements, <code><source></code> for instance:</p>
<source>
// This example is from the book _Java in a Nutshell_ by David Flanagan.
// Written by David Flanagan. Copyright (c) 1996 O'Reilly & Associates.
// You may study, use, modify, and distribute this example for any purpose.
// This example is provided WITHOUT WARRANTY either expressed or implied.
import java.applet.*; // Don't forget these import statements!
import java.awt.*;
public class FirstApplet extends Applet {
// This method displays the applet.
// The Graphics class is how you do all drawing in Java.
public void paint(Graphics g) {
g.drawString("Hello World", 25, 50);
}
}</source>
<p>CDATA sections are used within
<code><source></code> elements so that you can write pointy
brackets without needing to escape them with messy
<code>&lt;</code> entities ...
</p>
<source><![CDATA[
<pointy>
easy
</pointy>
]]></source>
<p>Please take care to still use a sensible line-length within your
source elements.</p>
</section>
<section id="table">
<title>Using tables</title>
<p>And now for a table:</p>
<table>
<caption>Table caption</caption>
<tr>
<th>heading cell 1</th>
<th>heading cell 2</th>
<th>heading cell 3</th>
</tr>
<tr>
<td>data cell</td>
<td colspan="2">this data cell spans two columns</td>
</tr>
<tr>
<td>
Tables can be nested:
</td>
<td>
<table>
<tr>
<th>column 1</th>
<th>column 2</th>
</tr>
<tr>
<td>cell A</td>
<td>cell B</td>
</tr>
</table>
</td>
<td>
<ul><li>and can include most other elements</li><li>such as lists</li></ul>
</td>
</tr>
</table>
</section>
<anchor id="second-figure-anchor"/>
<section id="figure">
<title>Using figures</title>
<p>And a <code><figure></code> to end all of this.
Note that this can also be implemented with an
<code><img></code> element.
</p>
<figure src="../images/project.png" alt="The fine Forrest logo" width="220" height="65"/>
</section>
</section>
<section id="changes">
<title>DTD changes</title>
<p>See the generated
<!-- FOR-321 workaround
<link href="ext:dtd-docs">DTD reference documentation</link>.
-->
<link href="http://forrest.apache.org/docs/dtd-docs.html">DTD reference documentation</link>.
</p>
<section id="changes-13">
<title>Changes since document-v12</title>
<p>
All v1.2 docs will work fine as v1.3 DTD. The main change is the
addition of a @class attribute to every element, which enables the
"extra-css" section in the skinconf to be put to good use.
</p>
</section>
<section id="changes-12">
<title>Changes since document-v11</title>
<p>
doc-v12 enhances doc-v11 by relaxing various restrictions that were
found to be unnecessary.
</p>
<ul>
<li>
Links ((link|jump|fork) and inline elements (br|img|icon|acronym) are
allowed inside title.
</li>
<li>
Paragraphs (p|source|note|warning|fixme), table and figure|anchor are
allowed inside li.
</li>
<li>
Paragraphs (p|source|note|warning|fixme), lists (ol|ul|dl), table,
figure|anchor are allowed inside definition lists (dd) and tables (td
and dh).
</li>
<li>
Inline content
(strong|em|code|sub|sup|br|img|icon|acronym|link|jump|fork) is
allowed in strong and em.
</li>
</ul>
</section>
</section>
</body>
<footer>
<legal>This is a legal notice, so it is <strong>important</strong>.</legal>
</footer>
</document>
-------------------------------------------------------
SF email is sponsored by - The IT Product Guide
Read honest & candid reviews on hundreds of IT Products from real users.
Discover which products truly live up to the hype. Start reading now.
http://productguide.itmanagersjournal.com/