forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r354312 [16/17] - in /forrest/site: ./ docs_0_60/ docs_0_60/howto/ docs_0_60/howto/bugzilla-patch/ docs_0_70/ docs_0_70/howto/ docs_0_70/howto/cvs-ssh/ docs_0_80/ docs_0_80/howto/ docs_0_80/howto/cvs-ssh/ dtdx/ pluginDocs/plugins_0_70/ plug...
Date Tue, 06 Dec 2005 04:57:22 GMT
Modified: forrest/site/docs_0_80/primer.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/primer.html?rev=354312&r1=354311&r2=354312&view=diff
==============================================================================
--- forrest/site/docs_0_80/primer.html (original)
+++ forrest/site/docs_0_80/primer.html Mon Dec  5 20:55:03 2005
@@ -447,9 +447,9 @@
 <div class="label">Note</div>
 <div class="content">This process is not quite ready for prime time yet, but it gives
         you an idea where we are heading to. Website generation with skins currently
-        works, try using the <span class="codefrag">docs</span> target when invoking the
-        <span class="codefrag">build</span> script. Add a <span class="codefrag">project.skin</span> property when invoking
-        the build script to experience Forrest skins: <span class="codefrag">build{.bat|.sh}
+        works, try using the <span class="codefrag ">docs</span> target when invoking the
+        <span class="codefrag ">build</span> script. Add a <span class="codefrag ">project.skin</span> property when invoking
+        the build script to experience Forrest skins: <span class="codefrag ">build{.bat|.sh}
           -Dproject.skin=&lt;thenameoftheskintouse&gt; docs</span>. Read our
         <a href="#cvs">CVS crash course</a> to get hold of the current codebase and
         start playing with it.</div>
@@ -579,7 +579,7 @@
 <li>Click on Admin-&gt;Preferences;</li> 
           
 <li> In "Enter the CVSROOT:" enter
