| <!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>Our Contract</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 class="current"> |
| <a class="selected" href="index.html">Welcome</a> |
| </li> |
| <li> |
| <a class="unselected" href="contrib.html">Developers</a> |
| </li> |
| <li> |
| <a class="unselected" 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"></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');">About</div> |
| <div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;"> |
| <div class="menuitem"> |
| <a href="index.html" title="Welcome and introduction">About Forrest</a> |
| </div> |
| <div class="menuitem"> |
| <a href="linkmap.html" title="Table of Contents for all Forrest documentation">Documentation ToC</a> |
| </div> |
| <div class="menuitem"> |
| <a href="http://forrest.apache.org/mirrors.cgi" title="Download a release from your nearest mirror or get the latest from SVN">Download</a> |
| </div> |
| <div class="menuitem"> |
| <a href="mail-lists.html" title="Discussion mail lists are the heart of the project: dev, user, svn">Mail lists and discussion</a> |
| </div> |
| <div class="menuitem"> |
| <a href="license.html" title="Notes and FAQs about the licensing">License</a> |
| </div> |
| <div class="menupage"> |
| <div class="menupagetitle">Our contract</div> |
| </div> |
| <div class="menuitem"> |
| <a href="compliance.html" title="Declare the status of HTML, WAI, CSS compliance">Standards compliance</a> |
| </div> |
| <div class="menuitem"> |
| <a href="forrest-issues.html" title="List of currently open issues">Open issues</a> |
| </div> |
| <div class="menuitem"> |
| <a href="who.html" title="Explain who is involved">Who we are</a> |
| </div> |
| <div class="menuitem"> |
| <a href="flyer.html" title="One-page description">Flyer</a> |
| </div> |
| <div class="menuitem"> |
| <a href="live-sites.html" title="Some sites created using Apache Forrest technology">Example sites</a> |
| </div> |
| <div class="menuitem"> |
| <a href="thanks.html" title="Acknowledgment to those who have become involved">Thanks</a> |
| </div> |
| </div> |
| <div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Related projects</div> |
| <div id="menu_1.2" class="menuitemgroup"> |
| <div class="menuitem"> |
| <a href="http://gump.apache.org/">Apache Gump</a> |
| </div> |
| <div class="menuitem"> |
| <a href="http://cocoon.apache.org/">Apache Cocoon</a> |
| </div> |
| <div class="menuitem"> |
| <a href="http://lenya.apache.org/">Apache Lenya</a> |
| </div> |
| <div class="menuitem"> |
| <a href="http://xml.apache.org/">Apache XML</a> |
| </div> |
| <div class="menuitem"> |
| <a href="http://projects.apache.org/">projects.apache.org</a> |
| </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="forrest-contract.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>Our Contract</h1> |
| <div class="abstract"> |
| This document describes, in a very techy bullet-style way, how to use |
| Apache Forrest. |
| </div> |
| <div id="minitoc-area"> |
| <ul class="minitoc"> |
| <li> |
| <a href="#forrest-will">Apache Forrest will:</a> |
| </li> |
| <li> |
| <a href="#project-must">TheProject must:</a> |
| </li> |
| <li> |
| <a href="#project-can">TheProject can:</a> |
| </li> |
| </ul> |
| </div> |
| |
| <div class="note"> |
| <div class="label">Note</div> |
| <div class="content"> |
| This document describes the formal contract between <strong>Apache |
| Forrest</strong> and the <strong>Project (your development team)</strong> |
| that is using it for generating its documentation, hereafter referred to |
| as "TheProject". |
| </div> |
| </div> |
| |
| <div class="note"> |
| <div class="label">Note</div> |
| <div class="content"> |
| Some terminology will assist: <span class="codefrag">{docroot}</span> is the location |
| inside TheProject's file hierarchy where all documentation related |
| resources are stored. Usually <span class="codefrag">{docroot}</span> equals to |
| <span class="codefrag">{projecthome}/src/documentation</span> |
| |
| </div> |
| </div> |
| |
| <a name="N1002C"></a><a name="forrest-will"></a> |
| <h2 class="underlined_10">Apache Forrest will:</h2> |
| <div class="section"> |
| <p> |
| Provide infrastructure ... |
| </p> |
| <ul> |
| |
| <li>Use Apache Cocoon to generate the HTML and PDF documentation for |
| TheProject.</li> |
| |
| <li>Provide default Cocoon sitemaps, Cocoon pipelines, skins and other |
| theme abilities, document type definitions (DTDs) and other appropriate schema. |
| </li> |
| |
| <li>Provide a framework for plugins and various input/output capabilities as plugins. |
| </li> |
| |
| <li>Provide a willing group of supporting developers at the |
| <a href="mail-lists.html">mail lists</a>. |
| </li> |
| |
| </ul> |
| </div> |
| |
| <a name="N10049"></a><a name="project-must"></a> |
| <h2 class="underlined_10">TheProject must:</h2> |
| <div class="section"> |
| <p> |
| Provide content and configuration ... |
| </p> |
| <ul> |
| |
| <li>Provide XML content in <span class="codefrag">{docroot}/content/xdocs</span> |
| according to the Forrest DTDs, or one of the other input formats. |
| </li> |
| |
| <li>Provide navigation metadata using the configuration files |
| <span class="codefrag">site.xml</span> and <span class="codefrag">tabs.xml</span> |
| </li> |
| |
| <li>Provide the skin configuation file in |
| <span class="codefrag">{docroot}/skinconf.xml</span> |
| </li> |
| |
| </ul> |
| </div> |
| |
| <a name="N10069"></a><a name="project-can"></a> |
| <h2 class="underlined_10">TheProject can:</h2> |
| <div class="section"> |
| <p> |
| Add extra abilities ... |
| </p> |
| <ul> |
| |
| <li>Specify other properties (e.g. additional plugins) in |
| <span class="codefrag">{docroot}/forrest.properties</span> |
| </li> |
| |
| <li>Provide its own skin in |
| <span class="codefrag">{docroot}/skins/{your-skin-name}</span> (Check the current |
| Forrest skins and the related pipelines to see what they are doing. |
| Bear in mind that the provided skins are able to be configured and |
| may already meet your needs.)</li> |
| |
| <li>Provide own DTDs to handle other specialised document types in |
| <span class="codefrag">{docroot}/resources/schema/dtd</span> |
| |
| <ul> |
| |
| <li>and extra stylesheets to convert own grammar to the |
| intermediate 'document' structure.</li> |
| |
| <li>and declare those extra DTDs in |
| <span class="codefrag">{docroot}/resources/schema/catalog.xcat</span> |
| </li> |
| |
| </ul> |
| </li> |
| |
| <li>Provide its own overwriting versions of sitemaps |
| (<span class="codefrag">{docroot}/sitemap.xmap</span> and other *.xmap files) |
| ... (be sure you know what you are doing since you are then leaving |
| the area where other people can help you out. |
| </li> |
| |
| <li>Develop its own additional functionality using plugins. |
| </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> |
