forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From diwa...@apache.org
Subject svn commit: r230990 - in /forrest/site: ./ docs_0_60/ docs_0_70/ docs_0_80/ docs_0_80/howto/ dtdx/ pluginDocs/plugins_0_80/ skin/ skin/images/ versions/
Date Tue, 09 Aug 2005 06:36:11 GMT
Author: diwaker
Date: Mon Aug  8 23:35:28 2005
New Revision: 230990

URL: http://svn.apache.org/viewcvs?rev=230990&view=rev
Log:
Automatic publish from forrestbot

Added:
    forrest/site/committed-1.png   (with props)
    forrest/site/committed.html   (with props)
    forrest/site/committed.pdf   (with props)
Modified:
    forrest/site/docs_0_60/linking.pdf
    forrest/site/docs_0_60/your-project.pdf
    forrest/site/docs_0_70/linking.pdf
    forrest/site/docs_0_70/primer.pdf
    forrest/site/docs_0_70/your-project.pdf
    forrest/site/docs_0_80/faq.html
    forrest/site/docs_0_80/faq.pdf
    forrest/site/docs_0_80/faq.xml
    forrest/site/docs_0_80/howto/howto-buildPlugin.html
    forrest/site/docs_0_80/linking.pdf
    forrest/site/docs_0_80/primer.pdf
    forrest/site/dtdx/document-v12.pdf
    forrest/site/dtdx/document-v13.pdf
    forrest/site/dtdx/document-v20.pdf
    forrest/site/linkmap.pdf
    forrest/site/live-sites.html
    forrest/site/live-sites.pdf
    forrest/site/pluginDocs/plugins_0_80/pluginInfrastructure.html
    forrest/site/skin/basic.css
    forrest/site/skin/images/rc-b-l-15-1body-2menu-3menu.png
    forrest/site/skin/images/rc-b-r-15-1body-2menu-3menu.png
    forrest/site/skin/images/rc-b-r-5-1header-2tab-selected-3tab-selected.png
    forrest/site/skin/images/rc-t-l-5-1header-2searchbox-3searchbox.png
    forrest/site/skin/images/rc-t-l-5-1header-2tab-selected-3tab-selected.png
    forrest/site/skin/images/rc-t-l-5-1header-2tab-unselected-3tab-unselected.png
    forrest/site/skin/images/rc-t-r-15-1body-2menu-3menu.png
    forrest/site/skin/images/rc-t-r-5-1header-2searchbox-3searchbox.png
    forrest/site/skin/images/rc-t-r-5-1header-2tab-selected-3tab-selected.png
    forrest/site/skin/images/rc-t-r-5-1header-2tab-unselected-3tab-unselected.png
    forrest/site/versions/index.html

Added: forrest/site/committed-1.png
URL: http://svn.apache.org/viewcvs/forrest/site/committed-1.png?rev=230990&view=auto
==============================================================================
Binary file - no diff available.

Propchange: forrest/site/committed-1.png
------------------------------------------------------------------------------
    svn:mime-type = image/png