-            "<span class="codefrag">:pserver:anoncvs@cvs.apache.org:/home/cvspublic</span>" (without
+            "<span class="codefrag ">:pserver:anoncvs@cvs.apache.org:/home/cvspublic</span>" (without
             quotes);</li> 
           
 <li>In "Authentication:" choose "passwd file on the cvs server";</li> 
@@ -588,12 +588,12 @@
           
 <li>Click Admin-&gt;Login;</li> 
           
-<li> When asked for the password: answer "<span class="codefrag">anoncvs</span>"
+<li> When asked for the password: answer "<span class="codefrag ">anoncvs</span>"
             (without quotes);</li> 
           
 <li> Click "Create-&gt;Checkout module";</li> 
           
-<li>Module name and path on the server is "<span class="codefrag">xml-forrest</span>"
+<li>Module name and path on the server is "<span class="codefrag ">xml-forrest</span>"
             (no quotes);</li> 
           
 <li>Choose a dir to put the source code in;</li> 
@@ -603,7 +603,7 @@
 <li>If everything goes well, messages will start to appear in the log
             window;</li> 
           
-<li>Wait until you see "<span class="codefrag">*****CVS exited normally with code
+<li>Wait until you see "<span class="codefrag ">*****CVS exited normally with code
               0*****</span>" in the log window;</li> 
           
 <li>The Forrest source is now on your harddrive.</li> 
@@ -618,15 +618,15 @@
           
 <li>Start the shell of your choice.</li> 
           
-<li>Enter "<span class="codefrag">cvs -d
+<li>Enter "<span class="codefrag ">cvs -d
               :pserver:anoncvs@cvs.apache.org:/home/cvspublic login</span>".</li> 
           
-<li>When asked for the password: answer "<span class="codefrag">anoncvs</span>".</li> 
+<li>When asked for the password: answer "<span class="codefrag ">anoncvs</span>".</li> 
           
-<li>Enter "<span class="codefrag">cvs -d
+<li>Enter "<span class="codefrag ">cvs -d
               :pserver:anoncvs@cvs.apache.org:/home/cvspublic -z3 checkout
               xml-forrest</span>". This will create a directory called
-            "<span class="codefrag">xml-forrest</span>" where the Forrest source will be stored.</li> 
+            "<span class="codefrag ">xml-forrest</span>" where the Forrest source will be stored.</li> 
           
 <li>Wait until cvs has finished.</li> 
           
@@ -634,15 +634,15 @@
         
 </ol>
 <p>In case you want to update your Forrest source tree to the current
-          version, change to the "<span class="codefrag">xml-forrest</span>" directory and invoke
-          "<span class="codefrag">cvs -z3 update -d -P</span>".</p>
+          version, change to the "<span class="codefrag ">xml-forrest</span>" directory and invoke
+          "<span class="codefrag ">cvs -z3 update -d -P</span>".</p>
 </div> 
     
 <a name="N1017F"></a><a name="Forrest+distribution"></a>
 <h2 class="underlined_10">Forrest distribution</h2>
 <div class="section">
 <p>Once you retrieved Forrest from its CVS repository, you will end up
-        with a filesystem hierarchy similar to this inside the <span class="codefrag">xml-forrest</span>
+        with a filesystem hierarchy similar to this inside the <span class="codefrag ">xml-forrest</span>
         home directory:</p>
 <div class="warning">
 <div class="label">Warning</div>
@@ -691,34 +691,34 @@
     +---ant                         Ant 1.6-dev scripts and jars
 +---stylesheets                     Stylesheets used for project root XML files
 </pre>
-<p>The <span class="codefrag">xml-forrest</span> home directory consists of the main Ant
-        build script (<span class="codefrag">build.xml</span>) and platform-specific batch files/shell
+<p>The <span class="codefrag ">xml-forrest</span> home directory consists of the main Ant
+        build script (<span class="codefrag ">build.xml</span>) and platform-specific batch files/shell
         scripts to invoke it. Forrest comes with Ant included, so you do not need to
         install Ant separately.</p>
 <p>Running Forrest is a batch operation you can start using the provided
-        <span class="codefrag">build.{sh|bat} &lt;targetname&gt;</span>. The current main targets
+        <span class="codefrag ">build.{sh|bat} &lt;targetname&gt;</span>. The current main targets
         are:</p>
 <ul> 
         
 <li>
-<strong><span class="codefrag">docs</span></strong> - generates an HTML rendition of
-          the Forrest website using the default <span class="codefrag">forrest-site</span> skin</li> 
+<strong><span class="codefrag ">docs</span></strong> - generates an HTML rendition of
+          the Forrest website using the default <span class="codefrag ">forrest-site</span> skin</li> 
         
 <li>
-<strong><span class="codefrag">clean</span></strong> - cleans out the
-          <span class="codefrag">build</span> directory</li> 
+<strong><span class="codefrag ">clean</span></strong> - cleans out the
+          <span class="codefrag ">build</span> directory</li> 
         
 <li>
-<strong><span class="codefrag">webapp</span></strong> - for those who cannot resist
+<strong><span class="codefrag ">webapp</span></strong> - for those who cannot resist
           running Forrest live instead of its commandline invocation, this target builds
           a WAR file you can deploy in your servlet container (currently only tested for
           Tomcat 4.0.1). Mount-point of the web application will be
-          <span class="codefrag">xml-forrest</span>.</li> 
+          <span class="codefrag ">xml-forrest</span>.</li> 
       
 </ul>
-<p>After a build run, Forrest creates a <span class="codefrag">build</span> directory. You
-        can find the generated website in the <span class="codefrag">build/xml-forrest/docs/</span>
-        directory. Forrest also creates a <span class="codefrag">tools/tmp/anttasks/</span> upon its
+<p>After a build run, Forrest creates a <span class="codefrag ">build</span> directory. You
+        can find the generated website in the <span class="codefrag ">build/xml-forrest/docs/</span>
+        directory. Forrest also creates a <span class="codefrag ">tools/tmp/anttasks/</span> upon its
         first invocation. These are Centipede-specific compiled Ant tasks.</p>
 </div> 
     
@@ -733,30 +733,30 @@
         mechanism, extensive use of external parameter entities and an entity resolver
         capable of resolving entities through the aforementioned catalog mechanism. For
         the docheads amongst us, this means we adhere to the strict use of
-        <span class="codefrag">PUBLIC</span> entity identifiers both in document instances and DTD
+        <span class="codefrag ">PUBLIC</span> entity identifiers both in document instances and DTD
         modules.</p>
 <p>We have currently identified the following document types:</p>
 <ul> 
         
-<li>General documents (<span class="codefrag">document-v11.dtd</span>),</li> 
+<li>General documents (<span class="codefrag ">document-v11.dtd</span>),</li> 
         
-<li>How-Tos (<span class="codefrag">howto-v10.dtd</span>),</li> 
+<li>How-Tos (<span class="codefrag ">howto-v10.dtd</span>),</li> 
         
-<li>Collections of FAQs (<span class="codefrag">faq-v11.dtd)</span>.</li> 
+<li>Collections of FAQs (<span class="codefrag ">faq-v11.dtd)</span>.</li> 
       
 </ul>
 <p>Some work is also under its way for other document types, in close
         collaboration with the Cocoon project. You will also find some older document
-        types such as <span class="codefrag">changes</span>, <span class="codefrag">javadoc</span>,
-        <span class="codefrag">specification</span> and <span class="codefrag">todo</span>, which are currently under
+        types such as <span class="codefrag ">changes</span>, <span class="codefrag ">javadoc</span>,
+        <span class="codefrag ">specification</span> and <span class="codefrag ">todo</span>, which are currently under
         consideration for automatic generation and maintenance using Gump or Centipede
         descriptors and the like. DTDs will be subject of serious version management as
         soon as Forrest has a 1.0 release: they are made to depend upon.</p>
-<p>The DTDs are located in <span class="codefrag">src/resources/schema/dtd</span> and also
+<p>The DTDs are located in <span class="codefrag ">src/resources/schema/dtd</span> and also
         refer to some character entity collections stored in the
-        <span class="codefrag">src/resources/schema/entity</span> directory. These are referred to by
-        the declarations found in the <span class="codefrag">src/resources/schema/catalog</span> OASIS
-        Catalog file. Take special care using the correct <span class="codefrag">PUBLIC</span>
+        <span class="codefrag ">src/resources/schema/entity</span> directory. These are referred to by
+        the declarations found in the <span class="codefrag ">src/resources/schema/catalog</span> OASIS
+        Catalog file. Take special care using the correct <span class="codefrag ">PUBLIC</span>
         identifiers in the DTD declaration of your instances:</p>
 <pre class="code">&lt;?xml version="1.0"?&gt;
 &lt;!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.2//EN" "http://apache.org/forrest/dtd/document-v12.dtd"&gt;
@@ -765,7 +765,7 @@
   </pre>
 <p>The exact local location of the DTD for validation purposes is
         obtained by the entity resolver evaluating the mapping scheme as defined in the
-        <span class="codefrag">catalog</span> file. This makes sure that you can move and re-arrange
+        <span class="codefrag ">catalog</span> file. This makes sure that you can move and re-arrange
         your document instances apart from your DTD files. Later on, the DTDs will be
         web-accessible from the Forrest website for your perusal.</p>
 </div> 
@@ -773,7 +773,7 @@
 <a name="N1021D"></a><a name="sitemap"></a>
 <h2 class="underlined_10">Forrest site generation using Cocoon</h2>
 <div class="section">
-<p>The <span class="codefrag">docs</span> target of the Forrest build environment invokes
+<p>The <span class="codefrag ">docs</span> target of the Forrest build environment invokes
         Cocoon as a command-line application to generate an HTML rendition of the
         project's documentation. It is not within the scope of this document to explain
         the Cocoon internals, please read its own
@@ -791,7 +791,7 @@
         transformed by a different XSLT stylesheet, aggregated by Cocoon with a
         post-aggregation stylesheet adding the overall page grid and look &amp; feel.
         This simple example is handled by the following <em>sitemap</em> snippets
-        (<span class="codefrag">src/documentation/conf/sitemap.xmap</span>):</p>
+        (<span class="codefrag ">src/documentation/conf/sitemap.xmap</span>):</p>
 <pre class="code">&lt;map:match pattern="*.html"&gt;
   &lt;map:aggregate element="site"&gt;
     &lt;map:part src="cocoon:/book-{1}.xml"/&gt;
@@ -820,63 +820,63 @@
   &lt;map:serialize/&gt;
 &lt;/map:resource&gt;</pre>
 <p>When an URL (e.g.
-        <span class="codefrag">http://forrest.apache.org/index.html</span>) is passed through the
+        <span class="codefrag ">http://forrest.apache.org/index.html</span>) is passed through the
         Cocoon system to generate the required page, the pipeline flow is basically as
         follows:</p>
 <ol> 
         
-<li>The URL is matched by the <span class="codefrag">*.html</span> pattern</li> 
+<li>The URL is matched by the <span class="codefrag ">*.html</span> pattern</li> 
         
 <li>Cocoon responds by aggregating two 'sub-requests'. The first is for
-          the resource <span class="codefrag">book-{1}.xml</span>, the second is for the resource
-          <span class="codefrag">body-{1}.xml</span>. The <span class="codefrag">{1}</span> parameter is replaced by the
+          the resource <span class="codefrag ">book-{1}.xml</span>, the second is for the resource
+          <span class="codefrag ">body-{1}.xml</span>. The <span class="codefrag ">{1}</span> parameter is replaced by the
           values of the first wildcard in the matching pattern above. These
           'sub-requests' are passed through the Cocoon pipeline just like any other
           request. This results in the following flow:</li> 
         
 <ol> 
           
-<li>The first 'sub-request' (for <span class="codefrag">book-index.xml</span> is matched
-            by the <span class="codefrag">**book-**.xml</span> pattern. This results in the file
-            <span class="codefrag">content/xdocs/book.xml</span> being read. This document is then run
-            through the <span class="codefrag">book2menu</span> stylesheet (which produces an HTML fragment
+<li>The first 'sub-request' (for <span class="codefrag ">book-index.xml</span> is matched
+            by the <span class="codefrag ">**book-**.xml</span> pattern. This results in the file
+            <span class="codefrag ">content/xdocs/book.xml</span> being read. This document is then run
+            through the <span class="codefrag ">book2menu</span> stylesheet (which produces an HTML fragment
             comprising the site navigation, the red area in the image above.</li> 
           
-<li>The second 'sub-request' is matched by the <span class="codefrag">body-**.xml</span>
-            pattern. This results in the file <span class="codefrag">index.xml</span> being transformed
-            using the <span class="codefrag">document2html</span> stylesheet, the yellow area in the
+<li>The second 'sub-request' is matched by the <span class="codefrag ">body-**.xml</span>
+            pattern. This results in the file <span class="codefrag ">index.xml</span> being transformed
+            using the <span class="codefrag ">document2html</span> stylesheet, the yellow area in the
             screenshot.</li> 
         
 </ol> 
         
 <li>The aggregation result is then transformed using the
-          <span class="codefrag">site2xhtml</span> stylesheet which adds the cherries to the cake. The
+          <span class="codefrag ">site2xhtml</span> stylesheet which adds the cherries to the cake. The
           grey zone.</li> 
       
 </ol>
 <p>These <em>skin-specific</em> stylesheets are located in
-        <span class="codefrag">src/documentation/skins/&lt;nameoftheskin&gt;/xslt/html</span>, so if you
+        <span class="codefrag ">src/documentation/skins/&lt;nameoftheskin&gt;/xslt/html</span>, so if you
         want to add your own skin, this is the place to be. Apart from these, there
         exist a number of other stylesheets located in
-        <span class="codefrag">src/documentation/library/xslt</span> and more importantly:</p>
+        <span class="codefrag ">src/documentation/library/xslt</span> and more importantly:</p>
 <ul> 
         
 <li>
-<span class="codefrag">faq2document</span>: transforms documents following the
-          <span class="codefrag">faq-v11</span> DTD to <span class="codefrag">document-v11</span> grammar</li> 
+<span class="codefrag ">faq2document</span>: transforms documents following the
+          <span class="codefrag ">faq-v11</span> DTD to <span class="codefrag ">document-v11</span> grammar</li> 
         
 <li>
-<span class="codefrag">howto2document</span>: transforms documents following the
-          <span class="codefrag">howto-v10</span> DTD to <span class="codefrag">document-v11</span> grammar</li> 
+<span class="codefrag ">howto2document</span>: transforms documents following the
+          <span class="codefrag ">howto-v10</span> DTD to <span class="codefrag ">document-v11</span> grammar</li> 
         
 <li>and some others.</li> 
       
 </ul>
 <p>As you see, all documents, regardless of their original DTD, are
-        transformed to the <span class="codefrag">document</span> DTD prior to rendition. This
+        transformed to the <span class="codefrag ">document</span> DTD prior to rendition. This
         alleviates the burden of adding new skins to implementing 3 simple stylesheets:
-        <span class="codefrag">book2menu</span>, <span class="codefrag">document2html</span> and
-        <span class="codefrag">site2xhtml</span>.</p>
+        <span class="codefrag ">book2menu</span>, <span class="codefrag ">document2html</span> and
+        <span class="codefrag ">site2xhtml</span>.</p>
 </div> 
     
 <a name="N102CC"></a><a name="Where+we+are+heading+to"></a>
@@ -919,7 +919,7 @@
           
 <th colspan="1" rowspan="1">Skins</th> 
           <td colspan="1" rowspan="1">We currently have a nice set of skins which should be solidified.
-            Furthermore, we need some serious finetuning of the <span class="codefrag">forrest-site</span>
+            Furthermore, we need some serious finetuning of the <span class="codefrag ">forrest-site</span>
             skin that will become the new xml.apache.org look&amp;feel.</td> 
         
 </tr> 
@@ -940,7 +940,7 @@
           
 <th colspan="1" rowspan="1">Build Management</th> 
           <td colspan="1" rowspan="1">Fool-proof automation of Forrest runs and site publication using
-            secure transfer methods and <span class="codefrag">cron</span> jobs.</td> 
+            secure transfer methods and <span class="codefrag ">cron</span> jobs.</td> 
         
 </tr> 
         

Modified: forrest/site/docs_0_80/project-sitemap.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/project-sitemap.html?rev=354312&r1=354311&r2=354312&view=diff
==============================================================================
--- forrest/site/docs_0_80/project-sitemap.html (original)
+++ forrest/site/docs_0_80/project-sitemap.html Mon Dec  5 20:55:03 2005
@@ -375,7 +375,7 @@
 <a name="N10029"></a><a name="how"></a>
 <h2 class="underlined_10">How does it work?</h2>
 <div class="section">
-<p>If a project has a <span class="codefrag">sitemap.xmap</span> file in it's 
+<p>If a project has a <span class="codefrag ">sitemap.xmap</span> file in it's 
       documentation dir, that gets mounted automatically by Forrest and 
       becomes part of the processing: it is a preprocessing step, and 
       is the first one to handle the request. Because of this it can 

Modified: forrest/site/docs_0_80/searching.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/searching.html?rev=354312&r1=354311&r2=354312&view=diff
==============================================================================
--- forrest/site/docs_0_80/searching.html (original)
+++ forrest/site/docs_0_80/searching.html Mon Dec  5 20:55:03 2005
@@ -369,15 +369,15 @@
 	functionality is implemented on Google's end, you do not need
 	any additional capability on your Forrest server (which may
 	well be a simple static web server serving content generated
-	with <span class="codefrag">forrest site</span>).</p>
+	with <span class="codefrag ">forrest site</span>).</p>
 <p>To use Google SiteSearch in your Forrest application, open
-	your <span class="codefrag">skinconf.xml</span> file. By default this file is
-	in the <span class="codefrag">src/documentation</span> subdirectory of your
-	Forrest repository root. Find the <span class="codefrag">&lt;search&gt;</span>
+	your <span class="codefrag ">skinconf.xml</span> file. By default this file is
+	in the <span class="codefrag ">src/documentation</span> subdirectory of your
+	Forrest repository root. Find the <span class="codefrag ">&lt;search&gt;</span>
 	element; it should be near the top of the file. If the element
 	does not exist, create it below the
-	<span class="codefrag">&lt;skinconfig&gt;</span> opening tag. If there is any
-	attribute named <span class="codefrag">provider</span>, remove it. The element
+	<span class="codefrag ">&lt;skinconfig&gt;</span> opening tag. If there is any
+	attribute named <span class="codefrag ">provider</span>, remove it. The element
 	should look similar to this:</p>
 <pre class="code">&lt;search name="MyProject"
 	domain="myproject.com"/&gt;</pre>
@@ -402,26 +402,26 @@
 	entirely in Java. To use Lucene-based search with your Forrest
 	documentation, you will need to run Forrest in a Java servlet
 	environment (such as Tomcat or Jetty). Lucene-based searching
-	will not work in a static site generated with the '<span class="codefrag">forrest
+	will not work in a static site generated with the '<span class="codefrag ">forrest
 	  site</span>' command.</p>
 <p>In order to enable Lucene-based full-text search in your
 	Forrest application, you must first edit your
-	<span class="codefrag">skinconf.xml</span> file. Locate the
-	<span class="codefrag">&lt;search&gt;</span> element. If the element does not
+	<span class="codefrag ">skinconf.xml</span> file. Locate the
+	<span class="codefrag ">&lt;search&gt;</span> element. If the element does not
 	exist, insert it right underneath the
-	<span class="codefrag">&lt;skinconfig&gt;</span> opening tag. Add an attribute
-	named <span class="codefrag">provider</span> with a value of
-	<span class="codefrag">lucene</span>, so that the element looks similar to
+	<span class="codefrag ">&lt;skinconfig&gt;</span> opening tag. Add an attribute
+	named <span class="codefrag ">provider</span> with a value of
+	<span class="codefrag ">lucene</span>, so that the element looks similar to
 	this:</p>
 <pre class="code">&lt;search name="MyProject" domain="myproject.com"
 	provider="lucene"/&gt;</pre>
 <p>Next, create and run your Forrest webapp. This may mean
-	simply invoking <span class="codefrag">forrest run</span>, or building and
-	bundling a servlet webapp (with <span class="codefrag">forrest webapp</span>),
+	simply invoking <span class="codefrag ">forrest run</span>, or building and
+	bundling a servlet webapp (with <span class="codefrag ">forrest webapp</span>),
 	and then deploying it to your servlet container.</p>
 <p>You can now build a Lucene search index by pointing your web
 	browser at
-	<span class="codefrag">http://localhost:8888/lucene-update.html</span>. This
+	<span class="codefrag ">http://localhost:8888/lucene-update.html</span>. This
 	generates the search index and provides some information about
 	the index generation process.</p>
 <div class="note">
@@ -429,7 +429,7 @@
 <div class="content">You may have to substitute a different hostname, port, or
 	path, depending on your configuration. The path mentioned here
 	reflects Forrest's default settings when invoked as
-	<span class="codefrag">forrest run</span>.</div>
+	<span class="codefrag ">forrest run</span>.</div>
 </div>
 <p>Now you can utilize the full-text search box, located in the
 	top-right corner of the rendered Forrest pages. Search results
@@ -456,8 +456,8 @@
 	usable servlet-capable web server at your disposal (meaning
 	you can't use Lucene, either).</p>
 <p>To disable full-text search completely, open the
-	<span class="codefrag">skinconf.xml</span> file and remove (or comment out) the
-	entire <span class="codefrag">&lt;search&gt;</span> element.</p>
+	<span class="codefrag ">skinconf.xml</span> file and remove (or comment out) the
+	entire <span class="codefrag ">&lt;search&gt;</span> element.</p>
 </div>
   
 </div>

Modified: forrest/site/docs_0_80/sitemap-ref.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/sitemap-ref.html?rev=354312&r1=354311&r2=354312&view=diff
==============================================================================
--- forrest/site/docs_0_80/sitemap-ref.html (original)
+++ forrest/site/docs_0_80/sitemap-ref.html Mon Dec  5 20:55:03 2005
@@ -443,18 +443,18 @@
       </p>
 <p>
         You can add pre-processing sitemaps to your project
-        <span class="codefrag">src/documentation</span> directory (or wherever
-        <span class="codefrag">${project.sitemap-dir}</span> points to). Any match that
+        <span class="codefrag ">src/documentation</span> directory (or wherever
+        <span class="codefrag ">${project.sitemap-dir}</span> points to). Any match that
         is not handled, passes through to be handled by the default Forrest
         sitemaps - obviously extremely powerful. The capability is described
         in 
         "<a href="../docs_0_80/project-sitemap.html">Using project sitemaps</a>".
       </p>
 <p>
-        Another way to experiment with the sitemap is to do '<span class="codefrag">forrest
+        Another way to experiment with the sitemap is to do '<span class="codefrag ">forrest
         run</span>' on a Forrest-using site.  Changes to the core
-        <span class="codefrag">*.xmap</span> files will now be immediately visible
-        at <span class="codefrag">&gt;http://localhost:8888/</span>
+        <span class="codefrag ">*.xmap</span> files will now be immediately visible
+        at <span class="codefrag ">&gt;http://localhost:8888/</span>
       
 </p>
 </div>
@@ -519,7 +519,7 @@
 <tr>
           
 <th colspan="1" rowspan="1">raw.xmap</th>
-          <td colspan="1" rowspan="1">Serves files located in <span class="codefrag">src/documentation/content/xdocs</span>
+          <td colspan="1" rowspan="1">Serves files located in <span class="codefrag ">src/documentation/content/xdocs</span>
             that are not to be modified by Forrest.</td>
         
 </tr>
@@ -544,7 +544,7 @@
 <th colspan="1" rowspan="1">status.xmap</th>
           <td colspan="1" rowspan="1">Generates <a href="../docs_0_80/changes.html">changes</a> and 
           <a href="../docs_0_80/todo.html">todo</a> pages from a single
-            <span class="codefrag">status.xml</span> in the project root.
+            <span class="codefrag ">status.xml</span> in the project root.
           </td>
         
 </tr>
@@ -616,14 +616,14 @@
         format.
       </p>
 <p>
-        Source pipelines always have a "<span class="codefrag">.xml</span>" extension.
+        Source pipelines always have a "<span class="codefrag ">.xml</span>" extension.
         Thus, 
         <a href="index.xml">index.xml</a> gives you the XML source for the
         index page.  Likewise, <a href="faq.xml">faq.xml</a> gives you XML
         for the FAQ (transformed from FAQ syntax), and 
         <a href="changes.xml">changes.xml</a> returns XML from the status.xml file.
-        Take any page, and replace its extension (<span class="codefrag">.html</span> or
-        <span class="codefrag">.pdf</span>) with <span class="codefrag">.xml</span> and you'll have the Source
+        Take any page, and replace its extension (<span class="codefrag ">.html</span> or
+        <span class="codefrag ">.pdf</span>) with <span class="codefrag ">.xml</span> and you'll have the Source
         XML.
       </p>
 <p>
@@ -648,8 +648,8 @@
 <h3 class="underlined_5">forrest.xmap</h3>
 <p>
           Most of the usual Source pipelines are defined in
-          <span class="codefrag">forrest.xmap</span> which is the default (fallback) handler for
-          <span class="codefrag">**.xml</span> pages. The forrest.xmap uses the 
+          <span class="codefrag ">forrest.xmap</span> which is the default (fallback) handler for
+          <span class="codefrag ">**.xml</span> pages. The forrest.xmap uses the 
           <a href="../docs_0_80/cap.html">SourceTypeAction</a> to determine the type of XML
           it is processing, and converts it to document-v13 if necessary.
         </p>
@@ -669,8 +669,8 @@
 <a name="N10175"></a><a name="other_source"></a>
 <h3 class="underlined_5">Other source pipelines</h3>
 <p>As mentioned above, all non-core Source pipelines are distributed in
-          independent <span class="codefrag">*.xmap</span> files.  There is a block of
-          <span class="codefrag">sitemap.xmap</span> which simply delegates certain requests to
+          independent <span class="codefrag ">*.xmap</span> files.  There is a block of
+          <span class="codefrag ">sitemap.xmap</span> which simply delegates certain requests to
           these subsitemaps:</p>
 <pre class="code">
       &lt;!-- Body content --&gt;
@@ -707,14 +707,14 @@
             specific about which URLs it handles, and relies on the caller (the
             section listed above) to only pass relevant requests to it.  We term
             this "binding a URL" to a pipeline.</p>
-<p>For instance, the main pipeline in <span class="codefrag">faq.xmap</span> matches
-            <span class="codefrag">**.xml</span>, but only <span class="codefrag">**faq.xml</span> requests are
+<p>For instance, the main pipeline in <span class="codefrag ">faq.xmap</span> matches
+            <span class="codefrag ">**.xml</span>, but only <span class="codefrag ">**faq.xml</span> requests are
             sent to it.</p>
 <p>This "late binding" is useful, because the whole URL space is
-            managed in <span class="codefrag">sitemap.xmap</span> and not spread over lots of
-            *.xmap files.  For instance, say you wish all <span class="codefrag">*.xml</span>
-            inside a "<span class="codefrag">faq/</span>" directory to be processed as FAQs.  Just
-            override <span class="codefrag">sitemap.xmap</span> and redefine the relevant source
+            managed in <span class="codefrag ">sitemap.xmap</span> and not spread over lots of
+            *.xmap files.  For instance, say you wish all <span class="codefrag ">*.xml</span>
+            inside a "<span class="codefrag ">faq/</span>" directory to be processed as FAQs.  Just
+            override <span class="codefrag ">sitemap.xmap</span> and redefine the relevant source
             matcher:</p>
 <pre class="code">
         &lt;map:match pattern="**faq.xml"&gt;
@@ -727,7 +727,7 @@
 <h2 class="underlined_10">Output pipelines</h2>
 <div class="section">
 <p>
-        To recap, we now have a <span class="codefrag">*.xml</span> pipeline defined for each
+        To recap, we now have a <span class="codefrag ">*.xml</span> pipeline defined for each
         page in the site, emitting standardized XML.  These pipeline definitions
         are located in various *.xmap files, notably forrest.xmap
       </p>
@@ -741,7 +741,7 @@
           Easiest case first; PDFs don't require menus or headers, so we can
           simply transform our intermediate format into XSL:FO, and from there
           to PDF.  This is done by the following matcher in
-          <span class="codefrag">sitemap.xmap</span> ...
+          <span class="codefrag ">sitemap.xmap</span> ...
         </p>
 <pre class="code">
 1   &lt;map:match type="regexp" pattern="^(.*?)([^/]*).pdf$"&gt;
@@ -758,11 +758,11 @@
 <ol>
           
 <li>The first line uses a matching regexp to break the URL into
-            directory <span class="codefrag">(.*?)</span> and filename
-            <span class="codefrag">([^/]*)</span> parts.</li>
+            directory <span class="codefrag ">(.*?)</span> and filename
+            <span class="codefrag ">([^/]*)</span> parts.</li>
           
 <li>We then generate XML from a <a href="#source_pipelines">Source
-              pipeline</a>, with the URL <span class="codefrag">cocoon:/{1}{2}.xml</span>
+              pipeline</a>, with the URL <span class="codefrag ">cocoon:/{1}{2}.xml</span>
 </li>
           
 <li>We then expand any XInclude statements..</li>
@@ -778,8 +778,8 @@
 <h3 class="underlined_5">HTML output</h3>
 <p>Generating HTML pages is more complicated, because we have to merge
           the page body with a menu and tabs, and then add a header and footer.
-          Here is the <span class="codefrag">*.html</span> matcher in
-          <span class="codefrag">sitemap.xmap</span> ...</p>
+          Here is the <span class="codefrag ">*.html</span> matcher in
+          <span class="codefrag ">sitemap.xmap</span> ...</p>
 <pre class="code">
           &lt;map:match pattern="*.html"&gt;
             &lt;map:aggregate element="site"&gt;
@@ -798,7 +798,7 @@
           aggregating <a href="body-index.html">body-index.html</a> and
           <a href="menu-index.html">menu-index.html</a> and 
           <a href="tab-index.html">tab-index.html</a> and then applying the
-          <span class="codefrag">site2xhtml.xsl</span> stylesheet to the result.
+          <span class="codefrag ">site2xhtml.xsl</span> stylesheet to the result.
         </p>
 <p>
           There is a nearly identical matcher for HTML files in subdirectories:
@@ -849,7 +849,7 @@
 <li>
             
 <p>We then apply a custom-written
-              <span class="codefrag">IdGeneratorTransformer</span>, which ensures that every
+              <span class="codefrag ">IdGeneratorTransformer</span>, which ensures that every
               &lt;section&gt; has an "id" attribute if one is not supplied, by generating one from the
               &lt;title&gt; if necessary.  For example, &lt;idgen&gt; will
               transform:</p>
@@ -868,9 +868,9 @@
               ...
             </pre>
             
-<p>Later, the <span class="codefrag">document2html.xsl</span> stylesheet will create
+<p>Later, the <span class="codefrag ">document2html.xsl</span> stylesheet will create
               an &lt;a name&gt; element for every section, allowing this section to
-              be referred to as <span class="codefrag">index.html#How+to+boil+eggs</span>.</p>
+              be referred to as <span class="codefrag ">index.html#How+to+boil+eggs</span>.</p>
           
 </li>
           
@@ -885,7 +885,7 @@
 </ol>
 <a name="N10291"></a><a name="menu_pipeline"></a>
 <h3 class="underlined_5">Page menu</h3>
-<p>In the <span class="codefrag">sitemap.xmap</span> file, the matcher generating HTML for the menu is:</p>
+<p>In the <span class="codefrag ">sitemap.xmap</span> file, the matcher generating HTML for the menu is:</p>
 <pre class="code">
       &lt;map:match pattern="**menu-*.html"&gt;
         &lt;map:generate src="cocoon:/{1}book-{2}.html"/&gt;
@@ -898,7 +898,7 @@
       </pre>
 <p>We get XML from a "book" pipeline, 
         <a href="#linkrewriting_impl">rewrite links</a>, and apply the
-          <span class="codefrag">book2menu.xsl</span> stylesheet to generate HTML.</p>
+          <span class="codefrag ">book2menu.xsl</span> stylesheet to generate HTML.</p>
 <p>How the menu XML is actually generated (the *book-*.html pipeline) is
           sufficiently complex to require a 
           <a href="#menu_generation_impl">section of its own</a>.</p>
@@ -915,23 +915,23 @@
        &lt;/map:call&gt;
      &lt;/map:match&gt;
            </pre>
-<p>All the smarts are in the <span class="codefrag">tab2menu.xsl</span> stylesheet, which
+<p>All the smarts are in the <span class="codefrag ">tab2menu.xsl</span> stylesheet, which
           needs to choose the correct tab based on the current path.  Currently,
           a "longest matching path" algorithm is implemented.  See the
-          <span class="codefrag">tab2menu.xsl</span> stylesheet for details.</p>
+          <span class="codefrag ">tab2menu.xsl</span> stylesheet for details.</p>
 </div>
 
     
 <a name="N102D3"></a><a name="menu_generation_impl"></a>
 <h2 class="underlined_10">Menu XML generation</h2>
 <div class="section">
-<p>The "book" pipeline is defined in <span class="codefrag">sitemap.xmap</span>as:</p>
+<p>The "book" pipeline is defined in <span class="codefrag ">sitemap.xmap</span>as:</p>
 <pre class="code">
         &lt;map:match pattern="**book-*.html"&gt;
           &lt;map:mount uri-prefix="" src="menu.xmap" check-reload="yes" /&gt;
         &lt;/map:match&gt;
         </pre>
-<p>Meaning that it is defined in the <span class="codefrag">menu.xmap</span> file.  In there we find
+<p>Meaning that it is defined in the <span class="codefrag ">menu.xmap</span> file.  In there we find
         the real definition, which is quite complicated, because there are three
         supported menu systems (see <a href="../docs_0_80/linking.html">menus and
           linking</a>).  We will not go through the sitemap itself
@@ -942,7 +942,7 @@
           root-relative.</li>
         
 <li>
-<p>Depending on the <span class="codefrag">forrest.menu-scheme</span> property, we
+<p>Depending on the <span class="codefrag ">forrest.menu-scheme</span> property, we
             now apply one of the two algorithms for choosing a set of menu links
             (described in <a href="../docs_0_80/linking.html#menu_generation">menu
               generation</a>):</p>
@@ -960,12 +960,12 @@
               
 <p>
                 For example, say our current page's path is
-                <span class="codefrag">community/howto/index.html</span>.  In
-                <span class="codefrag">site.xml</span> we look for the node with this
-                "<span class="codefrag">href</span>" and discover its "<span class="codefrag">tab</span>" attribute
-                value is "<span class="codefrag">howtos</span>".  We then prune the
-                <span class="codefrag">site.xml</span>-derived content to contain only nodes with
-                <span class="codefrag">tab="howtos"</span>.
+                <span class="codefrag ">community/howto/index.html</span>.  In
+                <span class="codefrag ">site.xml</span> we look for the node with this
+                "<span class="codefrag ">href</span>" and discover its "<span class="codefrag ">tab</span>" attribute
+                value is "<span class="codefrag ">howtos</span>".  We then prune the
+                <span class="codefrag ">site.xml</span>-derived content to contain only nodes with
+                <span class="codefrag ">tab="howtos"</span>.
               </p>
               
 <p>
@@ -985,7 +985,7 @@
 <li>
               
 <p>For "directory" menu generation, we simply use an
-                <span class="codefrag">XPathTransformer</span> to include only pages in the
+                <span class="codefrag ">XPathTransformer</span> to include only pages in the
                 current page's directory, or below:</p>
               
 <pre class="code">
@@ -995,10 +995,10 @@
                 </pre>
               
 <p>
-                Here, the "<span class="codefrag">{1}</span>" is the directory part of the current
+                Here, the "<span class="codefrag ">{1}</span>" is the directory part of the current
                 page.  So if our current page is
-                <span class="codefrag">community/howto/index.html</span> then "<span class="codefrag">{1}</span>" will
-                be <span class="codefrag">community/howto/</span> and the transformer will
+                <span class="codefrag ">community/howto/index.html</span> then "<span class="codefrag ">{1}</span>" will
+                be <span class="codefrag ">community/howto/</span> and the transformer will
                 include all nodes in that directory.
               </p>
             
@@ -1006,18 +1006,18 @@
           
 </ul>
           
-<p>We now have a <span class="codefrag">site.xml</span> subset relevant to our current
+<p>We now have a <span class="codefrag ">site.xml</span> subset relevant to our current
             page.</p>
         
 </li>
         
-<li>The "<span class="codefrag">href</span>" nodes in this are then made relative to the
+<li>The "<span class="codefrag ">href</span>" nodes in this are then made relative to the
           current page.</li>
         
-<li>The XML is then transformed into a legacy "<span class="codefrag">book.xml</span>"
+<li>The XML is then transformed into a legacy "<span class="codefrag ">book.xml</span>"
           format, for compatibility with existing stylesheets, and this XML
           format is returned (hence the name of the matcher:
-          <span class="codefrag">**book-*.html</span>).</li>
+          <span class="codefrag ">**book-*.html</span>).</li>
       
 </ol>
 </div>
@@ -1026,7 +1026,7 @@
 <a name="N10359"></a><a name="linkrewriting_impl"></a>
 <h2 class="underlined_10">Link rewriting</h2>
 <div class="section">
-<p>In numerous places in <span class="codefrag">sitemap.xmap</span> you will see the
+<p>In numerous places in <span class="codefrag ">sitemap.xmap</span> you will see the
         "linkrewriter" transformer in action.  For example:</p>
 <pre class="code">&lt;map:transform type="linkrewriter" src="cocoon:/{1}linkmap-{2}.html"/&gt;</pre>
 <p>This statement is Cocoon's linking system in action.  A full
@@ -1035,7 +1035,7 @@
 <a name="N10370"></a><a name="input_modules"></a>
 <h3 class="underlined_5">Cocoon foundations: Input Modules</h3>
 <p>
-          The implementation of <span class="codefrag">site:</span> linking is heavily based on
+          The implementation of <span class="codefrag ">site:</span> linking is heavily based on
           Cocoon <a href="http://cocoon.apache.org/2.1/userdocs/concepts/modules.html">Input Modules</a>, a
           little-known but quite powerful aspect of Cocoon.  Input Modules are
           generic Components which simply allow you to look up a value with a
@@ -1043,21 +1043,21 @@
           querying an underlying data source.
         </p>
 <p>
-          In particular, Cocoon contains an <span class="codefrag">XMLFileModule</span>, which
+          In particular, Cocoon contains an <span class="codefrag ">XMLFileModule</span>, which
           lets one look up the value of an XML node, by interpreting the key as
           an XPath expression.  Cocoon also has a
-          <span class="codefrag">SimpleMappingMetaModule</span>, which allows the key to be
+          <span class="codefrag ">SimpleMappingMetaModule</span>, which allows the key to be
           rewritten before it is used to look up a value.
         </p>
 <p>
-          The idea for putting these together to rewrite "<span class="codefrag">site:</span>"
+          The idea for putting these together to rewrite "<span class="codefrag ">site:</span>"
           links was described in <a href="http://marc.theaimsgroup.com/?t=103992708800001&r=1&w=2">this
             thread</a>. The idea is to write a Cocoon Transformer that
           triggers on encountering &lt;link
-          href="<span class="codefrag">scheme:address</span>"&gt;, and interprets the
-          <span class="codefrag">scheme:address</span> internal URI as
-          <span class="codefrag">inputmodule:key</span>.  The transformer then uses the named
-          InputModule to look up the key value. The <span class="codefrag">scheme:address</span>
+          href="<span class="codefrag ">scheme:address</span>"&gt;, and interprets the
+          <span class="codefrag ">scheme:address</span> internal URI as
+          <span class="codefrag ">inputmodule:key</span>.  The transformer then uses the named
+          InputModule to look up the key value. The <span class="codefrag ">scheme:address</span>
           URI is then rewritten with the found value.  This transformer was
           implemented as 
           <a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=15611">LinkRewriterTransformer</a>,
@@ -1066,7 +1066,7 @@
 <a name="N103A4"></a><a name="implement_rewriting"></a>
 <h3 class="underlined_5">Implementing "site:" rewriting</h3>
 <p>
-          Using the above components, "<span class="codefrag">site:</span>" URI rewriting is
+          Using the above components, "<span class="codefrag ">site:</span>" URI rewriting is
           accomplished as follows.
         </p>
 <a name="N103B3"></a><a name="cocoon_xconf"></a>
@@ -1092,26 +1092,26 @@
             
 <li>
 <strong>linkmap</strong> will provide access to the contents of
-              <span class="codefrag">site.xml</span>; for example, <span class="codefrag">linkmap:/site/about/index/@href</span>
+              <span class="codefrag ">site.xml</span>; for example, <span class="codefrag ">linkmap:/site/about/index/@href</span>
               would return the value "index.html".</li>
             
 <li>
 <strong>site</strong> provides a "mask" over
-              <strong>linkmap</strong> such that <span class="codefrag">site:index</span> expands
-              to <span class="codefrag">linkmap:/site//index/@href</span>
+              <strong>linkmap</strong> such that <span class="codefrag ">site:index</span> expands
+              to <span class="codefrag ">linkmap:/site//index/@href</span>
             
 </li>
             
 <li>
 <strong>ext</strong> provides another "mask" over
-              <strong>linkmap</strong>, such that <span class="codefrag">ext:ant</span> would
-              expand to <span class="codefrag">linkmap:/site/external-refs//ant/@href</span>
+              <strong>linkmap</strong>, such that <span class="codefrag ">ext:ant</span> would
+              expand to <span class="codefrag ">linkmap:/site/external-refs//ant/@href</span>
             
 </li>
           
 </ul>
 <p>However at the moment, we have only declared the input modules.
-            They will be configured in <span class="codefrag">sitemap.xmap</span> as described in
+            They will be configured in <span class="codefrag ">sitemap.xmap</span> as described in
             the next section.</p>
 <a name="N103F1"></a><a name="sitemap"></a>
 <h4>sitemap.xmap</h4>
@@ -1168,39 +1168,39 @@
                   &lt;file src="{src}" reloadable="false" /&gt;
               &lt;/input-module&gt;</pre>
               
-<p>The "<span class="codefrag">{src}</span>" text is expanded to the value of the
-                "<span class="codefrag">src</span>" attribute in the "<span class="codefrag">linkrewriter</span>"
-                instance, namely "<span class="codefrag">cocoon:/{1}linkmap-{2}.html</span>"
-                Thus the <span class="codefrag">linkmap</span> module reads dynamically
+<p>The "<span class="codefrag ">{src}</span>" text is expanded to the value of the
+                "<span class="codefrag ">src</span>" attribute in the "<span class="codefrag ">linkrewriter</span>"
+                instance, namely "<span class="codefrag ">cocoon:/{1}linkmap-{2}.html</span>"
+                Thus the <span class="codefrag ">linkmap</span> module reads dynamically
                 generated XML specific to the current request.</p>
             
 </li>
             
 <li>
               
-<p>One level out, we configure the "<span class="codefrag">site</span>" and
-                "<span class="codefrag">ext</span>" input modules, to map onto our dynamically
-                configured "<span class="codefrag">linkmap</span>" module.</p>
+<p>One level out, we configure the "<span class="codefrag ">site</span>" and
+                "<span class="codefrag ">ext</span>" input modules, to map onto our dynamically
+                configured "<span class="codefrag ">linkmap</span>" module.</p>
             
 </li>
             
 <li>
               
 <p>Then at the outermost level, we configure the
-                "<span class="codefrag">linkrewriter</span>" transformer.  First we tell it which
+                "<span class="codefrag ">linkrewriter</span>" transformer.  First we tell it which
                 attributes to consider rewriting:</p>
               
 <pre class="code">
                 &lt;link-attrs&gt;href src&lt;/link-attrs&gt;
                 &lt;schemes&gt;site ext&lt;/schemes&gt;</pre>
               
-<p>So, "<span class="codefrag">href</span>" and "<span class="codefrag">src</span>" attributes starting
-                with "<span class="codefrag">site:</span>" or "<span class="codefrag">ext:</span>" are rewritten.</p>
+<p>So, "<span class="codefrag ">href</span>" and "<span class="codefrag ">src</span>" attributes starting
+                with "<span class="codefrag ">site:</span>" or "<span class="codefrag ">ext:</span>" are rewritten.</p>
 
               
-<p>By nesting the "<span class="codefrag">site</span>" and "<span class="codefrag">ext</span>" input
-                modules in the "<span class="codefrag">linkrewriter</span>" configuration, we tell
-                "<span class="codefrag">linkrewriter</span>" to use these two input modules when
+<p>By nesting the "<span class="codefrag ">site</span>" and "<span class="codefrag ">ext</span>" input
+                modules in the "<span class="codefrag ">linkrewriter</span>" configuration, we tell
+                "<span class="codefrag ">linkrewriter</span>" to use these two input modules when
                 rewriting links.</p>
             
 </li>
@@ -1208,20 +1208,20 @@
 </ul>
 <p>
             The end result is that, for example, the source XML for the
-            <span class="codefrag">community/body-index.html</span> page has its links rewritten
+            <span class="codefrag ">community/body-index.html</span> page has its links rewritten
             by an XMLFileModule reading XML from
-            <span class="codefrag">cocoon:/community/linkmap-index.html</span>
+            <span class="codefrag ">cocoon:/community/linkmap-index.html</span>
           
 </p>
 <a name="N10464"></a><a name="dynamic_linkmap"></a>
 <h4>Dynamically generating a linkmap</h4>
 <p>
             Why do we need this "linkmap" pipeline generating dynamic XML from
-            <span class="codefrag">site.xml</span>, instead of just using <span class="codefrag">site.xml</span> directly?  The reasons are described
+            <span class="codefrag ">site.xml</span>, instead of just using <span class="codefrag ">site.xml</span> directly?  The reasons are described
             in <a href="http://marc.theaimsgroup.com/?l=forrest-dev&m=103444028129281&w=2">the linkmap RT</a>: we need to
             concatenate @hrefs and add dot-dots to the paths, depending on which
             directory the linkee is in.  This is done with the following
-            pipelines in <span class="codefrag">linkmap.xmap</span> ...
+            pipelines in <span class="codefrag ">linkmap.xmap</span> ...
           </p>
 <pre class="code">
 &lt;!-- site.xml with @href's appended to be context-relative. --&gt;

Modified: forrest/site/docs_0_80/todo.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/todo.html?rev=354312&r1=354311&r2=354312&view=diff
==============================================================================
--- forrest/site/docs_0_80/todo.html (original)
+++ forrest/site/docs_0_80/todo.html Mon Dec  5 20:55:03 2005
@@ -373,7 +373,7 @@
         
         This info can then be made public to the sitemap (via XMLFileModule
         attributes) and the stylesheets (through
-        <span class="codefrag">document(cocoon:/...)</span> calls or inlined with source XML).
+        <span class="codefrag ">document(cocoon:/...)</span> calls or inlined with source XML).
          &rarr; open</li>
 <li>
 <strong>[code]</strong> 

Modified: forrest/site/docs_0_80/upgrading_08.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/upgrading_08.html?rev=354312&r1=354311&r2=354312&view=diff
==============================================================================
--- forrest/site/docs_0_80/upgrading_08.html (original)
+++ forrest/site/docs_0_80/upgrading_08.html Mon Dec  5 20:55:03 2005
@@ -417,7 +417,7 @@
 <p>
       Take advantage of the separation of concerns. In a new workspace,
       create a fresh
-      '<span class="codefrag">forrest seed</span>' site, then tweak its forrest.properties
+      '<span class="codefrag ">forrest seed</span>' site, then tweak its forrest.properties
       and skinconf.xml until it reflects your old site.
       When it is ready, replace your project's skinconf.xml and
       forrest.properties files.

Modified: forrest/site/docs_0_80/validation.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/validation.html?rev=354312&r1=354311&r2=354312&view=diff
==============================================================================
--- forrest/site/docs_0_80/validation.html (original)
+++ forrest/site/docs_0_80/validation.html Mon Dec  5 20:55:03 2005
@@ -366,7 +366,7 @@
         By default, Forrest will validate your XML before generating
         HTML or a webapp from it, and fail if any XML files are not valid.
         Validation can be performed manually by doing
-        '<span class="codefrag">forrest validate</span>' in the project root directory.
+        '<span class="codefrag ">forrest validate</span>' in the project root directory.
       </p>
 <p>
         For an XML file to be valid, it <em>must</em> have a document type
@@ -380,7 +380,7 @@
         project.  In validated sections, it is possible for projects to specify
         exactly what files they want (and don't want) validated.  Forrest
         validation is controlled through a set of properties in
-        <span class="codefrag">forrest.properties</span>:
+        <span class="codefrag ">forrest.properties</span>:
       </p>
 <pre class="code">
 ##############
@@ -407,18 +407,18 @@
       </pre>
 <p>
         For example, to avoid validating
-        <span class="codefrag">${project.xdocs-dir}</span>/slides.xml and everything inside the
-        <span class="codefrag">${project.xdocs-dir}/manual/</span> directory, add this to
-        <span class="codefrag">forrest.properties</span>:
+        <span class="codefrag ">${project.xdocs-dir}</span>/slides.xml and everything inside the
+        <span class="codefrag ">${project.xdocs-dir}/manual/</span> directory, add this to
+        <span class="codefrag ">forrest.properties</span>:
       </p>
 <pre class="code">forrest.validate.xdocs.excludes=slides.xml, manual/**</pre>
 <div class="note">
 <div class="label">Note</div>
 <div class="content">
-        The <span class="codefrag">failonerror</span> properties only work for files validated
+        The <span class="codefrag ">failonerror</span> properties only work for files validated
         with Ant's &lt;xmlvalidate&gt; and not (yet) for those validated
-        with &lt;jing&gt;, where <span class="codefrag">failonerror</span> defaults to
-        <span class="codefrag">true</span>.
+        with &lt;jing&gt;, where <span class="codefrag ">failonerror</span> defaults to
+        <span class="codefrag ">true</span>.
       </div>
 </div>
 </div>
@@ -430,12 +430,12 @@
 <p>
         Forrest provides an <a href="http://www.oasis-open.org/committees/entity/spec.html">OASIS Catalog</a>
         [see <a href="http://xml.apache.org/commons/components/resolver/resolver-article.html">tutorial</a>]
-        <span class="codefrag">forrest/main/webapp/resources/schema/catalog.xcat</span>
+        <span class="codefrag ">forrest/main/webapp/resources/schema/catalog.xcat</span>
         as a means of associating public identifiers
-        (e.g. <span class="codefrag">-//APACHE//DTD Documentation V1.1//EN</span> above) with DTDs.
+        (e.g. <span class="codefrag ">-//APACHE//DTD Documentation V1.1//EN</span> above) with DTDs.
         If you <a href="../docs_0_80/your-project.html#adding_new_content_type">add a new content type</a>, you
-        should add the DTD to <span class="codefrag">${project.schema-dir}/dtd/</span> and add
-        an entry to the <span class="codefrag">${project.schema-dir}/catalog.xcat</span> file.  This
+        should add the DTD to <span class="codefrag ">${project.schema-dir}/dtd/</span> and add
+        an entry to the <span class="codefrag ">${project.schema-dir}/catalog.xcat</span> file.  This
         section describes the details of this process.
       </p>
 <a name="N1006A"></a><a name="Creating+or+extending+a+DTD"></a>
@@ -465,13 +465,13 @@
         </pre>
 <p>
           The document-v13 entities are defined in a reusable 'module':
-          <span class="codefrag">forrest/main/webapp/resources/schema/dtd/document-v13.mod</span>
+          <span class="codefrag ">forrest/main/webapp/resources/schema/dtd/document-v13.mod</span>
           The
-          <span class="codefrag">forrest/main/webapp/resources/schema/dtd/document-v13.dtd</span>
+          <span class="codefrag ">forrest/main/webapp/resources/schema/dtd/document-v13.dtd</span>
           file provides a full description and basic example of how to pull in
           modules.  In our example, our DTD reuses modules
-          <span class="codefrag">common-charents-v10.mod</span> and
-          <span class="codefrag">document-v13.mod</span>.  Here is the full DTD, with
+          <span class="codefrag ">common-charents-v10.mod</span> and
+          <span class="codefrag ">document-v13.mod</span>.  Here is the full DTD, with
           explanation to follow.
         </p>
 <pre class="code">
@@ -546,20 +546,20 @@
 &lt;!-- =============================================================== --&gt;
         </pre>
 <p>This custom DTD should be placed in your project resources
-        directory at <span class="codefrag">src/documentation/resources/schema/dtd/</span>
+        directory at <span class="codefrag ">src/documentation/resources/schema/dtd/</span>
 </p>
 <p>
           The &lt;!ENTITY % ... &gt; blocks are so-called 
           <a href="http://www.xml.com/axml/target.html#dt-PERef">parameter
             entities</a>.  They are like macros, whose content will be
           inserted when a parameter-entity reference, like
-          <span class="codefrag">%common-charents;</span> or <span class="codefrag">%document;</span> is
+          <span class="codefrag ">%common-charents;</span> or <span class="codefrag ">%document;</span> is
           inserted.
         </p>
 <p>
           In our DTD, we first pull in the 'common-charents' entity, which
           defines character symbol sets.  We then define the 'document'
-          entity.  However, before the <span class="codefrag">%document;</span> PE reference, we
+          entity.  However, before the <span class="codefrag ">%document;</span> PE reference, we
           first override the 'local.section' entity.  This is a hook into
           document-v13.mod.  By setting its value to '|release', we declare
           that our &lt;release&gt; element is to be allowed wherever "local
@@ -591,7 +591,7 @@
           "download-v10.dtd"&gt;
         </pre>
 <p>
-          We only care about the quoted section after <span class="codefrag">PUBLIC</span>, called
+          We only care about the quoted section after <span class="codefrag ">PUBLIC</span>, called
           the "public identifier", which globally identifies our document type.
           We cannot rely on the subsequent "system identifier" part
           ("download-v10.dtd"), because as a relative reference it is liable to
@@ -608,21 +608,21 @@
 </div>
 <p>
           Forrest provides a standard catalog file at
-          <span class="codefrag">forrest/main/webapp/resources/schema/catalog.xcat</span>
+          <span class="codefrag ">forrest/main/webapp/resources/schema/catalog.xcat</span>
           for the document
           types that Forrest provides.  Projects can augment this with their
           own catalog file located in
-          <span class="codefrag">${project.schema-dir}/catalog.xcat</span> to use it you must
+          <span class="codefrag ">${project.schema-dir}/catalog.xcat</span> to use it you must
 	    specify either the path (full or relative) to your 
-	    <span class="codefrag">catalog.xcat</span> in the <span class="codefrag">CatalogManager.properties</span>
+	    <span class="codefrag ">catalog.xcat</span> in the <span class="codefrag ">CatalogManager.properties</span>
 	    file. If you provide a relative path you must set the property 
-	    <span class="codefrag">relative-catalogs</span> to "yes".
+	    <span class="codefrag ">relative-catalogs</span> to "yes".
 	  </p>
 <p>
-          When Cocoon starts, it reads the <span class="codefrag">CatalogManager.properties</span> file from your
-          <span class="codefrag">project.classes-dir</span>. This is usually src/documentation/classes/
-          but you can change this in <span class="codefrag">forrest.properties</span>. When you seed 
-          a new site using <span class="codefrag">forrest seed-site</span> a sample catalog file
+          When Cocoon starts, it reads the <span class="codefrag ">CatalogManager.properties</span> file from your
+          <span class="codefrag ">project.classes-dir</span>. This is usually src/documentation/classes/
+          but you can change this in <span class="codefrag ">forrest.properties</span>. When you seed 
+          a new site using <span class="codefrag ">forrest seed-site</span> a sample catalog file
           is placed in the site structure, you can use this as a template for your
           own files.
         </p>
@@ -641,17 +641,17 @@
 <p>
           The format is described in <a href="http://www.oasis-open.org/committees/entity/spec.html">the
           spec</a>, and is fairly simple and very powerful.
-          The "<span class="codefrag">public</span>" elements map
+          The "<span class="codefrag ">public</span>" elements map
           a public identifier to a DTD (relative to the catalog file).
         </p>
 <p>
           We now have a custom DTD and a catalog mapping which lets both
           Forrest and Cocoon
-          locate the DTD.  Now if we were to run <span class="codefrag">'forrest validate'</span>
+          locate the DTD.  Now if we were to run <span class="codefrag ">'forrest validate'</span>
           our download file would validate along with all the others.  If
-          something goes wrong, try running <span class="codefrag">'forrest -v validate'</span> to
+          something goes wrong, try running <span class="codefrag ">'forrest -v validate'</span> to
           see the error in more detail. Remember to raise the "verbosity"
-          level in <span class="codefrag">cocoon.xconf</span> if you suspect problems
+          level in <span class="codefrag ">cocoon.xconf</span> if you suspect problems
           with your catalog.
         </p>
 </div>
@@ -662,8 +662,8 @@
 <div class="section">
 <p>
         Look at the source of this document
-        (<span class="codefrag">xdocs/docs/validation.xml</span>) and see how the entity set
-        <span class="codefrag">"Numeric and Special Graphic"</span> is declared in the
+        (<span class="codefrag ">xdocs/docs/validation.xml</span>) and see how the entity set
+        <span class="codefrag ">"Numeric and Special Graphic"</span> is declared in the
         document type declaration.
       </p>
 <table class="ForrestTable" cellspacing="1" cellpadding="4">
@@ -705,10 +705,10 @@
       </p>
 <p>
         The RNG grammars to do this are located in the
-        <span class="codefrag">main/webapp/resources/schema/relaxng</span> directory.
+        <span class="codefrag ">main/webapp/resources/schema/relaxng</span> directory.
         If you want to
         know more about this, and perhaps extend it for your own use, then
-        see <span class="codefrag">main/webapp/resources/schema/relaxng/README.txt</span>
+        see <span class="codefrag ">main/webapp/resources/schema/relaxng/README.txt</span>
         and the Ant targets in the various build.xml files.
       </p>
 </div>

Modified: forrest/site/docs_0_80/views.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/views.html?rev=354312&r1=354311&r2=354312&view=diff
==============================================================================
--- forrest/site/docs_0_80/views.html (original)
+++ forrest/site/docs_0_80/views.html Mon Dec  5 20:55:03 2005
@@ -418,7 +418,7 @@
 <div class="section">
 <p>
         Apache Forrest 1.0 Specification (Draft, not yet published):
-        <span class="codefrag">site-author/content/xdocs/TR/2005/WD-forrest10.html</span>
+        <span class="codefrag ">site-author/content/xdocs/TR/2005/WD-forrest10.html</span>
       
 </p>
 <p>

Modified: forrest/site/docs_0_80/your-project.html
URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/your-project.html?rev=354312&r1=354311&r2=354312&view=diff
==============================================================================
--- forrest/site/docs_0_80/your-project.html (original)
+++ forrest/site/docs_0_80/your-project.html Mon Dec  5 20:55:03 2005
@@ -472,7 +472,7 @@
 <h5>Permanently Setting The Environment Variables for Linux/Unix</h5>
 <p>Export only changes the variables during that terminal session for that 
            user, this is useful for testing. To permanently add the variable edit either 
-           <span class="codefrag">/etc/bash.bashrc</span> (for all users) or <span class="codefrag">~/.bash_profile</span>
+           <span class="codefrag ">/etc/bash.bashrc</span> (for all users) or <span class="codefrag ">~/.bash_profile</span>
            (for individual users). Add these lines to the end of the file you edit:</p>
 <pre class="code">
       FORREST_HOME=/full/path/to/forrest
@@ -484,9 +484,9 @@
 <a name="N1005B"></a><a name="Windows+2000"></a>
 <h4>Windows 2000</h4>
 <p class="instruction">Go to "My Computer", "Properties", "Advanced", "Environment Variables"</p>
-<p class="instruction">add a new variable <span class="codefrag">FORREST_HOME</span> as <span class="codefrag">C:\full\path\to\apache-forrest-0.7</span>
+<p class="instruction">add a new variable <span class="codefrag ">FORREST_HOME</span> as <span class="codefrag ">C:\full\path\to\apache-forrest-0.7</span>
 </p>
-<p class="instruction">edit <span class="codefrag">PATH</span> as <span class="codefrag">%PATH%;%FORREST_HOME%\bin</span>
+<p class="instruction">edit <span class="codefrag ">PATH</span> as <span class="codefrag ">%PATH%;%FORREST_HOME%\bin</span>
 </p>
 <a name="N10078"></a><a name="In+Windows+XP%3A"></a>
 <h4>In Windows XP:</h4>
@@ -574,12 +574,12 @@
 <div class="note">
 <div class="label">Note</div>
 <div class="content">
-<span class="codefrag">forrest seed</span> is useful to see what is possible within Forrest,
-      but if you are creating a real site <span class="codefrag">forrest seed-business</span> has less
+<span class="codefrag ">forrest seed</span> is useful to see what is possible within Forrest,
+      but if you are creating a real site <span class="codefrag ">forrest seed-business</span> has less
       content initially, and is therefore easier to edit (even if it is not a business
       site). We hope to include more seed sites in the future.</div>
 </div>
-<p>If you run <span class="codefrag">forrest seed</span> you should see output like this below:</p>
+<p>If you run <span class="codefrag ">forrest seed</span> you should see output like this below:</p>
 <pre class="code">
 [/home/me/forrest/my-test]$ forrest seed
 
@@ -606,11 +606,10 @@
 Here is an outline of the generated files:
 
 /                        # /home/me/forrest/my-test
-/status.xml              # List of project developers, todo list and change log
 /forrest.properties      # Optional file describing your site layout
 /src/documentation/      # Doc-specific files
 /src/documentation/skinconf.xml    # Info about your project used by the skin
-/src/documentation/content/xdocs   # Site content.
+/src/documentation/content         # Site content.
 /src/documentation/content/xdocs   # XML content.
 /src/documentation/content/xdocs/index.xml # Home page
 /src/documentation/content/xdocs/site.xml  # Navigation file for site structure
@@ -625,8 +624,6 @@
 - Render this template to static HTML by typing 'forrest'.
   View the generated HTML in a browser to make sure everything works.
 - Alternatively 'forrest run' and browse to http://localhost:8888/ live demo.
-- Edit status.xml and src/documentation/skinconf.xml
-  to customize for your project.
 - Start adding content in xdocs/ remembering to declare new files in site.xml
 - Follow the document http://forrest.apache.org/docs/your-project.html
 - Provide any feedback to dev@forrest.apache.org
@@ -686,6 +683,10 @@
 |       |       |-- hello.pdf
 |       |       |-- test1.html
 |       |       `-- test2.html
+|       `-- resources
+|           `-- images
+|           `-- schema
+|           `-- stylesheets
 |       |-- sitemap.xmap
 |       |-- skinconf.xml
 |       `-- translations
@@ -702,20 +703,19 @@
 |           |-- menu_sk.xml
 |           |-- tabs.xml
 |           `-- tabs_es.xml
-|-- status.xml
       </pre>
 <p>
         To render this to HTML, type 'forrest'. You should have a HTML site rendered
-        into the <span class="codefrag">build/site</span> directory:
+        into the <span class="codefrag ">build/site</span> directory:
       </p>
 <div id="" style="text-align: center;">
 <img id="" class="figure" alt="New project" src="images/new-project.png" height="356" width="500"></div>
 <p>
         Practise with adding new content. Change to the directory
-        <span class="codefrag">src/documentation/content/xdocs</span> and copy the file
-        <span class="codefrag">index.xml</span> to create <span class="codefrag">my-new-file.xml</span> as a
+        <span class="codefrag ">src/documentation/content/xdocs</span> and copy the file
+        <span class="codefrag ">index.xml</span> to create <span class="codefrag ">my-new-file.xml</span> as a
         new document. Edit it to change some text. Add an entry to 
-        <span class="codefrag">site.xml</span> by copying one of the other entries and
+        <span class="codefrag ">site.xml</span> by copying one of the other entries and
         changing it to suit. Now do 'forrest' to see the result.
       </p>
 </div>
@@ -734,7 +734,7 @@
         If your project already has XML documentation, it may be easier to tell
         Forrest where the XML sources are, rather than rearrange your project
         directories to accommodate Forrest. This can be done by editing
-        <span class="codefrag">forrest.properties</span> (consult
+        <span class="codefrag ">forrest.properties</span> (consult
         the <a href="#Changing_the_layout">Changing the layout</a>
         section for more details).
       </p>
@@ -752,7 +752,7 @@
 <h3 class="underlined_5">Configuring the Forrest skin: skinconf.xml</h3>
 <p>
           Most Forrest skins can be customized through a single XML file,
-          <span class="codefrag">src/documentation/skinconf.xml</span>, which looks like this:
+          <span class="codefrag ">src/documentation/skinconf.xml</span>, which looks like this:
         </p>
 <pre class="code">
 &lt;!--
@@ -916,9 +916,9 @@
 &lt;/skinconfig&gt;
 </pre>
 <p>
-          Customise this file for your project. The <span class="codefrag">images/</span> directory
+          Customise this file for your project. The <span class="codefrag ">images/</span> directory
           mentioned in 'project-logo' and 'group-logo' elements corresponds to the
-          <span class="codefrag">src/documentation/resources/images</span> directory
+          <span class="codefrag ">src/documentation/resources/images</span> directory
           (this mapping is done automatically by the sitemap).
         </p>
 <p>
@@ -933,7 +933,7 @@
           major file types.
         </p>
 <p>
-          The <span class="codefrag">forrest.properties</span> file maps from your directory
+          The <span class="codefrag ">forrest.properties</span> file maps from your directory
           layout to Forrest's. If you generated your site with 'forrest seed', you
           will have one pre-written, with all the entries commented out.
         </p>
@@ -955,7 +955,6 @@
 # Parent properties must be set. This usually means uncommenting
 # project.content-dir if any other property using it is uncommented
 
-#project.status=status.xml
 #project.content-dir=src/documentation
 #project.conf-dir=${project.content-dir}/conf
 #project.sitemap-dir=${project.content-dir}
@@ -971,7 +970,7 @@
        </pre>
 <p>
          For example, if you wish to keep XML documentation in src/xdocs rather than
-         <span class="codefrag">src/documentation/content/xdocs</span> simply change the
+         <span class="codefrag ">src/documentation/content/xdocs</span> simply change the
          definition for project.xdocs-dir
        </p>
 <pre class="code">project.xdocs-dir=src/xdocs</pre>
@@ -997,7 +996,7 @@
 <div class="label">Note</div>
 <div class="content">
            Internally, Forrest rearranges the specified directory into the default
-           <span class="codefrag">src/documentation/content/xdocs</span> structure. In the layout above, we have
+           <span class="codefrag ">src/documentation/content/xdocs</span> structure. In the layout above, we have
            overlapping directories, so you will end up with duplicate files. This small
            glitch doesn't usually cause problems; just always remember that all links
            are resolved through the sitemap.
@@ -1011,14 +1010,14 @@
 <div class="section">
 <p>
         Now you can start adding content of your own, in
-        <span class="codefrag">src/documentation/content/xdocs</span>
+        <span class="codefrag ">src/documentation/content/xdocs</span>
       
 </p>
 <a name="N10167"></a><a name="site.xml"></a>
 <h3 class="underlined_5">site.xml</h3>
 <p>
           When adding a new xml document, you would add an entry to the project's
-          <span class="codefrag">site.xml</span> file. This site.xml is like a site index, and is rendered as
+          <span class="codefrag ">site.xml</span> file. This site.xml is like a site index, and is rendered as
           the vertical column of links in the default skin.  Look at Forrest's own
           xdocs for an example.  More detailed info about site.xml is provided in 
           the document <a href="../docs_0_80/linking.html">Menus and Linking</a>.
@@ -1026,7 +1025,7 @@
 <a name="N10178"></a><a name="tabs.xml"></a>
 <h3 class="underlined_5">tabs.xml</h3>
 <p>
-          The <span class="codefrag">tabs.xml</span> file is used to produce the 'tabs'.
+          The <span class="codefrag ">tabs.xml</span> file is used to produce the 'tabs'.
           which enable users to quickly jump to sections of your site.
           See the
           <a href="../docs_0_80/linking.html#menu_generation">menu generation</a> documentation
@@ -1038,12 +1037,12 @@
 <p>You can have one or two levels of tabs. The images above show a 
         single level. However, you can create a second level that
         will only be displayed when its parent tab is selected. For example,
-        the <span class="codefrag">tabs.xml</span> snippet below will display either one or
+        the <span class="codefrag ">tabs.xml</span> snippet below will display either one or
         two rows of tabs, depending on which of the top level tabs is selected.
-        The first row will have two tabs: one labelled <span class="codefrag">How-Tos</span>
-        and the other labelled <span class="codefrag">Apache XML Projects</span>. When the 
-        <span class="codefrag">How-Tos</span> tab is selected there will
-        be no second row of tabs. However, when the <span class="codefrag">Apache XML
+        The first row will have two tabs: one labelled <span class="codefrag ">How-Tos</span>
+        and the other labelled <span class="codefrag ">Apache XML Projects</span>. When the 
+        <span class="codefrag ">How-Tos</span> tab is selected there will
+        be no second row of tabs. However, when the <span class="codefrag ">Apache XML
         Projects</span> tab is selected, a second row of tabs will be displayed
         below the first.</p>
 <pre class="code">
@@ -1056,10 +1055,10 @@
 <a name="N101A3"></a><a name="images"></a>
 <h3 class="underlined_5">Images</h3>
 <p>
-          Images usually go in the <span class="codefrag">content/xdocs/images/</span> directory.
+          Images usually go in the <span class="codefrag ">resources/images/</span> directory.
           The default sitemap
-          maps this directory to <span class="codefrag">images/</span> so image tags will typically look
-          like <span class="codefrag">&lt;figure src="images/project-logo.png" alt="Project Logo"/&gt;</span> 
+          maps this directory to <span class="codefrag ">images/</span> so image tags will typically look
+          like <span class="codefrag ">&lt;figure src="images/project-logo.png" alt="Project Logo"/&gt;</span> 
         
 </p>
 </div>
@@ -1095,8 +1094,8 @@
           sources available as "virtual" files.
           (<strong>Note:</strong> Forrest makes extensive use of aggregation
           in the default sitemaps. It also defines a whole-site HTML
-          and PDF, available as the standard names <span class="codefrag">wholesite.html</span>
-          and <span class="codefrag">wholesite.pdf</span>.)</li>
+          and PDF, available as the standard names <span class="codefrag ">wholesite.html</span>
+          and <span class="codefrag ">wholesite.pdf</span>.)</li>
         
 <li>Read content from exotic sources like
         <a href="http://www.rpbourret.com/xml/XMLDBLinks.htm">XML
@@ -1110,13 +1109,13 @@
 </ul>
 <p>
         The Forrest sitemaps are at
-        <span class="codefrag">main/webapp/*.xmap</span>
+        <span class="codefrag ">main/webapp/*.xmap</span>
       
 </p>
 <p>
         You can add pre-processing sitemaps to your project
-        <span class="codefrag">src/documentation</span> directory (or wherever
-        <span class="codefrag">${project.sitemap-dir}</span> points to). Get a copy of a simple
+        <span class="codefrag ">src/documentation</span> directory (or wherever
+        <span class="codefrag ">${project.sitemap-dir}</span> points to). Get a copy of a simple
         sitemap.xmap from a 'forrest seed site'. </p>
 <p>Any match that
         is not handled, passes through to be handled by the default Forrest
@@ -1199,15 +1198,15 @@
     &lt;/section&gt;
   &lt;/body&gt;
 &lt;/document&gt;</pre>
-<p>This file called "<span class="codefrag">download.xml</span>" would be placed in
+<p>This file called "<span class="codefrag ">download.xml</span>" would be placed in
           your content directory (typically
-          <span class="codefrag">src/documentation/content/xdocs</span>) and an entry added to
-          <span class="codefrag">site.xml</span>
+          <span class="codefrag ">src/documentation/content/xdocs</span>) and an entry added to
+          <span class="codefrag ">site.xml</span>
 </p>
 <p>
           To handle these special tags, one would write a stylesheet to convert
           them to the intermediate Forrest xdocs structure. Here is such a stylesheet,
-          called "<span class="codefrag">download2document.xsl</span>" ...
+          called "<span class="codefrag ">download2document.xsl</span>" ...
         </p>
 <pre class="code">&lt;?xml version="1.0" encoding="utf-8"?&gt;
 &lt;xsl:stylesheet
@@ -1244,7 +1243,7 @@
 </pre>
 <p>
             Place this file in the default stylesheets directory,
-            <span class="codefrag">src/documentation/resources/stylesheets</span> (or wherever
+            <span class="codefrag ">src/documentation/resources/stylesheets</span> (or wherever
             ${project.stylesheets-dir} points).
           </p>
 <p>
@@ -1261,7 +1260,7 @@
 </div>
 <p>
             Add the following match to the file
-            <span class="codefrag">src/documentation/sitemap.xmap</span> ...
+            <span class="codefrag ">src/documentation/sitemap.xmap</span> ...
           </p>
 <pre class="code">&lt;?xml version="1.0"?&gt;
 &lt;map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0"&gt;
@@ -1302,7 +1301,7 @@
                    one.</li>
                  
 <li>Place the new DTD in the
-                   <span class="codefrag">${project.schema-dir}/dtd</span> directory.</li>
+                   <span class="codefrag ">${project.schema-dir}/dtd</span> directory.</li>
                  
 <li>Add an XML Catalog to enable a mapping from the
                    DOCTYPE public id to the relevant DTD file.</li>
@@ -1386,7 +1385,7 @@
 </pre>
 <p>
               This is the type of processing that happens in the main
-              <span class="codefrag">main/webapp/forrest.xmap</span> sitemap. We have
+              <span class="codefrag ">main/webapp/forrest.xmap</span> sitemap. We have
               added similar handling to our project sitemap. Basically, this
               uses the <a href="../docs_0_80/cap.html">SourceTypeAction (content aware pipelines)</a>
               to detect the doctype. The new document-v11.dtd needs to be also
@@ -1422,9 +1421,9 @@
 &lt;/map:sitemap&gt;
 </pre>
 <p>You will probably want to copy the core Forrest 
-              <span class="codefrag">rss2document.xsl</span> to your project,
+              <span class="codefrag ">rss2document.xsl</span> to your project,
               customise it to your needs, and refer to it with
-              <span class="codefrag">src="{project:resources.stylesheets}/rss2document.xsl"</span>.
+              <span class="codefrag ">src="{project:resources.stylesheets}/rss2document.xsl"</span>.
               Then of course you would add an entry to site.xml to link
               to weblog.html
             </p>
@@ -1437,12 +1436,12 @@
 <p>
           As Forrest separates content from presentation, we can plug in different
           "skins" to instantly change a site's look and feel.  Forrest provides one
-          primary skin, <span class="codefrag">pelt</span>, and some others in various
+          primary skin, <span class="codefrag ">pelt</span>, and some others in various
           states of development.
         </p>
 <p>
-          To change the skin, edit the <span class="codefrag">forrest.properties</span> file
-          to set <span class="codefrag">project.skin=pelt</span> or some other skin name.
+          To change the skin, edit the <span class="codefrag ">forrest.properties</span> file
+          to set <span class="codefrag ">project.skin=pelt</span> or some other skin name.
           If running in dynamic mode you need to restart Forrest in order to see
           the new skin.
         </p>
@@ -1459,7 +1458,7 @@
 <h3 class="underlined_5">Configuration of skins</h3>
 <p>
           All configuration is done via your project
-          <span class="codefrag">src/documentation/skinconf.xml</span> file.
+          <span class="codefrag ">src/documentation/skinconf.xml</span> file.
           It contains many comments to describe each capability.
           Please read those, there is no point repeating here.
           </p>
@@ -1473,14 +1472,14 @@
           </p>
 <p>
             Projects can define their own skin in the
-            <span class="codefrag">src/documentation/skins</span> directory (or wherever
-            <span class="codefrag">${project.skins-dir}</span> points). The default sitemap assumes a
+            <span class="codefrag ">src/documentation/skins</span> directory (or wherever
+            <span class="codefrag ">${project.skins-dir}</span> points). The default sitemap assumes a
             certain skin layout, so the easiest way to create a new skin is by
             copying an existing Forrest skin.  For example, copy
-            <span class="codefrag">main/webapp/skins/pelt</span>
+            <span class="codefrag ">main/webapp/skins/pelt</span>
             to your project area at
-            <span class="codefrag">src/documentation/skins/my-fancy-skin</span> and add
-            <span class="codefrag">project.skin=my-fancy-skin</span> to forrest.properties
+            <span class="codefrag ">src/documentation/skins/my-fancy-skin</span> and add
+            <span class="codefrag ">project.skin=my-fancy-skin</span> to forrest.properties
           </p>
 <p>
             The two most interesting XSLT stylesheets involved are:
@@ -1488,7 +1487,7 @@
 <dl>
             
 <dt>
-<span class="codefrag">xslt/html/document2html.xsl</span>
+<span class="codefrag ">xslt/html/document2html.xsl</span>
 </dt>
             
 <dd>
@@ -1497,7 +1496,7 @@
             </dd>
             
 <dt>
-<span class="codefrag">xslt/html/site2xhtml.xsl</span>
+<span class="codefrag ">xslt/html/site2xhtml.xsl</span>
 </dt>
             
 <dd>
@@ -1521,7 +1520,7 @@
 &lt;/xsl:stylesheet&gt;</pre>
 <p>In order to use this feature in your custom skins you must copy
           the common skin from the forrest distribution into your custom skins 
-          directory (from <span class="codefrag">main/webapp/skins/common</span>).
+          directory (from <span class="codefrag ">main/webapp/skins/common</span>).
           This will protect your skin from changes in the Forrest common skin,
           but you must remember to update this skin in order to take advantage
           of new features added over time by the Forrest team.</p>
@@ -1554,20 +1553,20 @@
 <a name="N10358"></a><a name="forrest_run"></a>
 <h3 class="underlined_5">Running as a webapp</h3>
 <p>
-          Type '<span class="codefrag">forrest run</span>' in your project root to start Forrest's
+          Type '<span class="codefrag ">forrest run</span>' in your project root to start Forrest's
           built-in Jetty web server.  Once it has started, point your browser at
           <a href="http://localhost:8888/">http://localhost:8888/</a>, which
           will show your website, rendered on demand as each link is followed.
         </p>
 <p>(Alternatively, if you wish to run Forrest from within an existing
-          servlet container, type <span class="codefrag">forrest webapp</span> to build an open
-          webapp in <span class="codefrag">build/webapp/</span>)
+          servlet container, type <span class="codefrag ">forrest webapp</span> to build an open
+          webapp in <span class="codefrag ">build/webapp/</span>)
         </p>
 <a name="N10371"></a><a name="using_webapp"></a>
 <h4>Using the webapp</h4>
 <p>
             You can now edit the XML content in
-            <span class="codefrag">build/webapp/content/xdocs</span> and see the changes
+            <span class="codefrag ">build/webapp/content/xdocs</span> and see the changes
             immediately in the browser.
           </p>
 </div>
@@ -1607,14 +1606,14 @@
 <p>Because you are using your own version
       of Ant to do Forrest's work, you will need to provide the
       supporting catalog entity resolver:
-      '<span class="codefrag">cp forrest/lib/core/xml-commons-resolver-1.1.jar $ANT_HOME/lib</span>'
+      '<span class="codefrag ">cp forrest/lib/core/xml-commons-resolver-1.1.jar $ANT_HOME/lib</span>'
       </p>
 <p>Note: The technique described above requires Ant 1.6+ otherwise
         the &lt;import&gt;
         task will not be available for you to use. Forrest
         bundles the latest version of Ant, so you can invoke your project
-        like this: '<span class="codefrag">forrest -f myproject.xml</span>'.
-        This will not run the '<span class="codefrag">forrest</span>' command. It will just
+        like this: '<span class="codefrag ">forrest -f myproject.xml</span>'.
+        This will not run the '<span class="codefrag ">forrest</span>' command. It will just
         use Forrest's Ant and resolver to execute your buildfile.
       </p>
 <p>

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



Mime
View raw message