| <!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 Apache Forrest xdocs document-v2.0 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> > <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"> |
| <input name="Search" value="Search" type="submit"> |
| </form> |
| </div> |
| <!--+ |
| |end search |
| +--> |
| <!--+ |
| |start Tabs |
| +--> |
| <ul id="tabs"> |
| <li> |
| <a class="unselected" href="../index.html">Welcome</a> |
| </li> |
| <li> |
| <a class="unselected" href="../contrib.html">Developers</a> |
| </li> |
| <li class="current"> |
| <a class="selected" href="../versions/index.html">Versioned Docs</a> |
| </li> |
| <li> |
| <a class="unselected" href="../pluginDocs/index.html">Plugins</a> |
| </li> |
| <li> |
| <a class="unselected" href="../tools/index.html">Tools</a> |
| </li> |
| </ul> |
| <!--+ |
| |end Tabs |
| +--> |
| </div> |
| </div> |
| <div id="main"> |
| <div id="publishedStrip"> |
| <!--+ |
| |start Subtabs |
| +--> |
| <div id="level2tabs"> |
| <a class="unselected" href="../docs_0_70/index.html">0.70 (current)</a><a class="selected" href="../docs_0_80/index.html">0.80-dev (under development)</a><a class="unselected" href="../docs_0_60/index.html">0.60 (past)</a> |
| </div> |
| <!--+ |
| |end Endtabs |
| +--> |
| <script type="text/javascript"><!-- |
| document.write("Last Published: " + document.lastModified); |
| // --></script> |
| </div> |
| <!--+ |
| |breadtrail |
| +--> |
| <div class="breadtrail"> |
| |
| |
| </div> |
| <!--+ |
| |start Menu, mainarea |
| +--> |
| <!--+ |
| |start Menu |
| +--> |
| <div id="menu"> |
| <div onclick="SwitchMenu('menu_selected_1.1', '../skin/')" id="menu_selected_1.1Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">0.80-dev</div> |
| <div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;"> |
| <div class="menuitem"> |
| <a href="../docs_0_80/index.html">Overview</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs_0_80/your-project.html">Using Forrest</a> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.3', '../skin/')" id="menu_1.1.3Title" class="menutitle">How-To</div> |
| <div id="menu_1.1.3" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="../docs_0_80/howto/index.html">Overview</a> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.3.2', '../skin/')" id="menu_1.1.3.2Title" class="menutitle">Install Forrest</div> |
| <div id="menu_1.1.3.2" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="../docs_0_80/build.html" title="Build and install the current unreleased version">Building Forrest from Source</a> |
| </div> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs_0_80/upgrading_08.html">Upgrading to 0.8</a> |
| </div> |
| <div class="menuitem"> |
| <a href="">Use Forrest</a> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.3.5', '../skin/')" id="menu_1.1.3.5Title" class="menutitle">Customize Forrest</div> |
| <div id="menu_1.1.3.5" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="../docs_0_80/sitemap-explain.html">Sitemaps explained</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs_0_80/howto/howto-custom-html-source.html">Custom html source</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/howto/howto-editcss.html">Edit CSS (WYSIWYG)</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs_0_80/howto/howto-pdf-tab.html" title="Generate one pdf-document for all pages of a tab">Create tab PDF</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs_0_80/howto/howto-corner-images.html">CSS corner SVG</a> |
| </div> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.3.6', '../skin/')" id="menu_1.1.3.6Title" class="menutitle">Integrate Forrest with tools</div> |
| <div id="menu_1.1.3.6" class="menuitemgroup"> |
| <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/catalog.html">Using DTD Catalogs</a> |
| </div> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.3.7', '../skin/')" id="menu_1.1.3.7Title" class="menutitle">Extend Forrest</div> |
| <div id="menu_1.1.3.7" class="menuitemgroup"> |
| <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/skin-package.html">Package new Skins</a> |
| </div> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs_0_80/howto/howto-asf-mirror.html">Download mirror</a> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.3.9', '../skin/')" id="menu_1.1.3.9Title" class="menutitle">Adding Documentation</div> |
| <div id="menu_1.1.3.9" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="../howto-howto.html" title="Instructions for writing a new howto-document">Write a How-to</a> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.3.9.2', '../skin/')" id="menu_1.1.3.9.2Title" class="menutitle">Multipage HowTo</div> |
| <div id="menu_1.1.3.9.2" 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> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs_0_80/faq.html">FAQs</a> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.5', '../skin/')" id="menu_1.1.5Title" class="menutitle">Background</div> |
| <div id="menu_1.1.5" class="menuitemgroup"> |
| <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">Search Options in Forrest</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs_0_80/locationmap.html">Locationmap</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/skins.html" title="About default skins, their naming and features">Skins</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs_0_80/status-themes.html">Dispatcher versus Skins</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs_0_80/cap.html">Sourcetype Action</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs_0_80/validation.html">XML validation and entity resolution</a> |
| </div> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs_0_80/changes.html">Changes</a> |
| </div> |
| <div class="menuitem"> |
| <a href="../docs_0_80/glossary.html">Glossary</a> |
| </div> |
| <div onclick="SwitchMenu('menu_selected_1.1.8', '../skin/')" id="menu_selected_1.1.8Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Reference docs</div> |
| <div id="menu_selected_1.1.8" class="selectedmenuitemgroup" style="display: block;"> |
| <div onclick="SwitchMenu('menu_1.1.8.1', '../skin/')" id="menu_1.1.8.1Title" class="menutitle">DTD documentation</div> |
| <div id="menu_1.1.8.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_selected_1.1.8.2', '../skin/')" id="menu_selected_1.1.8.2Title" class="menutitle" style="background-image: url('../skin/images/chapter_open.gif');">Doc samples</div> |
| <div id="menu_selected_1.1.8.2" class="selectedmenuitemgroup" style="display: block;"> |
| <div class="menuitem"> |
| <a href="../dtdx/document-v13.html">document-v13</a> |
| </div> |
| <div class="menupage"> |
| <div class="menupagetitle">document-v20</div> |
| </div> |
| </div> |
| </div> |
| <div onclick="SwitchMenu('menu_1.1.9', '../skin/')" id="menu_1.1.9Title" class="menutitle">Older Docs</div> |
| <div id="menu_1.1.9" 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/2007/EU/"><img border="0" title="ApacheCon Europe 2007" alt="ApacheCon Europe 2007 - logo" src="http://apache.org/ads/ApacheCon/2007-europe-125x125.png" style="width: 125px;height: 125px;"></a><a href="http://people.apache.org/calendar.html#200711"><img border="0" title="ApacheCon US 2007" alt="ApacheCon US 2007 - logo" src="http://apache.org/ads/ApacheCon/2007-usa-125x125.png" 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-v20.pdf"><img alt="PDF -icon" src="../skin/images/pdfdoc.gif" class="skin"><br> |
| PDF</a> |
| </div> |
| <div class="trail">Font size: |
| <input value="Reset" class="resetfont" title="Reset text" onclick="ndeSetTextSize('reset'); return false;" type="button"> |
| <input value="-a" class="smallerfont" title="Shrink text" onclick="ndeSetTextSize('decr'); return false;" type="button"> |
| <input value="+a" class="biggerfont" title="Enlarge text" onclick="ndeSetTextSize('incr'); return false;" type="button"> |
| </div> |
| <h1>The Apache Forrest xdocs document-v2.0 DTD</h1> |
| <div class="abstract"> |
| This is a demonstration document using all possible elements in the |
| current Apache Forrest xdocs document-v20.dtd |
| </div> |
| <div id="minitoc-area"> |
| <ul class="minitoc"> |
| <li> |
| <a href="#sample">Sample Content</a> |
| <ul class="minitoc"> |
| <li> |
| <a href="#block-inline">Block and inline elements</a> |
| </li> |
| <li> |
| <a href="#presentations">Various presentation formats</a> |
| </li> |
| <li> |
| <a href="#section">Using sections</a> |
| </li> |
| <li> |
| <a href="#sub-section">Sections, the sequel</a> |
| <ul class="minitoc"> |
| <li> |
| <a href="#sub-sub-section">Section 2.1</a> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <a href="#source">Showing preformatted source code</a> |
| </li> |
| <li> |
| <a href="#table">Using tables</a> |
| </li> |
| <li> |
| <a href="#figure">Using figures</a> |
| </li> |
| <li> |
| <a href="#link-class">Using class attribute on links</a> |
| </li> |
| </ul> |
| </li> |
| <li> |
| <a href="#changes">DTD changes</a> |
| <ul class="minitoc"> |
| <li> |
| <a href="#changes-20">Changes between document-v13 and document-v20</a> |
| </li> |
| <li> |
| <a href="#changes-13">Changes between document-v12 and document-v13</a> |
| </li> |
| <li> |
| <a href="#changes-12">Changes between document-v11 and document-v12</a> |
| </li> |
| </ul> |
| </li> |
| </ul> |
| </div> |
| |
| <div class="note"> |
| <div class="label">Note</div> |
| <div class="content"> |
| This is a demonstration document using all possible elements in the |
| current Apache Forrest xdocs <span class="codefrag">document-v20.dtd</span> (See the |
| <a href="#changes">DTD changes</a> section at the bottom.) |
| </div> |
| </div> |
| |
| <a name="N10020"></a><a name="sample"></a> |
| <h2 class="underlined_10">Sample Content</h2> |
| <div class="section"> |
| <p> |
| |
| <strong>Hint:</strong> See the xml source to see how the various |
| elements are used and see the <a href="../docs_0_80/../dtdx/dtd-docs.html">DTD reference |
| documentation</a>. |
| </p> |
| <a name="N10030"></a><a name="block-inline"></a> |
| <h3 class="underlined_5">Block and inline elements</h3> |
| <p> |
| This is a simple paragraph. Most documents contain a fair amount of |
| paragraphs. Paragraphs are called <span class="codefrag"><p></span>. |
| </p> |
| <div class="pre"> |
| With the <span class="codefrag"><p xml:space="preserve"></span> attribute, you can declare |
| that whitespace should be preserved, without implying it is in any other |
| way special. |
| </div> |
| <p> |
| This next paragraph has a class attribute of 'quote'. CSS can be used |
| to present this <span class="codefrag"><p class='quote'></span> 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 (<span class="codefrag"><ul></span>): |
| </p> |
| <ul> |
| |
| <li>Here is a simple list item (<span class="codefrag"><li></span>).</li> |
| |
| <li>Have you seen the use of the <span class="codefrag"><code></span> element in the |
| previous item?</li> |
| |
| <li>Also, we have <span class="codefrag"><sub></span> and <span class="codefrag"><sup></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"><em></span><strong><span class="codefrag"><strong></span></strong> |
| elements.</li> |
| |
| <li>We can use |
| <img class="icon" alt="feather" height="22" src="images/icon.png" width="26"><span class="codefrag"><icon></span>s too.</li> |
| |
| <li>Another possibility is the <span class="codefrag"><img></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"><a href="../index.html"></span> |
| </dt> |
| |
| <dd>Use this to |
| <a href="../index.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"><a href="#section"></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"><a href="../index.html#status"></span> |
| </dt> |
| |
| <dd>Use this to |
| <a href="../index.html#status" 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 <span class="codefrag"><dl></span> was used inside |
| the previous list item. We could put another |
| <ul> |
| |
| <li>unordered list</li> |
| |
| <li>inside the list item</li> |
| |
| </ul> |
| |
| <table class="ForrestTable" cellspacing="1" cellpadding="4"> |
| |
| <caption>A sample nested table</caption> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1">Or even tables.. </td> |
| <td colspan="1" rowspan="1"> |
| |
| <table class="ForrestTable" cellspacing="1" cellpadding="4"> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1">inside tables..</td> |
| |
| </tr> |
| |
| </table> |
| |
| </td> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1">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> |
| <div class="fixme"> |
| <div class="label">Fixme (SN)</div> |
| <div class="content"> |
| The <span class="codefrag"><fixme></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"><note></span> element to draw attention to |
| something, e.g. ...The <span class="codefrag"><code></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"><warning></span> element). |
| </div> |
| </div> |
| <div class="note"> |
| <div class="label">Important</div> |
| <div class="content"> |
| If you want your own labels for notes and warnings, specify them using |
| the <span class="codefrag">label</span> attribute. |
| </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="N1012E"></a><a name="presentations"></a> |
| <h3 class="underlined_5">Various presentation formats</h3> |
| <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 class="ForrestTable" cellspacing="1" cellpadding="4"> |
| |
| <tr> |
| |
| <th colspan="1" rowspan="1">Presentation Format</th> |
| <th colspan="1" rowspan="1">Description</th> |
| <th colspan="1" rowspan="1">skinconf.xml Element</th> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1"><a href="document-v20.html">HTML</a> |
| </td> |
| <td colspan="1" rowspan="1">This document in HTML format. </td> |
| <td colspan="1" rowspan="1">Always generated by default. Cannot be turned off.</td> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1"><a href="document-v20.xml">XML</a> |
| </td> |
| <td colspan="1" rowspan="1">This document in its raw XML format.</td> |
| <td colspan="1" rowspan="1"><disable-xml-link>. By default, set to true, meaning |
| that this link will not be shown.</td> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1"><a href="document-v20.pdf">PDF</a> |
| </td> |
| <td colspan="1" rowspan="1">This document as Adobe PDF</td> |
| <td colspan="1" rowspan="1"><disable-pdf-link>. By default, set to false, meaning |
| that this link will be shown.</td> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1"><a href="document-v20.txt">Text</a> |
| </td> |
| <td colspan="1" rowspan="1"> |
| |
| <p> |
| This document as straight text. |
| </p> |
| |
| <p> |
| For additional information see the Forrest text-output plugin. |
| </p> |
| |
| </td> |
| <td colspan="1" rowspan="1"><disable-txt-link>. By default, set to true, meaning |
| that this link will not be shown.</td> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1"><a href="document-v20.pod">POD</a> |
| </td> |
| <td colspan="1" rowspan="1"> |
| |
| <p> |
| This document as Perl POD (Plain Old Documentation). Text with |
| minimal formatting directives. If on a *nix system with perl |
| installed, see "man perlpod". |
| </p> |
| |
| <p> |
| For additional information see the Forrest pod-output plugin. |
| </p> |
| |
| </td> |
| <td colspan="1" rowspan="1"><disable-pod-link>. By default, set to true, meaning |
| that this link will not be shown.</td> |
| |
| </tr> |
| |
| </table> |
| <a name="N101C5"></a><a name="section"></a> |
| <h3 class="underlined_5">Using sections</h3> |
| <p> |
| You can use sections to put some structure in your document. |
| </p> |
| <a name="N101CF"></a><a name="sub-section"></a> |
| <h3 class="underlined_5">Sections, the sequel</h3> |
| <p> |
| Just some second section. |
| </p> |
| <a name="N101D8"></a><a name="sub-sub-section"></a> |
| <h4>Section 2.1</h4> |
| <p> |
| Which contains a subsection (2.1). |
| </p> |
| <a name="N101E3"></a><a name="source"></a> |
| <h3 class="underlined_5">Showing preformatted source code</h3> |
| <p> |
| Enough about these sections. Let's have a look at more interesting |
| elements, <span class="codefrag"><source></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 & 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> |
| CDATA sections are used within <span class="codefrag"><source></span> elements so |
| that you can write pointy brackets without needing to escape them with |
| messy <span class="codefrag">&lt;</span> entities ... |
| </p> |
| <pre class="code"> |
| |
| <pointy> |
| easy |
| </pointy> |
| |
| </pre> |
| <p> |
| Please take care to still use a sensible line-length within your |
| source elements. |
| </p> |
| <a name="N10204"></a><a name="table"></a> |
| <h3 class="underlined_5">Using tables</h3> |
| <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 1</th> |
| <th colspan="1" rowspan="1">heading cell 2</th> |
| <th colspan="1" rowspan="1">heading cell 3</th> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1">data cell</td> |
| <td colspan="2" rowspan="1">this data cell spans two columns</td> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1"> |
| Tables can be nested: |
| </td> |
| <td colspan="1" rowspan="1"> |
| |
| <table class="ForrestTable" cellspacing="1" cellpadding="4"> |
| |
| <tr> |
| |
| <th colspan="1" rowspan="1">column 1</th> |
| <th colspan="1" rowspan="1">column 2</th> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1">cell A</td> |
| <td colspan="1" rowspan="1">cell B</td> |
| |
| </tr> |
| |
| </table> |
| |
| </td> |
| <td colspan="1" rowspan="1"> |
| |
| <ul> |
| |
| <li>and can include most other elements</li> |
| |
| <li>such as lists</li> |
| |
| </ul> |
| |
| </td> |
| |
| </tr> |
| |
| </table> |
| <a name="second-figure-anchor" id="second-figure-anchor"></a><a name="N1026E"></a><a name="figure"></a> |
| <h3 class="underlined_5">Using figures</h3> |
| <p> |
| And a <span class="codefrag"><figure></span> to end all of this. Note that this |
| can also be implemented with an <span class="codefrag"><img></span> element. |
| </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> |
| <a name="N10284"></a><a name="link-class"></a> |
| <h3 class="underlined_5">Using class attribute on links</h3> |
| <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 class="ForrestTable" cellspacing="1" cellpadding="4"> |
| |
| <tr> |
| |
| <th colspan="1" rowspan="1"> |
| |
| <p> |
| Document V1.3 |
| </p> |
| |
| </th> |
| <th colspan="1" rowspan="1"> |
| |
| <p> |
| Document V2.0 |
| </p> |
| |
| </th> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1"> |
| |
| <p> |
| <fork href="../index.html"> |
| </p> |
| |
| </td> |
| <td colspan="1" rowspan="1"><a target="_blank" class="fork" href="../index.html"><a class="fork" |
| href="../index.html"></a> |
| </td> |
| |
| </tr> |
| |
| <tr> |
| |
| <td colspan="1" rowspan="1"> |
| |
| <p> |
| <jump href="../index.html"> |
| </p> |
| |
| </td> |
| <td colspan="1" rowspan="1"> |
| |
| <p> |
| |
| <a target="_top" class="jump" href="../index.html"><a class="jump" |
| href="../index.html"></a> |
| |
| </p> |
| |
| </td> |
| |
| </tr> |
| |
| </table> |
| </div> |
| |
| <a name="N102D1"></a><a name="changes"></a> |
| <h2 class="underlined_10">DTD changes</h2> |
| <div class="section"> |
| <p> |
| See the generated <a href="../docs_0_80/../dtdx/dtd-docs.html">DTD reference |
| documentation</a>. |
| </p> |
| <a name="N102DE"></a><a name="changes-20"></a> |
| <h3 class="underlined_5">Changes between document-v13 and document-v20</h3> |
| <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> |
| <a name="N10300"></a><a name="changes-13"></a> |
| <h3 class="underlined_5">Changes between document-v12 and document-v13</h3> |
| <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> |
| <a name="N1030A"></a><a name="changes-12"></a> |
| <h3 class="underlined_5">Changes between document-v11 and document-v12</h3> |
| <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> |
| </div> |
| |
| </div> |
| <!--+ |
| |end content |
| +--> |
| <div class="clearboth"> </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 © |
| 2002-2007 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a> |
| </div> |
| <!--+ |
| |end bottomstrip |
| +--> |
| </div> |
| </body> |
| </html> |