Added: forrest/site/committed.html
URL: http://svn.apache.org/viewcvs/forrest/site/committed.html?rev=230990&view=auto
==============================================================================
--- forrest/site/committed.html (added)
+++ forrest/site/committed.html Mon Aug  8 23:35:28 2005
@@ -0,0 +1,285 @@
+<!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>Becoming an Apache Forrest committer</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">
+<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>
+<div class="header">
+<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>
+<div class="projectlogo">
+<a href="http://forrest.apache.org/"><img class="logoImage" alt="Forrest" src="images/project-logo.gif" title="Apache Forrest"></a>
+</div>
+<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 attr="value" name="Search" value="Search" type="submit">
+</form>
+</div>
+<ul id="tabs">
+<li>
+<a class="base-not-selected" href="index.html">Welcome</a>
+</li>
+<li class="current">
+<a class="base-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>
+</div>
+</div>
+<div id="main">
+<div id="publishedStrip">
+<div id="level2tabs"></div>
+<script type="text/javascript"><!--
+document.write("<text>Last Published:</text> " + document.lastModified);
+//  --></script>
+</div>
+<div class="breadtrail">
+             
+             &nbsp;
+           </div>
+<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');">Getting Involved</div>
+<div id="menu_selected_1.1" class="selectedmenuitemgroup" style="display: block;">
+<div class="menuitem">
+<a href="contrib.html">Contributing</a>
+</div>
+<div class="menuitem">
+<a href="http://svn.apache.org/viewcvs.cgi/forrest/trunk/">Browse SVN</a>
+</div>
+<div class="menuitem">
+<a href="mail-lists.html">Mail lists</a>
+</div>
+<div class="menuitem">
+<a href="http://issues.apache.org/jira/secure/BrowseProject.jspa?id=12310000">Bugs and Issues</a>
+</div>
+<div class="menuitem">
+<a href="forrest-issues.html">Open Issues</a>
+</div>
+<div class="menuitem">
+<a href="gump.html">Gump Integration</a>
+</div>
+<div class="menuitem">
+<a href="guidelines.html">Project guidelines</a>
+</div>
+<div class="menupage">
+<div class="menupagetitle">Being committed</div>
+</div>
+</div>
+<div onclick="SwitchMenu('menu_1.2', 'skin/')" id="menu_1.2Title" class="menutitle">Proposals</div>
+<div id="menu_1.2" class="menuitemgroup">
+<div class="menuitem">
+<a href="proposal-asf-forrestbot.html">ASF Forrestbot</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>
+<div id="credit2">
+<a href="http://apachecon.com/"><img border="0" title="ApacheCon Europe 2005" alt="ApacheCon Europe 2005 - logo" src="http://apache.org/images/ac2005eu_135x50.gif" style="width: 135px;height: 50px;"></a>
+</div>
+</div>
+<div id="content">
+<div title="Portable Document Format" class="pdflink">
+<a class="dida" href="committed.pdf"><img alt="PDF -icon" src="skin/images/pdfdoc.gif" class="skin"><br>
+        PDF</a>
+</div>
+<div class="trail">
+<text>Font size:</text> 
+	          &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>Becoming an Apache Forrest committer</h1>
+<div class="abstract">This is a discussion of how users can progress to 
+    become committers within the Apache Forrest project.</div>
+<div id="minitoc-area">
+<ul class="minitoc">
+<li>
+<a href="#committers">What is a committer?</a>
+</li>
+<li>
+<a href="#copdoc">Contributing to the Project - CoPDoC</a>
+</li>
+<li>
+<a href="#becoming">Becoming a Committer</a>
+</li>
+<li>
+<a href="#discussion">Adding to the discussions</a>
+</li>
+<li>
+<a href="#references">References</a>
+</li>
+</ul>
+</div>
+    
+<a name="N10010"></a><a name="committers"></a>
+<h2 class="underlined_10">What is a committer?</h2>
+<div class="section">
+<div class="warning">
+<div class="label">Warning</div>
+<div class="content">
+      This document is under development and does not yet represent
+      the view of our community.
+    </div>
+</div>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">Content is being gleaned from various current and past
+      discussions on the Forrest dev mailing list, in particular
+      <a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=112239074108858">this</a>.
+      Further editing of this page is needed and would 
+      be greatly appreciated.</div>
+</div>
+<p>Committer is an Apache term used to signify someone who is 
+      committed to a particular project and who is invited to be part of 
+      the core group within the project that ensures the project's vitality 
+      (represented by the PMC, Project Management Committee).</p>
+<p>One thing 
+      that is sometimes hard to understand when you are new to the
+      Apache Way<sup>1</sup>
+      is that we don't really care about code, it is the 
+      community we care about. This is because a strong and healthy 
+      community will usually generate strong and healthy code.  As a result 
+      of the Apache focus on community it is more important for people here 
+      to discuss and explore within the community.</p>
+</div>
+    
+<a name="N1002A"></a><a name="copdoc"></a>
+<h2 class="underlined_10">Contributing to the Project - CoPDoC</h2>
+<div class="section">
+<p>The foundation of a project and how the community contributes 
+      to it is known by the acronym CoPDoC:</p>
+<ul>
+    
+<li>(Co)mmunity - one must interact with others, and share vision 
+      and knowledge</li>
+    
+<li>(P)roject - a clear vision and consensus are needed</li>
+    
+<li>(Do)cumentation - without it, the stuff remains only in the 
+      minds of the authors</li>
+    
+<li>(C)ode - discussion goes nowhere without code</li>
+    
+</ul>
+</div>
+    
+<a name="N10043"></a><a name="becoming"></a>
+<h2 class="underlined_10">Becoming a Committer</h2>
+<div class="section">
+<p>There is nothing at The Apache Software Foundation that says you must write code 
+      in order to be a committer. Anyone who is supportive of the community 
+      and works in any of the CoPDoC areas is a likely candidate for 
+      committership.</p>
+<p>Apache is a meritocracy. That is, once someone has 
+      contributed sufficiently to any area of CoPDoC they can be voted in 
+      as a committer. Being a committer does not mean you commit code, it 
+      means you are committed to the project.</p>
+<p>One of the key contributions 
+      people can make to the community is through the support of a wide 
+      user base by assisting users on the user list, writing user oriented 
+      docs and ensuring the user viewpoint is understood by all developers. A 
+      main idea behind being a committer is the ability to be a mentor and 
+      to work cooperatively with your peers.</p>
+<p>The following diagram shows the progression of a user to a 
+      committer/mentor.</p>
+<p>
+<img alt="committer path" src="committed-1.png"></p>
+<p>Meritocracy progresses this way
+      <span class="codefrag">------------&gt; ------------------------&gt;</span>
+</p>
+<p>Note that this is not a hierarchy, it is a progression from a 
+      broad user base from which those that wish to to contribute to the 
+      ongoing development of the project (again, through any aspect of 
+      CoPDoC, not just coding) can become involved as developers.  From 
+      these developers are those who take on additional roles of mentoring 
+      and more fully commit themselves to the project.</p>
+</div>
+    
+<a name="N10063"></a><a name="discussion"></a>
+<h2 class="underlined_10">Adding to the discussions</h2>
+<div class="section">
+<p>Discussion leads to a clearer community understanding of the 
+      project's goals and objectives and also of how the community works.</p>
+<p>  
+      Of course, there needs to be a balance between too much chat and not 
+      enough code.  If something is easy to do in code and does not impact 
+      the overall product (such as a bug fix) then just go ahead and do it. 
+      However, if something is to introduce a new feature, then it is best to 
+      introduce your idea to the community via an email to the dev mail 
+      list first. In this introduction you should outline why you want to 
+      do something, how you propose to do it (pseudo code is a good way of 
+      expressing this) and ask for comments. Any comments received will 
+      help to fine tune the design and, in many cases, produce a quicker, 
+      more elegant solution (this is the benefit of many eyes on a 
+      solution).</p>
+<p>The absence of comments from others does not 
+      mean it is not a good idea, in fact the reverse is true, it means 
+      nobody has any objection or anything to add. It is only if people 
+      respond that you need to discuss further. Once the discussion reaches 
+      consensus then coding can accelerate. Once you have implicit or explicit 
+      approval for your contribution, just go ahead and do it. Be sure to 
+      document what you have done whilst you are at it. Without 
+      documentation (comments in code, mailing list discussion and user 
+      docs) your code is next to useless - nobody knows it is there and 
+      nobody knows how it works.</p>
+<p>Online discussion is important for community building.
+      Offline discussion and one-to-one conversations deny the
+      community the chance to become involved and lead to solutions
+      that are not ideal. So please do as much discussion as possible
+      on the dev or user mailing list.</p>
+</div>
+    
+<a name="N10076"></a><a name="references"></a>
+<h2 class="underlined_10">References</h2>
+<div class="section">
+<p>
+<sup>1</sup> See more information about "the Apache Way" in the
+      <a href="http://www.apache.org/foundation/how-it-works.html">ASF How it works</a>.</p>
+<p>
+        Apache Forrest
+        <a href="guidelines.html">project guidelines</a>.
+      </p>
+</div>
+  
+</div>
+<div class="clearboth">&nbsp;</div>
+</div>
+<div id="footer">
+<div class="lastmodified">
+<script type="text/javascript"><!--
+document.write("<text>Last Published:</text> " + document.lastModified);
+//  --></script>
+</div>
+<div class="copyright">
+        Copyright &copy;
+         2002-2005 <a href="http://www.apache.org/licenses/">The Apache Software Foundation.</a>
+</div>
+</div>
+</body>
+</html>

Propchange: forrest/site/committed.html
------------------------------------------------------------------------------
    svn:eol-style = native

Added: forrest/site/committed.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/committed.pdf?rev=230990&view=auto
==============================================================================
Binary file - no diff available.

Propchange: forrest/site/committed.pdf
------------------------------------------------------------------------------
    svn:mime-type = application/pdf

Modified: forrest/site/docs_0_60/linking.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_60/linking.pdf?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/docs_0_60/your-project.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_60/your-project.pdf?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/docs_0_70/linking.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_70/linking.pdf?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/docs_0_70/primer.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_70/primer.pdf?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/docs_0_70/your-project.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_70/your-project.pdf?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/docs_0_80/faq.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/faq.html?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
--- forrest/site/docs_0_80/faq.html (original)
+++ forrest/site/docs_0_80/faq.html Mon Aug  8 23:35:28 2005
@@ -347,13 +347,17 @@
 <a href="#encoding">2.14. Does Forrest handle accents for non-English languages?</a>
 </li>
 <li>
-<a href="#cleanSite">2.15.  How can I make Forrest properly clean up the build/site-directory? </a>
+<a href="#xml-entities">2.15. How to use XML entities, for example string
+        replacement?</a>
 </li>
 <li>
-<a href="#i18n">2.16. How can I internationalise (i18n) my content?</a>
+<a href="#cleanSite">2.16.  How can I make Forrest properly clean up the build/site-directory? </a>
 </li>
 <li>
-<a href="#rawTML">2.17. How can I include HTML content that is not to be skinned by Forrest?</a>
+<a href="#i18n">2.17. How can I internationalise (i18n) my content?</a>
+</li>
+<li>
+<a href="#rawTML">2.18. How can I include HTML content that is not to be skinned by Forrest?</a>
 </li>
 </ul>
 </li>
@@ -424,7 +428,7 @@
 <a href="#generating_menus">5.1. What is the relationship between site.xml and book.xml? </a>
 </li>
 <li>
-<a href="#docbook">5.2.  How do I use DocBook as the xml documentation format? </a>
+<a href="#docbook">5.2.  How do I use DocBook as the XML documentation format? </a>
 </li>
 <li>
 <a href="#version">5.3.  How to report which version of Forrest is being used and the properties that are
@@ -539,9 +543,9 @@
 <a href="#edit-content-menu">^</a>
 </div>
 <div style="margin-left: 15px">
