blob: ab4938509a590c4fbe6a614d7930c8d2f6e57dc1 [file] [log] [blame]
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="Apache Forrest" name="Generator">
<meta name="Forrest-version" content="0.8-dev">
<meta name="Forrest-skin-name" content="pelt">
<title>The document-v1.1 DTD</title>
<link type="text/css" href="../skin/basic.css" rel="stylesheet">
<link media="screen" type="text/css" href="../skin/screen.css" rel="stylesheet">
<link media="print" type="text/css" href="../skin/print.css" rel="stylesheet">
<link type="text/css" href="../skin/profile.css" rel="stylesheet">
<script src="../skin/getBlank.js" language="javascript" type="text/javascript"></script><script src="../skin/getMenu.js" language="javascript" type="text/javascript"></script><script src="../skin/fontsize.js" language="javascript" type="text/javascript"></script>
<link rel="shortcut icon" href="../favicon.ico">
</head>
<body onload="init()">
<script type="text/javascript">ndeSetTextSize();</script>
<div id="top">
<!--+
|breadtrail
+-->
<div class="breadtrail">
<a href="http://www.apache.org/">apache</a> &gt; <a href="http://forrest.apache.org/">forrest</a><script src="../skin/breadcrumbs.js" language="JavaScript" type="text/javascript"></script>
</div>
<!--+
|header
+-->
<div class="header">
<!--+
|start group logo
+-->
<div class="grouplogo">
<a href="http://www.apache.org/"><img class="logoImage" alt="Apache" src="../images/apache-forrest.png" title="The Apache Software Foundation"></a>
</div>
<!--+
|end group logo
+-->
<!--+
|start Project Logo
+-->
<div class="projectlogo">
<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="../images/project-logo.gif" title="Apache Forrest"></a>
</div>
<!--+
|end Project Logo
+-->
<!--+
|start Search
+-->
<div class="searchbox">
<form action="http://www.google.com/search" method="get" class="roundtopsmall">
<input value="forrest.apache.org" name="sitesearch" type="hidden"><input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google">&nbsp;
<input name="Search" value="Search" type="submit">
</form>
</div>
<!--+
|end search
+-->
<!--+
|start Tabs
+-->
<ul id="tabs">
<li>
<a class="base-not-selected" href="../index.html">Welcome</a>
</li>
<li>
<a class="base-not-selected" href="../contrib.html">Project</a>
</li>
<li>
<a class="base-not-selected" href="../versions/index.html">Versioned Docs</a>
</li>
<li>
<a class="base-not-selected" href="../pluginDocs/index.html">Plugins</a>
</li>
<li>
<a class="base-not-selected" href="../tools/index.html">Tools</a>
</li>
</ul>
<!--+
|end Tabs
+-->
</div>
</div>
<div id="main">
<div id="publishedStrip">
<!--+
|start Subtabs
+-->
<div id="level2tabs"></div>
<!--+
|end Endtabs
+-->
<script type="text/javascript"><!--
document.write("Last Published: " + document.lastModified);
// --></script>
</div>
<!--+
|breadtrail
+-->
<div class="breadtrail">
&nbsp;
</div>
<!--+
|start Menu, mainarea
+-->
<!--+
|start Menu
+-->
<div id="menu">
<div onclick="SwitchMenu('menu_1.1', '../skin/')" id="menu_1.1Title" class="menutitle">0.80-dev</div>
<div id="menu_1.1" class="menuitemgroup">
<div class="menuitem">
<a href="../docs_0_80/index.html">Overview</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/faq.html">FAQs</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/changes.html">Changes</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/todo.html">Todo</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/your-project.html">Using Forrest</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/locationmap.html">Locationmap</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/validation.html">XML Validation</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/linking.html">Menus and Linking</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/searching.html">Searching</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/skins.html">Default Skins</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/skin-package.html">Skin Packages</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/views.html">Views development</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/forrest-contract.html">Our Contract</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/compliance.html">Standards Compliance</a>
</div>
<div onclick="SwitchMenu('menu_1.1.15', '../skin/')" id="menu_1.1.15Title" class="menutitle">How-To</div>
<div id="menu_1.1.15" class="menuitemgroup">
<div class="menuitem">
<a href="../docs_0_80/howto/index.html">Overview</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/howto-howto.html">Write a How-to</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/howto-dev.html">Be a developer</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/howto-asf-mirror.html">Download mirror</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/howto-pdf-tab.html">Create tab PDF</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/howto-editcss.html">Edit CSS (WYSIWYG)</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/howto-corner-images.html">CSS corner SVG</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/howto-forrest-from-maven.html">Maven Integration</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/howto-buildPlugin.html">Build a Plugin</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/howto-custom-html-source.html">Custom html source</a>
</div>
<div onclick="SwitchMenu('menu_1.1.15.11', '../skin/')" id="menu_1.1.15.11Title" class="menutitle">Multipage HowTo</div>
<div id="menu_1.1.15.11" class="menuitemgroup">
<div class="menuitem">
<a href="../docs_0_80/howto/multi/howto-multi.html">Introduction</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/multi/step1.html">Step 1</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/multi/step2.html">Step 2</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/multi/step3.html">Step 3</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.1.15.12', '../skin/')" id="menu_1.1.15.12Title" class="menutitle">Dispatcher</div>
<div id="menu_1.1.15.12" class="menuitemgroup">
<div class="menuitem">
<a href="../docs_0_80/howto/howto-structurer-install.html">Install</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/howto-structurer-dsl.html">forrest:view DSL</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/howto-structurer-contracts.html">Contract implementations</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.1.15.13', '../skin/')" id="menu_1.1.15.13Title" class="menutitle">Old Views (deprecated)</div>
<div id="menu_1.1.15.13" class="menuitemgroup">
<div class="menuitem">
<a href="../docs_0_80/howto/howto-view-install.html">Install views</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/howto-view-dsl.html">forrest:view DSL</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/howto-view-contracts.html">Contract implementations</a>
</div>
</div>
</div>
<div onclick="SwitchMenu('menu_1.1.16', '../skin/')" id="menu_1.1.16Title" class="menutitle">Advanced Topics</div>
<div id="menu_1.1.16" class="menuitemgroup">
<div class="menuitem">
<a href="../docs_0_80/build.html">Building Forrest</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/catalog.html">Using DTD Catalogs</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/sitemap-ref.html">Sitemap Reference</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/project-sitemap.html">Project sitemap</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/cap.html">Sourcetype Action</a>
</div>
</div>
<div class="menuitem">
<a href="../docs_0_80/upgrading_08.html">Upgrading to 0.8</a>
</div>
<div onclick="SwitchMenu('menu_1.1.18', '../skin/')" id="menu_1.1.18Title" class="menutitle">Reference docs</div>
<div id="menu_1.1.18" class="menuitemgroup">
<div onclick="SwitchMenu('menu_1.1.18.1', '../skin/')" id="menu_1.1.18.1Title" class="menutitle">DTD documentation</div>
<div id="menu_1.1.18.1" class="menuitemgroup">
<div class="menuitem">
<a href="../dtdx/dtd-docs.html">Overview</a>
</div>
<div class="menuitem">
<a href="../dtdx/document-v20.dtdx.html">document-v20</a>
</div>
<div class="menuitem">
<a href="../dtdx/howto-v20.dtdx.html">howto-v20</a>
</div>
<div class="menuitem">
<a href="../dtdx/faq-v20.dtdx.html">faq-v20</a>
</div>
<div class="menuitem">
<a href="../dtdx/document-v13.dtdx.html">document-v13</a>
</div>
<div class="menuitem">
<a href="../dtdx/howto-v13.dtdx.html">howto-v13</a>
</div>
<div class="menuitem">
<a href="../dtdx/faq-v13.dtdx.html">faq-v13</a>
</div>
</div>
<div onclick="SwitchMenu('menu_1.1.18.2', '../skin/')" id="menu_1.1.18.2Title" class="menutitle">Doc samples</div>
<div id="menu_1.1.18.2" class="menuitemgroup">
<div class="menuitem">
<a href="../dtdx/document-v13.html">document-v13</a>
</div>
<div class="menuitem">
<a href="../dtdx/document-v20.html">document-v20</a>
</div>
</div>
</div>
<div onclick="SwitchMenu('menu_1.1.19', '../skin/')" id="menu_1.1.19Title" class="menutitle">Older Docs</div>
<div id="menu_1.1.19" class="menuitemgroup">
<div class="menuitem">
<a href="../docs_0_80/primer.html">Forrest Primer</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/libre-intro.html">Libre</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/dreams.html">Dream list</a>
</div>
<div class="menuitem">
<a href="../docs_0_80/howto/cvs-ssh/howto-cvs-ssh.html">CVS over SSH</a>
</div>
</div>
</div>
<div id="credit"></div>
<div id="roundbottom">
<img style="display: none" class="corner" height="15" width="15" alt="" src="../skin/images/rc-b-l-15-1body-2menu-3menu.png"></div>
<!--+
|alternative credits
+-->
<div id="credit2">
<a href="http://apachecon.com/"><img border="0" title="ApacheCon US 2005" alt="ApacheCon US 2005 - logo" src="http://apache.org/images/ac2005us_blue_125x125.jpg" style="width: 125px;height: 125px;"></a>
</div>
</div>
<!--+
|end Menu
+-->
<!--+
|start content
+-->
<div id="content">
<div title="Portable Document Format" class="pdflink">
<a class="dida" href="document-v11.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br>
PDF</a>
</div>
<div class="trail">Font size:
&nbsp;<input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button">
&nbsp;<input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button">
&nbsp;<input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button">
</div>
<h1>The document-v1.1 DTD</h1>
<div class="abstract">A nonsense document using all possible elements in the current
document-v11.dtd.</div>
<div id="minitoc-area">
<ul class="minitoc">
<li>
<a href="#Using+sections">Using sections</a>
</li>
<li>
<a href="#Sections%2C+the+sequel">Sections, the sequel</a>
<ul class="minitoc">
<li>
<a href="#Section+2.1">Section 2.1</a>
</li>
</ul>
</li>
<li>
<a href="#Showing+preformatted+source+code">Showing preformatted source code</a>
</li>
<li>
<a href="#Using+tables">Using tables</a>
</li>
<li>
<a href="#Using+figures">Using figures</a>
</li>
</ul>
</div>
<div class="note">
<div class="label">Note</div>
<div class="content">document-v11 has been superceded by <a href="../docs_0_70/../dtdx/document-v12.html">document-v12</a>
</div>
</div>
<p>This is a simple paragraph. Most documents contain a fair amount of
paragraphs. Paragraphs are called <span class="codefrag">&lt;p&gt;</span>.</p>
<div class="pre">With the <span class="codefrag">&lt;p xml:space="preserve"&gt;</span> attribute, you can declare
that whitespace should be preserved, without implying it is in any other
way special.</div>
<p>A number of in-line elements are available in the DTD, we will show them
inside an unordered list (<span class="codefrag">&lt;ul&gt;</span>):</p>
<ul>
<li>Here is a simple list item (<span class="codefrag">&lt;li&gt;</span>).</li>
<li>Have you seen the use of the <span class="codefrag">&lt;code&gt;</span> element in the
previous item?</li>
<li>Also, we have <span class="codefrag">&lt;sub&gt;</span> and <span class="codefrag">&lt;sup&gt;</span>
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
<span class="codefrag">&lt;em&gt;</span> element.</li>
<li>We can use
<img class="icon" alt="feather" height="22" src="images/icon.png" width="26">
<span class="codefrag">&lt;icon&gt;</span>s, too.</li>
<li>Another possibility is the <span class="codefrag">&lt;img&gt;</span> element:
<img alt="another feather" height="22" src="images/icon.png" width="26">,
which offers the ability to refer to an image map.</li>
<li>We have elements for hyperlinking:
<dl>
<dt>
<span class="codefrag">&lt;link href="your-project.html"&gt;</span>
</dt>
<dd>Use this to
<a href="your-project.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>
<span class="codefrag">&lt;link href="#section"&gt;</span>
</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>
<span class="codefrag">&lt;link href="your-project.html#images"&gt;</span>
</dt>
<dd>Use this to
<a href="your-project.html#images" 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>
<span class="codefrag">&lt;jump href="your-project.html"&gt;</span>
</dt>
<dd>Use this to
<a target="_top" href="your-project.html">jump</a>
to another document and optionally go to a named
<a target="_top" href="your-project.html#images">anchor</a>
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
<span class="codefrag">&lt;a ... target="_top"&gt;</span>
</dd>
<dt>
<span class="codefrag">&lt;fork href="your-project.html"&gt;</span>
</dt>
<dd>Use this to
<a target="_blank" href="your-project.html">fork</a>
your webbrowser to another document. This will open the document
in a new, unnamed browser window.
This is the equivalent of
<span class="codefrag">&lt;a ... target="_blank"&gt;</span>
</dd>
</dl>
</li>
<li>Oh, by the way, a definition list <span class="codefrag">&lt;dl&gt;</span> was used inside
the previous list item. We could put another
<ul>
<li>unordered list</li>
<li>inside the list item</li>
</ul> too, but I believe this liberty gets quickly quite hairy as you
see.</li>
</ul>
<p>So far for the in-line elements, let's look at some paragraph-level
elements.</p>
<div class="fixme">
<div class="label">Fixme (SN)</div>
<div class="content">The <span class="codefrag">&lt;fixme&gt;</span> element is used for stuff
which still needs work. Mind the <span class="codefrag">author</span> attribute!</div>
</div>
<div class="note">
<div class="label">Note</div>
<div class="content">Use the <span class="codefrag">&lt;note&gt;</span> element to draw attention to something, e.g. ...The <span class="codefrag">&lt;code&gt;</span> element is used when the author can't
express himself clearly using normal sentences ;-)</div>
</div>
<div class="warning">
<div class="label">Warning</div>
<div class="content">Sleep deprivation can be the result of being involved in an open
source project. (a.k.a. the <span class="codefrag">&lt;warning&gt;</span> element).</div>
</div>
<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>
<a name="section" id="section"></a>
<a name="N100F7"></a><a name="Using+sections"></a>
<h2 class="underlined_10">Using sections</h2>
<div class="section">
<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
<span class="codefrag">&lt;section&gt;</span> element.</p>
</div>
<a name="N10104"></a><a name="Sections%2C+the+sequel"></a>
<h2 class="underlined_10">Sections, the sequel</h2>
<div class="section">
<p>Just some second section.</p>
<a name="N1010D"></a><a name="Section+2.1"></a>
<h3 class="underlined_5">Section 2.1</h3>
<p>Which contains a subsection (2.1).</p>
</div>
<a name="source" id="source"></a>
<a name="N1011B"></a><a name="Showing+preformatted+source+code"></a>
<h2 class="underlined_10">Showing preformatted source code</h2>
<div class="section">
<p>Enough about these sections. Let's have a look at more interesting
elements, <span class="codefrag">&lt;source&gt;</span> for instance:</p>
<pre class="code">// This example is from the book _Java in a Nutshell_ by David Flanagan.
// Written by David Flanagan. Copyright (c) 1996 O'Reilly &amp; 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);
}
}</pre>
<p>Please take care to still use a sensible line-length within your
source elements.</p>
</div>
<a name="table" id="table"></a>
<a name="N10132"></a><a name="Using+tables"></a>
<h2 class="underlined_10">Using tables</h2>
<div class="section">
<p>And now for a table:</p>
<table class="ForrestTable" cellspacing="1" cellpadding="4">
<caption>Table caption</caption>
<tr>
<th colspan="1" rowspan="1">heading cell</th>
<th colspan="1" rowspan="1">heading cell</th>
</tr>
<tr>
<td colspan="1" rowspan="1">data cell</td>
<td colspan="1" rowspan="1">data cell</td>
</tr>
</table>
<p>Not much of attributes with <span class="codefrag">&lt;table&gt;</span>, if you ask me.</p>
</div>
<a name="figure" id="figure"></a>
<a name="N10165"></a><a name="Using+figures"></a>
<h2 class="underlined_10">Using figures</h2>
<div class="section">
<p>And a figure to end all of this.</p>
<div id="" style="text-align: center;">
<img id="" class="figure" alt="The fine Forrest logo" src="images/project-logo.png" height="65" width="220"></div>
</div>
</div>
<!--+
|end content
+-->
<div class="clearboth">&nbsp;</div>
</div>
<div id="footer">
<!--+
|start bottomstrip
+-->
<div class="lastmodified">
<script type="text/javascript"><!--
document.write("Last Published: " + document.lastModified);
// --></script>
</div>
<div class="copyright">
Copyright &copy;
2002-2005 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
</div>
<!--+
|end bottomstrip
+-->
</div>
</body>
</html>