-<p>If you are using the Apache Forrest xml <a href="../docs_0_80/../dtdx/dtd-docs.html">document format</a>
-          or DocBook or other xml document types, then you can use any text editor or even a
-          dedicated xml editor. You must ensure valid xml. See our <a href="../docs_0_80/catalog.html">configuration notes</a> for various editors. </p>
+<p>If you are using the Apache Forrest XML <a href="../docs_0_80/../dtdx/dtd-docs.html">document format</a>
+          or DocBook or other XML document types, then you can use any text editor or even a
+          dedicated XML editor. You must ensure valid XML. See our <a href="../docs_0_80/catalog.html">configuration notes</a> for various editors. </p>
 <p>There are content management systems like <a href="http://lenya.apache.org/">Apache Lenya</a>. </p>
 <p>Remember that Forrest can also use other source formats, such as OpenOffice.org docs or
           JSPWiki. Use the appropriate editor for those document types and ensure that the document
@@ -559,7 +563,7 @@
 <div style="margin-left: 15px">
 <p>
           The <span class="codefrag">site.xml</span> configuration file is used for two different purposes:
-          defining the left-hand navigation menus, and as a method for defining references
+          defining the navigation menus, and as a method for defining references
           to be used when linking between documents.
           This file is fully explained in
           <a href="../docs_0_80/linking.html">Menus and Linking</a>. Here is a precis:
@@ -601,10 +605,11 @@
 <div style="margin-left: 15px">
 <p>
           There are examples in the 'forrest seed site' and also the Forrest website documents
-          are included with the distribution (cd forrest/site-author; forrest run).
+          are included with the distribution (<span class="codefrag">cd forrest/site-author;
+            forrest run</span>).
         </p>
 </div>
-<a name="N100D4"></a><a name="PDF-output"></a>
+<a name="N100D7"></a><a name="PDF-output"></a>
 <h4 class="faq">2.4. How can I generate one pdf-file out of the whole site or selected pages of the site?</h4>
 <div align="right">
 <a href="#PDF-output-menu">^</a>
@@ -624,7 +629,7 @@
 <p> This assumes that you use the <a href="../docs_0_80/linking.html">site.xml</a> method for your
           site structure and navigation, rather than the old book.xml method. </p>
 </div>
-<a name="N100EE"></a><a name="pageBreaks"></a>
+<a name="N100F1"></a><a name="pageBreaks"></a>
 <h4 class="faq">2.5. How do I insert page breaks into documents?</h4>
 <div align="right">
 <a href="#pageBreaks-menu">^</a>
@@ -642,10 +647,17 @@
           <span class="codefrag">skinconf.xml</span>
         
 </p>
-<pre class="code"> .pageBreakBefore { margin-bottom: 0; page-break-before: always; } .pageBreakAfter {
-          margin-bottom: 0; page-break-after: always; } </pre>
+<pre class="code"> 
+          .pageBreakBefore { 
+            margin-bottom: 0; 
+            page-break-before: always; 
+          } 
+          .pageBreakAfter {
+            margin-bottom: 0; 
+            page-break-after: always; 
+            } </pre>
 </div>
-<a name="N1010C"></a><a name="clickable-email-address"></a>
+<a name="N1010F"></a><a name="clickable-email-address"></a>
 <h4 class="faq">2.6. How can I generate html-pages to show a 'clickable' email-address (of the
         author-element)?</h4>
 <div align="right">
@@ -656,7 +668,7 @@
             $FORREST_HOME/main/webapp/skins/common/xslt/html/document2html.xsl</span> and edit the
           "headers/authors" template. </p>
 </div>
-<a name="N10117"></a><a name="link_raw"></a>
+<a name="N1011A"></a><a name="link_raw"></a>
 <h4 class="faq">2.7. How do I link to raw files such as config.txt and brochure.pdf? </h4>
 <div align="right">
 <a href="#link_raw-menu">^</a>
@@ -666,7 +678,7 @@
           <a href="../docs_0_70/upgrading_07.html#raw">Upgrading to Apache Forrest 0.7</a> for
           all the details.</p>
 </div>
-<a name="N10123"></a><a name="pdf_images"></a>
+<a name="N10126"></a><a name="pdf_images"></a>
 <h4 class="faq">2.8. Images don't display in PDFs. How do I fix this?</h4>
 <div align="right">
 <a href="#pdf_images-menu">^</a>
@@ -690,7 +702,7 @@
         
 </ol>
 <p>Alternatively you can use JAI (Java Advanced Imaging API at
-          http://java.sun.com/products/java-media/jai). For more info, see <a href="http://xml.apache.org/fop/graphics.html#packages">FOP Graphics Packages</a>
+          <span class="codefrag">http://java.sun.com/products/java-media/jai</span>). For more info, see <a href="http://xml.apache.org/fop/graphics.html#packages">FOP Graphics Packages</a>
         
 </p>
 <div class="note">
@@ -698,7 +710,7 @@
 <div class="content">Due to Sun's licensing, we cannot redistribute Jimi or JAI with Forrest.</div>
 </div>
 </div>
-<a name="N10150"></a><a name="tab-index"></a>
+<a name="N10156"></a><a name="tab-index"></a>
 <h4 class="faq">2.9.  The tab link in my site incorrectly assumes that 'index.html' is present in the
         linked-to directory. How do I fix this? </h4>
 <div align="right">
@@ -717,7 +729,7 @@
     &lt;map:redirect-to uri="manual/Introduction.html"/&gt;
   &lt;/map:match&gt;</pre>
 </div>
-<a name="N1016C"></a><a name="tab-site"></a>
+<a name="N10172"></a><a name="tab-site"></a>
 <h4 class="faq">2.10. I need help with the interaction between tabs.xml and site.xml </h4>
 <div align="right">
 <a href="#tab-site-menu">^</a>
@@ -727,7 +739,7 @@
           See the <a href="../docs_0_80/linking.html#tab-site">tips</a>.
         </p>
 </div>
-<a name="N10178"></a><a name="defaultFileName"></a>
+<a name="N1017E"></a><a name="defaultFileName"></a>
 <h4 class="faq">2.11.  How can I change the default file name that Forrest will look for when I request a
         URL like http://myserver or http://myserver/mydir/ ? </h4>
 <div align="right">
@@ -757,7 +769,7 @@
         
 </ol>
 </div>
-<a name="N101A0"></a><a name="defaultStartPage"></a>
+<a name="N101A6"></a><a name="defaultStartPage"></a>
 <h4 class="faq">2.12.  How can I use a start-up-page other than index.html? </h4>
 <div align="right">
 <a href="#defaultStartPage-menu">^</a>
@@ -788,7 +800,7 @@
         
 </ol>
 </div>
-<a name="N101C4"></a><a name="label-entity"></a>
+<a name="N101CA"></a><a name="label-entity"></a>
 <h4 class="faq">2.13.  How to use special characters in the labels of the site.xml file? </h4>
 <div align="right">
 <a href="#label-entity-menu">^</a>
@@ -800,7 +812,7 @@
 </p>
 <p> See the <a href="http://www.w3.org/TR/xhtml-modularization/dtd_module_defs.html#a_xhtml_character_entities">XHTML Character Entities</a> and see more discussion at <a href="http://issues.apache.org/jira/browse/FOR-244">Issue FOR-244</a>. </p>
 </div>
-<a name="N101DD"></a><a name="encoding"></a>
+<a name="N101E3"></a><a name="encoding"></a>
 <h4 class="faq">2.14. Does Forrest handle accents for non-English languages?</h4>
 <div align="right">
 <a href="#encoding-menu">^</a>
@@ -816,8 +828,8 @@
 <li>tildes: &atilde; &ntilde; Ä© &otilde; Å©</li>
         
 </ul>
-<p>This is because sources for Forrest docs are xml documents, which can include any of
-          these, provided the encoding declared by the xml doc matches the actual encoding used in
+<p>This is because sources for Forrest docs are XML documents, which can include any of
+          these, provided the encoding declared by the XML doc matches the actual encoding used in
           the file. For example if you declare the default encoding:</p>
 <pre class="code">&lt;?xml version="1.0" encoding="UTF-8"?&gt;</pre>
 <p>but the file content is actually using ISO-8859-1 then you will receive validation
@@ -835,7 +847,7 @@
 <pre class="code">[localhost]$ export LANG=en_US.UTF-8</pre>
 <p>Of course the <em>appropriate</em> way to set the encoding depends on the editor/OS, but
           ultimately relys on the user preferences. So you can use the encoding you prefer, as long
-          as the <span class="codefrag">encoding</span> attribute of the xml declaration matches the actual encoding
+          as the <span class="codefrag">encoding</span> attribute of the XML declaration matches the actual encoding
           of the file. This means that if you are not willing to abandon ISO-8859-1 you can always
           use the following declaration instead:</p>
 <pre class="code">&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;</pre>
@@ -847,8 +859,24 @@
             Schlabach</a> and <a href="http://www.alanwood.net/unicode/">Alan Wood's Unicode
             resources</a>. </p>
 </div>
-<a name="N1022F"></a><a name="cleanSite"></a>
-<h4 class="faq">2.15.  How can I make Forrest properly clean up the build/site-directory? </h4>
+<a name="N10235"></a><a name="xml-entities"></a>
+<h4 class="faq">2.15. How to use XML entities, for example string
+        replacement?</h4>
+<div align="right">
+<a href="#xml-entities-menu">^</a>
+</div>
+<div style="margin-left: 15px">
+<p>
+          A set of symbols is available. See the demonstration
+          in a fresh 'forrest seed' site (at samples/xml-entities.html).
+          For example, use "<span class="codefrag">&amp;myp-t;</span>" to represent the
+          project name together with trademark symbol
+          "My Project Name&trade;".
+          Avoid lengthy typing and potential spelling errors.
+        </p>
+</div>
+<a name="N10240"></a><a name="cleanSite"></a>
+<h4 class="faq">2.16.  How can I make Forrest properly clean up the build/site-directory? </h4>
 <div align="right">
 <a href="#cleanSite-menu">^</a>
 </div>
@@ -859,8 +887,8 @@
 <p>To ensure a clean build call 'forrest clean site' instead of just 'forrest' so Forrest
           will delete all build directories before creating new content. </p>
 </div>
-<a name="N1023A"></a><a name="i18n"></a>
-<h4 class="faq">2.16. How can I internationalise (i18n) my content?</h4>
+<a name="N1024B"></a><a name="i18n"></a>
+<h4 class="faq">2.17. How can I internationalise (i18n) my content?</h4>
 <div align="right">
 <a href="#i18n-menu">^</a>
 </div>
@@ -873,8 +901,8 @@
         by the <a href="http://cocoon.apache.org/2.1/userdocs/transformers/i18n-transformer.html">Cocoon i18n 
         Transformer</a>. You can see an example of how it works in the above linked issue.</p>
 </div>
-<a name="N1024D"></a><a name="rawTML"></a>
-<h4 class="faq">2.17. How can I include HTML content that is not to be skinned by Forrest?</h4>
+<a name="N1025E"></a><a name="rawTML"></a>
+<h4 class="faq">2.18. How can I include HTML content that is not to be skinned by Forrest?</h4>
 <div align="right">
 <a href="#rawTML-menu">^</a>
 </div>
@@ -895,9 +923,9 @@
 &lt;/map:match&gt;
         </pre>
 </div>
-<a name="N10259"></a><a name="technical"></a>
+<a name="N1026A"></a><a name="technical"></a>
 <h3 class="underlined_5">3. Technical</h3>
-<a name="N1025D"></a><a name="proxy_config"></a>
+<a name="N1026E"></a><a name="proxy_config"></a>
 <h4 class="faq">3.1. I'm behind a proxy and it's preventing Plugins from being downloaded, what should I
         do?</h4>
 <div align="right">
@@ -908,7 +936,7 @@
             <span class="codefrag">proxy.host</span> and <span class="codefrag">proxy.port</span> accordingly (the port will default
           to port 80).</p>
 </div>
-<a name="N1026E"></a><a name="CVS_revison_tags"></a>
+<a name="N1027F"></a><a name="CVS_revison_tags"></a>
 <h4 class="faq">3.2. How can I generate html-pages to show the revision tag of cvs?</h4>
 <div align="right">
 <a href="#CVS_revison_tags-menu">^</a>
@@ -921,7 +949,7 @@
 <p>This technique could also be used for a modification date with $Date: 2004/01/15 08:52:47
           $</p>
 </div>
-<a name="N10280"></a><a name="cli-xconf"></a>
+<a name="N10291"></a><a name="cli-xconf"></a>
 <h4 class="faq">3.3.  How to control the processing of URIs by Cocoon, e.g. exclude certain URIs, include
         other additional ones. </h4>
 <div align="right">
@@ -959,7 +987,7 @@
           <strong>foo/**</strong> to match that. </div>
 </div>
 </div>
-<a name="N102BD"></a><a name="ignoring_javadocs"></a>
+<a name="N102CE"></a><a name="ignoring_javadocs"></a>
 <h4 class="faq">3.4.  How do I stop Forrest breaking on links to external files that may not exist, like
         javadocs? </h4>
 <div align="right">
@@ -970,7 +998,7 @@
             <span class="codefrag">cli.xconf</span>
           </a> Cocoon config file, and defining patterns for URLs to exclude. </p>
 </div>
-<a name="N102CC"></a><a name="claimed_patterns"></a>
+<a name="N102DD"></a><a name="claimed_patterns"></a>
 <h4 class="faq">3.5. Some of my files are not being processed because they use common filenames. </h4>
 <div align="right">
 <a href="#claimed_patterns-menu">^</a>
@@ -986,7 +1014,7 @@
           with this issue (<a href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</a>).
         </p>
 </div>
-<a name="N102DE"></a><a name="build_msg_a"></a>
+<a name="N102EF"></a><a name="build_msg_a"></a>
 <h4 class="faq">3.6. What do the symbols and numbers mean when Forrest lists each document that it has
         built? </h4>
 <div align="right">
@@ -1019,7 +1047,7 @@
       
 </p>
 </div>
-<a name="N102FA"></a><a name="headless_operation"></a>
+<a name="N1030B"></a><a name="headless_operation"></a>
 <h4 class="faq">3.7.  When generating PNG images from SVG, I get an error: Can't connect to X11 window
         server using ':0.0' as the value of the DISPLAY variable. </h4>
 <div align="right">
@@ -1032,7 +1060,7 @@
 <pre class="code">forrest -Dforrest.jvmargs=-Djava.awt.headless=true site</pre>
 <p> See also <a href="http://cocoon.apache.org/2.1/faq/faq-configure-environment.html">Cocoon FAQ</a>. </p>
 </div>
-<a name="N10316"></a><a name="project-logo-svg"></a>
+<a name="N10327"></a><a name="project-logo-svg"></a>
 <h4 class="faq">3.8.  
         The project logo that is generated from SVG is truncating my project name.
       </h4>
@@ -1052,7 +1080,7 @@
           <a href="http://www.w3.org/Graphics/SVG/">SVG</a> resources.
         </p>
 </div>
-<a name="N1032E"></a><a name="catalog"></a>
+<a name="N1033F"></a><a name="catalog"></a>
 <h4 class="faq">3.9.  How do i configure my favourite XML editor or parser to find the local Forrest
         DTDs? </h4>
 <div align="right">
@@ -1062,7 +1090,7 @@
 <p> Notes are provided for various tools at <a href="../docs_0_80/catalog.html">Using Catalog Entity
             Resolver for local DTDs</a>. </p>
 </div>
-<a name="N1033A"></a><a name="skin"></a>
+<a name="N1034B"></a><a name="skin"></a>
 <h4 class="faq">3.10.  How to make the site look better and change its skin? </h4>
 <div align="right">
 <a href="#skin-menu">^</a>
@@ -1074,7 +1102,7 @@
 <p> See notes about <a href="../docs_0_80/your-project.html#skins">configuration</a> of the skins.
           Some projects may have special needs and can define their <a href="../docs_0_80/your-project.html#new_skin">own skin</a>. </p>
 </div>
-<a name="N10351"></a><a name="xsp"></a>
+<a name="N10362"></a><a name="xsp"></a>
 <h4 class="faq">3.11. How do I enable XSP processing?</h4>
 <div align="right">
 <a href="#xsp-menu">^</a>
@@ -1122,7 +1150,7 @@
 </ol>
 <p>See also the <a href="http://wiki.apache.org/cocoon/AddingXSPToForrest">AddingXSPToForrest</a> Wiki page.</p>
 </div>
-<a name="N1038C"></a><a name="breadcrumbs"></a>
+<a name="N1039D"></a><a name="breadcrumbs"></a>
 <h4 class="faq">3.12. How do breadcrumbs work? Why don't they work locally?</h4>
 <div align="right">
 <a href="#breadcrumbs-menu">^</a>
@@ -1141,7 +1169,7 @@
           are viewing the site locally, there is no domain and so there will be no extra
           breadcrumbs, only the ones that are specified in <span class="codefrag">skinconf.xml</span>. </p>
 </div>
-<a name="N103A1"></a><a name="run_port"></a>
+<a name="N103B2"></a><a name="run_port"></a>
 <h4 class="faq">3.13. How do I make forrest run listen on a different port?</h4>
 <div align="right">
 <a href="#run_port-menu">^</a>
@@ -1157,9 +1185,9 @@
         
 </p>
 </div>
-<a name="N103B5"></a><a name="old_faqs"></a>
+<a name="N103C6"></a><a name="old_faqs"></a>
 <h3 class="underlined_5">4. Older version: 0.6</h3>
-<a name="N103B9"></a><a name="old_claimed_patterns"></a>
+<a name="N103CA"></a><a name="old_claimed_patterns"></a>
 <h4 class="faq">4.1. Some of my files are not being processed because they use common filenames. </h4>
 <div align="right">
 <a href="#old_claimed_patterns-menu">^</a>
@@ -1175,9 +1203,9 @@
           with this issue (<a href="http://issues.apache.org/jira/browse/FOR-217">FOR-217</a>).
         </p>
 </div>
-<a name="N103CB"></a><a name="general"></a>
+<a name="N103DC"></a><a name="general"></a>
 <h3 class="underlined_5">5. General</h3>
-<a name="N103CF"></a><a name="generating_menus"></a>
+<a name="N103E0"></a><a name="generating_menus"></a>
 <h4 class="faq">5.1. What is the relationship between site.xml and book.xml? </h4>
 <div align="right">
 <a href="#generating_menus-menu">^</a>
@@ -1191,8 +1219,8 @@
           <span class="codefrag">site.xml</span>-generated menus aren't appropriate. See <a href="../docs_0_80/linking.html">Menus and
             Linking</a>. </p>
 </div>
-<a name="N103EA"></a><a name="docbook"></a>
-<h4 class="faq">5.2.  How do I use DocBook as the xml documentation format? </h4>
+<a name="N103FB"></a><a name="docbook"></a>
+<h4 class="faq">5.2.  How do I use DocBook as the XML documentation format? </h4>
 <div align="right">
 <a href="#docbook-menu">^</a>
 </div>
@@ -1232,12 +1260,12 @@
 <p> You can also use a mixture of the two methods, some handled automatically by Forrest and
           some directly using DocBook stylesheets. You can also have a mixture of source files as
           "document-v*" DTD and DocBook. </p>
-<p> Ensure that the document type declaration in your xml instance is well specified. Use a
+<p> Ensure that the document type declaration in your XML instance is well specified. Use a
           public identifier. The DTD will then be properly resolved by Forrest. If you need to use
           different DTDs, then see <a href="../docs_0_80/your-project.html#new_dtd">Using Forrest</a> for
           configuration guidance. </p>
 </div>
-<a name="N10418"></a><a name="version"></a>
+<a name="N10429"></a><a name="version"></a>
 <h4 class="faq">5.3.  How to report which version of Forrest is being used and the properties that are
         set? </h4>
 <div align="right">
@@ -1250,7 +1278,7 @@
           watch the build messages. Doing <span class="codefrag">'forrest -v'</span> will provide verbose build
           messages. </p>
 </div>
-<a name="N1042C"></a><a name="logs"></a>
+<a name="N1043D"></a><a name="logs"></a>
 <h4 class="faq">5.4.  Where are the log files to find more infomation about errors? </h4>
 <div align="right">
 <a href="#logs-menu">^</a>
@@ -1269,7 +1297,7 @@
 <p> Doing <span class="codefrag">'forrest -v'</span> will provide verbose build messages to the standard
           output. </p>
 </div>
-<a name="N10450"></a><a name="how_can_I_help"></a>
+<a name="N10461"></a><a name="how_can_I_help"></a>
 <h4 class="faq">5.5.  How to help? </h4>
 <div align="right">
 <a href="#how_can_I_help-menu">^</a>
@@ -1280,7 +1308,7 @@
           particularly from newcomers&mdash;often, close proximity blinds software developers to
           faults that are obvious to everyone else. Don't be shy! </p>
 </div>
-<a name="N1045C"></a><a name="patch"></a>
+<a name="N1046D"></a><a name="patch"></a>
 <h4 class="faq">5.6.  How to contribute a patch? </h4>
 <div align="right">
 <a href="#patch-menu">^</a>

Modified: forrest/site/docs_0_80/faq.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/faq.pdf?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/docs_0_80/faq.xml
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/faq.xml?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
--- forrest/site/docs_0_80/faq.xml (original)
+++ forrest/site/docs_0_80/faq.xml Mon Aug  8 23:35:28 2005
@@ -52,9 +52,9 @@
           value you set it to is dependant on your JVM, but something like
           <code>ANT_OPTS=-Xmx500M</code> will probably work. </p>
       </section></section><section id="content_faqs"><title>2. Content Creation</title><section id="edit-content"><title>2.1. What tools can be used to edit the content?</title>
-        <p>If you are using the Apache Forrest xml <link href="site:v0.80//dtd-docs">document format</link>
-          or DocBook or other xml document types, then you can use any text editor or even a
-          dedicated xml editor. You must ensure valid xml. See our <link href="site:v0.80//catalog">configuration notes</link> for various editors. </p>
+        <p>If you are using the Apache Forrest XML <link href="site:v0.80//dtd-docs">document format</link>
+          or DocBook or other XML document types, then you can use any text editor or even a
+          dedicated XML editor. You must ensure valid XML. See our <link href="site:v0.80//catalog">configuration notes</link> for various editors. </p>
         <p>There are content management systems like <link href="ext:lenya">Apache Lenya</link>. </p>
         <p>Remember that Forrest can also use other source formats, such as OpenOffice.org docs or
           JSPWiki. Use the appropriate editor for those document types and ensure that the document
@@ -66,7 +66,7 @@
       </title>
         <p>
           The <code>site.xml</code> configuration file is used for two different purposes:
-          defining the left-hand navigation menus, and as a method for defining references
+          defining the navigation menus, and as a method for defining references
           to be used when linking between documents.
           This file is fully explained in
           <link href="site:v0.80//linking">Menus and Linking</link>. Here is a precis:
@@ -104,7 +104,8 @@
       </title>
         <p>
           There are examples in the 'forrest seed site' and also the Forrest website documents
-          are included with the distribution (cd forrest/site-author; forrest run).
+          are included with the distribution (<code>cd forrest/site-author;
+            forrest run</code>).
         </p>
       </section><section id="PDF-output"><title>2.4. How can I generate one pdf-file out of the whole site or selected pages of the site?</title>
         <p>Add the following entries to your site.xml file:</p>
@@ -132,8 +133,15 @@
           the following to the <code>extra-css</code> element in your projects
           <code>skinconf.xml</code>
         </p>
-        <source xml:space="preserve"> .pageBreakBefore { margin-bottom: 0; page-break-before: always; } .pageBreakAfter {
-          margin-bottom: 0; page-break-after: always; } </source>
+        <source xml:space="preserve"> 
+          .pageBreakBefore { 
+            margin-bottom: 0; 
+            page-break-before: always; 
+          } 
+          .pageBreakAfter {
+            margin-bottom: 0; 
+            page-break-after: always; 
+            } </source>
       </section><section id="clickable-email-address"><title>2.6. How can I generate html-pages to show a 'clickable' email-address (of the
         author-element)?</title>
         <p>You would override <code>
@@ -157,7 +165,7 @@
               <code>$FORREST/lib/optional/jimi-1.0.jar</code>.</li>
         </ol>
         <p>Alternatively you can use JAI (Java Advanced Imaging API at
-          http://java.sun.com/products/java-media/jai). For more info, see <link href="http://xml.apache.org/fop/graphics.html#packages">FOP Graphics Packages</link>
+          <code>http://java.sun.com/products/java-media/jai</code>). For more info, see <link href="http://xml.apache.org/fop/graphics.html#packages">FOP Graphics Packages</link>
         </p>
         <note>Due to Sun's licensing, we cannot redistribute Jimi or JAI with Forrest.</note>
       </section><section id="tab-index"><title>2.9.  The tab link in my site incorrectly assumes that 'index.html' is present in the
@@ -226,8 +234,8 @@
           <li>diereses: ä ë ï ö ü</li>
           <li>tildes: ã ñ &#297; õ &#361;</li>
         </ul>
-        <p>This is because sources for Forrest docs are xml documents, which can include any of
-          these, provided the encoding declared by the xml doc matches the actual encoding used in
+        <p>This is because sources for Forrest docs are XML documents, which can include any of
+          these, provided the encoding declared by the XML doc matches the actual encoding used in
           the file. For example if you declare the default encoding:</p>
         <source xml:space="preserve">&lt;?xml version="1.0" encoding="UTF-8"?&gt;</source>
         <p>but the file content is actually using ISO-8859-1 then you will receive validation
@@ -245,7 +253,7 @@
         <source xml:space="preserve">[localhost]$ export LANG=en_US.UTF-8</source>
         <p>Of course the <em>appropriate</em> way to set the encoding depends on the editor/OS, but
           ultimately relys on the user preferences. So you can use the encoding you prefer, as long
-          as the <code>encoding</code> attribute of the xml declaration matches the actual encoding
+          as the <code>encoding</code> attribute of the XML declaration matches the actual encoding
           of the file. This means that if you are not willing to abandon ISO-8859-1 you can always
           use the following declaration instead:</p>
         <source xml:space="preserve">&lt;?xml version="1.0" encoding="ISO-8859-1"?&gt;</source>
@@ -256,13 +264,23 @@
         <p>Here are some references which explain further: <link href="http://orixo.com/events/gt2004/bios.html#torsten">GT2004 presentation by Torsten
             Schlabach</link> and <link href="http://www.alanwood.net/unicode/">Alan Wood's Unicode
             resources</link>. </p>
-      </section><section id="cleanSite"><title>2.15.  How can I make Forrest properly clean up the build/site-directory? </title>
+      </section><section id="xml-entities"><title>2.15. How to use XML entities, for example string
+        replacement?</title>
+        <p>
+          A set of symbols is available. See the demonstration
+          in a fresh 'forrest seed' site (at samples/xml-entities.html).
+          For example, use "<code>&amp;myp-t;</code>" to represent the
+          project name together with trademark symbol
+          "My Project Name&#8482;".
+          Avoid lengthy typing and potential spelling errors.
+        </p>
+      </section><section id="cleanSite"><title>2.16.  How can I make Forrest properly clean up the build/site-directory? </title>
         <p>Forrest for performance reasons doesn't clean out the build/site-directory each time you
           compile your project. This usually doesn't matter during development but might become a
           problem in a production environment.</p>
         <p>To ensure a clean build call 'forrest clean site' instead of just 'forrest' so Forrest
           will delete all build directories before creating new content. </p>
-      </section><section id="i18n"><title>2.16. How can I internationalise (i18n) my content?</title>
+      </section><section id="i18n"><title>2.17. How can I internationalise (i18n) my content?</title>
         <p>The i18n features of Forrest are still under development (as of 0.7) however there are
         some features available. For example, navigation menus can be i18n'd (see fresh-site for an
         example). Currently, <link href="http://issues.apache.org/jira/browse/FOR-506">work is underway</link> to 
@@ -271,7 +289,7 @@
         <p>All internationalistation of tokens in, for example, the skins and the menus, is carried out
         by the <link href="http://cocoon.apache.org/2.1/userdocs/transformers/i18n-transformer.html">Cocoon i18n 
         Transformer</link>. You can see an example of how it works in the above linked issue.</p>
-      </section><section id="rawTML"><title>2.17. How can I include HTML content that is not to be skinned by Forrest?</title>
+      </section><section id="rawTML"><title>2.18. How can I include HTML content that is not to be skinned by Forrest?</title>
         <p>To server, for example, a legacy HTML site add something like the following 
         to your projects sitemap:</p>
         <source xml:space="preserve">
@@ -455,7 +473,7 @@
           will be used to generate the menu. This supplement is useful in situations where
           <code>site.xml</code>-generated menus aren't appropriate. See <link href="site:v0.80//linking">Menus and
             Linking</link>. </p>
-      </section><section id="docbook"><title>5.2.  How do I use DocBook as the xml documentation format? </title>
+      </section><section id="docbook"><title>5.2.  How do I use DocBook as the XML documentation format? </title>
         <p> There are two ways. Forrest has a <code>simplifiedDocbook</code> plugin which can
           transform the DocBook format into the Forrest "xdocs" format on-the-fly and then render
           that as normal Forrest documents. Be aware that the stylesheet that does this
@@ -491,7 +509,7 @@
         <p> You can also use a mixture of the two methods, some handled automatically by Forrest and
           some directly using DocBook stylesheets. You can also have a mixture of source files as
           "document-v*" DTD and DocBook. </p>
-        <p> Ensure that the document type declaration in your xml instance is well specified. Use a
+        <p> Ensure that the document type declaration in your XML instance is well specified. Use a
           public identifier. The DTD will then be properly resolved by Forrest. If you need to use
           different DTDs, then see <link href="site:v0.80//your-project/new_dtd">Using Forrest</link> for
           configuration guidance. </p>

Modified: forrest/site/docs_0_80/howto/howto-buildPlugin.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/howto/howto-buildPlugin.html?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
--- forrest/site/docs_0_80/howto/howto-buildPlugin.html (original)
+++ forrest/site/docs_0_80/howto/howto-buildPlugin.html Mon Aug  8 23:35:28 2005
@@ -313,6 +313,11 @@
 </li>
 <li>
 <a href="#test">Testing a Plugin</a>
+<ul class="minitoc">
+<li>
+<a href="#Testing+During+Development">Testing During Development</a>
+</li>
+</ul>
 </li>
 <li>
 <a href="#release">Releasing a Plugin</a>
@@ -437,7 +442,8 @@
       cd [path_to_forrest]/plugins
       ant seedPlugin
       </pre>
-<p>The above ant target will ask you the name of the plugin and will
+<p>The above ant target will ask you the name of the plugin and some
+      additional information such as a breif description and will
       build a minimal plugin directory structure and configuration. You will 
       need to customise these files to build your plugin.</p>
 <div class="note">
@@ -462,16 +468,8 @@
 <p>You now have a skeleton plugin project. However, it doesn't do 
         anything useful yet. Now is a good time to edit some of the files
         provided.</p>
-<div class="note">
-<div class="label">Note</div>
-<div class="content">
-          For plugins intended to be held at forrest.apache.org please
-          adjust the skinconf.xml etc to be in accordance with the other
-          forrest plugins. See <a href="#hosted">notes</a> below.
-        </div>
-</div>
 <p>Here are some general notes:</p>
-<a name="N100AF"></a><a name="status"></a>
+<a name="N100A8"></a><a name="status"></a>
 <h5>status.xml</h5>
 <p>This file is used to track changes to the plugin
           project and to manage lists of things that still need to be done.
@@ -481,23 +479,30 @@
 <p>As you work on the plugin you should record all major changes in
           this file so that it can then be used as a changelog for your
           plugin.</p>
-<a name="N100BF"></a><a name="forrest-properties"></a>
+<a name="N100B8"></a><a name="forrest-properties"></a>
 <h5>forrest.properties</h5>
 <p>This file defines many configuration parameters for Forrest. It
           does not need to be customised in most cases. However, see
           for more details.</p>
-<a name="N100C9"></a><a name="skinconf"></a>
+<a name="N100C2"></a><a name="skinconf"></a>
 <h5>src/documentation/skinconf.xml</h5>
 <p>This configures the skin for your plugins documentation. There
           are some items that need to be configured in here, for example, the
           copyright information. The file is heavily commented so probably
           best to read through it, changing what you need to.</p>
-<a name="N100D3"></a><a name="doc"></a>
+<a name="N100CC"></a><a name="doc"></a>
 <h5>Documentation</h5>
 <p>It is also a good idea to start writing the documentation at this
           stage. The above process created a very simple plugin documentation
           site for you. All you have to do is add the content.</p>
-<a name="N100DD"></a><a name="hosted"></a>
+<a name="N100D6"></a><a name="componentConfig"></a>
+<h5>Component Configuraiton</h5>
+<p>If your plugin needs to provide additional Cocoon configuration
+          in the form of an <span class="codefrag">xconf</span>, or if some of the components
+          you are using need a configuraiton file (such as a JTidy config)
+          you should place them in a <span class="codefrag">conf</span> directory in the root
+          of your plugin.</p>
+<a name="N100E6"></a><a name="hosted"></a>
 <h5>Style notes for plugins hosted at forrest.apapche.org</h5>
 <p>
             After seeding a new plugin, copy the configuration from an
@@ -505,7 +510,7 @@
             Copy src/documentation/skinconf.xml and 
             src/documentation/content/xdocs/images/project-logo.gif
           </p>
-<a name="N100E9"></a><a name="edit-sitemap"></a>
+<a name="N100F2"></a><a name="edit-sitemap"></a>
 <h3 class="underlined_5">Edit the Plugin sitemap file(s)</h3>
 <p>The plugin <span class="codefrag">xmap</span> file is a Cocoon sitemap that is mounted
       at a strategic place in the Forrest pipeline. It is in this file
@@ -524,7 +529,7 @@
       all development work on Forrest, you will find
       the <a href="../../mail-lists.html#forrest-dev">developer mailing list</a>
       a very good resource (check the archives before posting, please).</p>
-<a name="N10110"></a><a name="components"></a>
+<a name="N10119"></a><a name="components"></a>
 <h4>Components, Actions and Resources</h4>
 <p>If your plugin uses any components (i.e. generators, transformers or
         serializers), actions or resources they must
@@ -539,13 +544,13 @@
         <span class="codefrag">{forrest:plugins}/PLUGIN_NAME</span> instead of <span class="codefrag">{realpath:/}</span>.
         </p>
 <p>See the examples below for more details.</p>
-<a name="N10138"></a><a name="resources"></a>
+<a name="N10141"></a><a name="resources"></a>
 <h3 class="underlined_5">Create the Necessary Resource Files</h3>
 <div class="fixme">
 <div class="label">Fixme (rdg)</div>
 <div class="content">Discuss the XSL files and other such resources</div>
 </div>
-<a name="N10143"></a><a name="samples"></a>
+<a name="N1014C"></a><a name="samples"></a>
 <h3 class="underlined_5">Create Samples in the Documentation</h3>
 <p>Plugin documentation should provide (as a minimum) an
       index page that provides an overview and a set of samples that demonstrate
@@ -555,7 +560,7 @@
       and <span class="codefrag">tabs.xml</span> configuration files.</p>
 <p>Try to provide a sample for all the major functions of your plugin
       and document any configuration that is available.</p>
-<a name="N10159"></a><a name="test"></a>
+<a name="N10162"></a><a name="test"></a>
 <h3 class="underlined_5">Testing a Plugin</h3>
 <p>Since your documentation for the plugin illustrates all of its 
       functionality, you can use that site for testing the plugin. However, you
@@ -581,9 +586,24 @@
       as writing your tests.</p>
 <p>Ensure that your sitemaps are robust and handle matches for files
       in sub-directories, as well as those at the root level.</p>
-<a name="N10187"></a><a name="release"></a>
+<a name="N1018F"></a><a name="Testing+During+Development"></a>
+<h4>Testing During Development</h4>
+<p>In the current plugin system plugins are not used from their
+        src directories, they must first be deployed locally. To do this
+        run the command <span class="codefrag">ant local-deploy</span>.</p>
+<div class="note">
+<div class="label">Note</div>
+<div class="content">The test target will do this deployment auotmatically for you.
+        You need only run it manually if you wish to test the plugin whilst
+        editing content in a live Forrest instance.</div>
+</div>
+<p>In most cases you can locally deploy a plugin without having to 
+        restart Forrest. However, if your plugin changes any configuration
+        files in the <span class="codefrag">conf</span> directory you will, most likely, have 
+        to restart Forrest to see these changes.</p>
+<a name="N101A6"></a><a name="release"></a>
 <h3 class="underlined_5">Releasing a Plugin</h3>
-<a name="N1018D"></a><a name="register"></a>
+<a name="N101AC"></a><a name="register"></a>
 <h4>Register the Plugin with Apache Forrest</h4>
 <div class="fixme">
 <div class="label">Fixme (rdg)</div>
@@ -594,7 +614,7 @@
 <div class="content">Describe making a request of Forrest devs for 
         inclusion</div>
 </div>
-<a name="N1019C"></a><a name="deploy"></a>
+<a name="N101BB"></a><a name="deploy"></a>
 <h4>Deploying the Plugin</h4>
 <p>To deploy the plugin so that others can use it, it must be made 
         available as a zip from the URL indicated in the 
@@ -623,29 +643,29 @@
         that your only deploy working plugins. This adds a little time to
         the deploy cycle, but we feel the peace of mind is worth it.</div>
 </div>
-<a name="N101CF"></a><a name="examples"></a>
+<a name="N101EE"></a><a name="examples"></a>
 <h3 class="underlined_5">Examples</h3>
 <p>This section will provide some example plugins to help illustrate the
       steps discussed above.</p>
-<a name="N101D8"></a><a name="input"></a>
+<a name="N101F7"></a><a name="input"></a>
 <h4>Input Plugin</h4>
 <div class="fixme">
 <div class="label">Fixme (RDG)</div>
 <div class="content">Discuss OpenOffice.org plugin here</div>
 </div>
-<a name="N101E3"></a><a name="output"></a>
+<a name="N10202"></a><a name="output"></a>
 <h4>Output Plugin</h4>
 <div class="fixme">
 <div class="label">Fixme (RDG)</div>
 <div class="content">Discuss s5 plugin here</div>
 </div>
-<a name="N101EE"></a><a name="internal"></a>
+<a name="N1020D"></a><a name="internal"></a>
 <h4>Internal Plugin</h4>
 <div class="fixme">
 <div class="label">Fixme (RDG)</div>
 <div class="content">Discuss IMSManifest plugin here</div>
 </div>
-<a name="N101FA"></a><a name="extension"></a>
+<a name="N10219"></a><a name="extension"></a>
 <h3 class="underlined_5">Further Reading</h3>
 <ul>
         
@@ -656,7 +676,7 @@
 <a href="../../pluginDocs/plugins_0_80/">Plugins Documentation</a> for users</li>
       
 </ul>
-<a name="N10210"></a><a name="summarise"></a>
+<a name="N1022F"></a><a name="summarise"></a>
 <h3 class="underlined_5">Summarise the Entire Process</h3>
 <div class="fixme">
 <div class="label">Fixme (rdg)</div>

Modified: forrest/site/docs_0_80/linking.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/linking.pdf?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/docs_0_80/primer.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/primer.pdf?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/dtdx/document-v12.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/dtdx/document-v12.pdf?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/dtdx/document-v13.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/dtdx/document-v13.pdf?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/dtdx/document-v20.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/dtdx/document-v20.pdf?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/linkmap.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/linkmap.pdf?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/live-sites.html
URL: http://svn.apache.org/viewcvs/forrest/site/live-sites.html?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
--- forrest/site/live-sites.html (original)
+++ forrest/site/live-sites.html Mon Aug  8 23:35:28 2005
@@ -334,6 +334,17 @@
 <a href="http://www.discountdracula.com/">DisCountDracula:
           bargains/deals on various products and services</a>
 </li>
+      
+<li>
+<a href="http://www.cfas.org/">Central Florida Astronomical
+          Society</a>: The Central Florida Astronomical Society, Inc.
+        (CFAS) is a 501(c)(3) organization operating in the Greater Orlando Metropolitan 
+        area and surrounding communities.</li>
+      
+<li>
+<a href="http://uml2svg.sourceforge.net/">uml2svg</a>: an
+        XSLT-based tool for converting XMI-compliant UML Diagrams into
+        SVG.</li>
 
     
 </ul>

Modified: forrest/site/live-sites.pdf
URL: http://svn.apache.org/viewcvs/forrest/site/live-sites.pdf?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/pluginDocs/plugins_0_80/pluginInfrastructure.html
URL: http://svn.apache.org/viewcvs/forrest/site/pluginDocs/plugins_0_80/pluginInfrastructure.html?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
--- forrest/site/pluginDocs/plugins_0_80/pluginInfrastructure.html (original)
+++ forrest/site/pluginDocs/plugins_0_80/pluginInfrastructure.html Mon Aug  8 23:35:28 2005
@@ -278,7 +278,11 @@
 <pre class="code">
 [plugin_name]
   |
-  |-- config files (xmap, skinconf etc.)
+  |-- plugin control files (xmap etc.)
+  |
+  |-- conf
+  |   |
+  |   `-- cocoon and component config files (e.g. *.xconf, jtidy)
   |
   |-- resources
       |
@@ -286,9 +290,9 @@
       |   |
       |   |-- catalog.xcat
       |   |
-      |   |-- dtd (DTDs etc.)
+      |   `-- dtd (DTDs etc.)
       |
-      |-- stylesheets (XSLs etc.)
+      `-- stylesheets (XSLs etc.)
 </pre>
 <a name="N100B3"></a><a name="The+IMS+Manifest+Plugin"></a>
 <h3 class="underlined_5">The IMS Manifest Plugin</h3>

Modified: forrest/site/skin/basic.css
URL: http://svn.apache.org/viewcvs/forrest/site/skin/basic.css?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
--- forrest/site/skin/basic.css (original)
+++ forrest/site/skin/basic.css Mon Aug  8 23:35:28 2005
@@ -50,22 +50,32 @@
   padding: 5px 10px;
 }
 .note .content {
-  padding: 5px 10px;
   background: #F0F0FF;
   color: black;
   line-height: 120%;
   font-size: 90%;
+  padding: 5px 10px;
 }
 .warning .label {
   background: #C00;
   color: white;
+  font-weight: bold;
+  padding: 5px 10px;
 }
 .warning .content {
   background: #FFF0F0;
   color: black;
+  line-height: 120%;
+  font-size: 90%;
+  padding: 5px 10px;
 }
 .fixme .label {
   background: #C6C600;
+  font-weight: bold;
+  padding: 5px 10px;
+}
+.fixme .content {
+  padding: 5px 10px;
 }
 
 /**

Modified: forrest/site/skin/images/rc-b-l-15-1body-2menu-3menu.png
URL: http://svn.apache.org/viewcvs/forrest/site/skin/images/rc-b-l-15-1body-2menu-3menu.png?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/skin/images/rc-b-r-15-1body-2menu-3menu.png
URL: http://svn.apache.org/viewcvs/forrest/site/skin/images/rc-b-r-15-1body-2menu-3menu.png?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/skin/images/rc-b-r-5-1header-2tab-selected-3tab-selected.png
URL: http://svn.apache.org/viewcvs/forrest/site/skin/images/rc-b-r-5-1header-2tab-selected-3tab-selected.png?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/skin/images/rc-t-l-5-1header-2searchbox-3searchbox.png
URL: http://svn.apache.org/viewcvs/forrest/site/skin/images/rc-t-l-5-1header-2searchbox-3searchbox.png?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/skin/images/rc-t-l-5-1header-2tab-selected-3tab-selected.png
URL: http://svn.apache.org/viewcvs/forrest/site/skin/images/rc-t-l-5-1header-2tab-selected-3tab-selected.png?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/skin/images/rc-t-l-5-1header-2tab-unselected-3tab-unselected.png
URL: http://svn.apache.org/viewcvs/forrest/site/skin/images/rc-t-l-5-1header-2tab-unselected-3tab-unselected.png?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/skin/images/rc-t-r-15-1body-2menu-3menu.png
URL: http://svn.apache.org/viewcvs/forrest/site/skin/images/rc-t-r-15-1body-2menu-3menu.png?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/skin/images/rc-t-r-5-1header-2searchbox-3searchbox.png
URL: http://svn.apache.org/viewcvs/forrest/site/skin/images/rc-t-r-5-1header-2searchbox-3searchbox.png?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/skin/images/rc-t-r-5-1header-2tab-selected-3tab-selected.png
URL: http://svn.apache.org/viewcvs/forrest/site/skin/images/rc-t-r-5-1header-2tab-selected-3tab-selected.png?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/skin/images/rc-t-r-5-1header-2tab-unselected-3tab-unselected.png
URL: http://svn.apache.org/viewcvs/forrest/site/skin/images/rc-t-r-5-1header-2tab-unselected-3tab-unselected.png?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
Binary files - no diff available.

Modified: forrest/site/versions/index.html
URL: http://svn.apache.org/viewcvs/forrest/site/versions/index.html?rev=230990&r1=230989&r2=230990&view=diff
==============================================================================
--- forrest/site/versions/index.html (original)
+++ forrest/site/versions/index.html Mon Aug  8 23:35:28 2005
@@ -39,8 +39,8 @@
 <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 class="current">
+<a class="base-selected" href="../versions/index.html">Versioned Docs</a>
 </li>
 <li>
 <a class="base-not-selected" href="../pluginDocs/index.html">Plugins</a>



Mime
View raw message