forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: rev 51863 - in forrest/site: . docs
Date Mon, 04 Oct 2004 03:50:05 GMT
Author: crossley
Date: Sun Oct  3 20:50:04 2004
New Revision: 51863

Modified:
   forrest/site/abs-linkmap
   forrest/site/abs-menulinks
   forrest/site/docs/project-sitemap.html
   forrest/site/docs/project-sitemap.pdf
   forrest/site/docs/sitemap-ref.html
   forrest/site/docs/sitemap-ref.pdf
   forrest/site/docs/your-project.html
   forrest/site/docs/your-project.pdf
   forrest/site/faq.html
   forrest/site/faq.pdf
   forrest/site/faq.xml
   forrest/site/linkmap.html
Log:
Update website.


Modified: forrest/site/abs-linkmap
==============================================================================
--- forrest/site/abs-linkmap	(original)
+++ forrest/site/abs-linkmap	Sun Oct  3 20:50:04 2004
@@ -181,6 +181,7 @@
       <actions href="http://cocoon.apache.org/2.1/userdocs/concepts/actions.html"/>
       <catalogs href="http://cocoon.apache.org/2.1/userdocs/concepts/catalog.html"/>
       <features href="http://cocoon.apache.org/2.1/features.html"/>
+      <concepts href="http://cocoon.apache.org/2.1/userdocs/concepts/"/>
       <sitemap href="http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html"/>
       <input-modules href="http://cocoon.apache.org/2.1/userdocs/concepts/modules.html"/>
       <views href="http://cocoon.apache.org/2.1/userdocs/concepts/views.html"/>

Modified: forrest/site/abs-menulinks
==============================================================================
--- forrest/site/abs-menulinks	(original)
+++ forrest/site/abs-menulinks	Sun Oct  3 20:50:04 2004
@@ -181,6 +181,7 @@
       <actions tab="home" href="http://cocoon.apache.org/2.1/userdocs/concepts/actions.html"/>
       <catalogs tab="home" href="http://cocoon.apache.org/2.1/userdocs/concepts/catalog.html"/>
       <features tab="home" href="http://cocoon.apache.org/2.1/features.html"/>
+      <concepts tab="home" href="http://cocoon.apache.org/2.1/userdocs/concepts/"/>
       <sitemap tab="home" href="http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html"/>
       <input-modules tab="home" href="http://cocoon.apache.org/2.1/userdocs/concepts/modules.html"/>
       <views tab="home" href="http://cocoon.apache.org/2.1/userdocs/concepts/views.html"/>

Modified: forrest/site/docs/project-sitemap.html
==============================================================================
--- forrest/site/docs/project-sitemap.html	(original)
+++ forrest/site/docs/project-sitemap.html	Sun Oct  3 20:50:04 2004
@@ -276,10 +276,23 @@
       to our sitemaps, without needing to copy the main sitemaps and keep
       them them synchonised. This will enable hassle-free update to
       future Forrest versions.</p>
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">
+        We advise you to spend time to understand the Apache Cocoon sitemap.
+        See <a class="external" href="http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html">Cocoon
sitemap</a>
+        and <a class="external" href="http://cocoon.apache.org/2.1/userdocs/concepts/">Cocoon
concepts</a>
+        and related component documentation.
+        The Forrest sitemap is broken into multiple files. The main one is
+        <strong>sitemap.xmap</strong> which delegates to others.  See the
+         <a href="../docs/sitemap-ref.html">Sitemap Reference</a> for a tour
of the
+        default sitemap.
+      </div>
+</div>
 </div>
 
     
-<a name="N10017"></a><a name="how"></a>
+<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 
@@ -300,10 +313,10 @@
 </div>
 
     
-<a name="N1002D"></a><a name="examples"></a>
+<a name="N1003F"></a><a name="examples"></a>
 <h2 class="underlined_10">Example uses of this technique</h2>
 <div class="section">
-<a name="N10033"></a><a name="download"></a>
+<a name="N10045"></a><a name="download"></a>
 <h3 class="underlined_5">Adding a new content type</h3>
 <p>
           See the section "Advanced customizations: sitemap.xmap" in

Modified: forrest/site/docs/project-sitemap.pdf
==============================================================================
Binary files. No diff available.

Modified: forrest/site/docs/sitemap-ref.html
==============================================================================
--- forrest/site/docs/sitemap-ref.html	(original)
+++ forrest/site/docs/sitemap-ref.html	Sun Oct  3 20:50:04 2004
@@ -337,32 +337,50 @@
       Forrest.
     </p>
     
+<div class="frame note">
+<div class="label">Note</div>
+<div class="content">
+      We advise you to spend time to understand the Apache Cocoon sitemap.
+      See <a class="external" href="http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html">Cocoon
sitemap</a>
+      and <a class="external" href="http://cocoon.apache.org/2.1/userdocs/concepts/">Cocoon
concepts</a>
+      and related component documentation.
+      The Forrest sitemap is broken into multiple files. The main one is
+      <strong>sitemap.xmap</strong> which delegates to others.
+    </div>
+</div>
+    
 <p>
-      The Cocoon sitemap syntax is documented fully 
-      <a class="external" href="http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html">in
Cocoon's documentation</a>.  This page
-      provides an overview of the sitemap we have written for Forrest.
+      This document provides an overview of the special sitemap which
+      is used at the core of Apache Forrest.
     </p>
+
     
-<a name="N1001E"></a><a name="getting_started"></a>
+<a name="N10028"></a><a name="getting_started"></a>
 <h2 class="underlined_10">Getting started</h2>
 <div class="section">
 <p>
-        If you have a binary distribution, Forrest's sitemap comprises the
-        $FORREST_HOME/context/*.xmap files.  Projects may override these files
-        by copying them into the project's src/documentation/ directory.
+        Forrest's sitemap comprises the $FORREST_HOME/context/*.xmap files.
       </p>
 <p>
-        The best way to experiment with the sitemap is to do '<span class="codefrag">forrest
-          run</span>' on a Forrest-using site.  Changes to the
+        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
+        is not handled, passes through to be handled by the default Forrest
+        sitemaps - obviously extremely powerful. The capability is described
+        in 
+        "<a href="../docs/project-sitemap.html">Using project sitemaps</a>".
+      </p>
+<p>
+        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>
       
 </p>
 </div>
 
-
     
-<a name="N10034"></a><a name="overview"></a>
+<a name="N1004B"></a><a name="overview"></a>
 <h2 class="underlined_10">Sitemap Overview</h2>
 <div class="section">
 <p>
@@ -506,7 +524,7 @@
     -->
 
     
-<a name="N1010B"></a><a name="source_pipelines"></a>
+<a name="N10122"></a><a name="source_pipelines"></a>
 <h2 class="underlined_10">Source pipelines (**.xml)</h2>
 <div class="section">
 <p>
@@ -545,7 +563,7 @@
 (*.xml)
                         (in forrest.xmap, faq.xmap, etc)
       </pre>
-<a name="N10136"></a><a name="forrest_xmap"></a>
+<a name="N1014D"></a><a name="forrest_xmap"></a>
 <h3 class="underlined_5">forrest.xmap</h3>
 <p>
           Most of the usual Source pipelines are defined in
@@ -567,7 +585,7 @@
             &lt;map:transform src="{forrest:stylesheets}/howto2document.xsl" /&gt;
           &lt;/map:when&gt;
           </pre>
-<a name="N1015E"></a><a name="other_source"></a>
+<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
@@ -601,7 +619,7 @@
         &lt;/map:match&gt;
         ....
         ....</pre>
-<a name="N10171"></a><a name="late_binding_pipelines"></a>
+<a name="N10188"></a><a name="late_binding_pipelines"></a>
 <h4>Late-binding pipelines</h4>
 <p>
             One point of interest here is that the sub-sitemap is often not
@@ -624,7 +642,7 @@
 </div>
 
     
-<a name="N1019C"></a><a name="output_pipelines"></a>
+<a name="N101B3"></a><a name="output_pipelines"></a>
 <h2 class="underlined_10">Output pipelines</h2>
 <div class="section">
 <p>
@@ -636,7 +654,7 @@
         We now wish to render the XML from these pipelines to output formats
         like HTML and PDF.
       </p>
-<a name="N101AB"></a><a name="pdf"></a>
+<a name="N101C2"></a><a name="pdf"></a>
 <h3 class="underlined_5">PDF output</h3>
 <p>
           Easiest case first; PDFs don't require menus or headers, so we can
@@ -675,7 +693,7 @@
         
 </ol>
 <p>Lastly, we generate a PDF using the fo2pdf serializer.</p>
-<a name="N101E5"></a><a name="html"></a>
+<a name="N101FC"></a><a name="html"></a>
 <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.
@@ -721,10 +739,10 @@
         </pre>
 </div>
     
-<a name="N1022F"></a><a name="intermediate_pipelines"></a>
+<a name="N10246"></a><a name="intermediate_pipelines"></a>
 <h2 class="underlined_10">Intermediate pipelines</h2>
 <div class="section">
-<a name="N10235"></a><a name="body_pipeline"></a>
+<a name="N1024C"></a><a name="body_pipeline"></a>
 <h3 class="underlined_5">Page body</h3>
 <p>Here is the matcher which generates the page body:</p>
 <pre class="code">
@@ -784,7 +802,7 @@
             &lt;html&gt; and &lt;body&gt;) suitable for merging with the
menu and tabs.</li>
         
 </ol>
-<a name="N1027A"></a><a name="menu_pipeline"></a>
+<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>
 <pre class="code">
@@ -803,7 +821,7 @@
 <p>How the menu XML is actually generated (the *book-*.html pipeline) is
           sufficiently complex to require a 
           <a href="#menu_xml_generation">section of its own</a>.</p>
-<a name="N102A0"></a><a name="tab_pipeline"></a>
+<a name="N102B7"></a><a name="tab_pipeline"></a>
 <h3 class="underlined_5">Page tabs</h3>
 <p>Tab generation is quite tame compared to menus:</p>
 <pre class="code">
@@ -823,7 +841,7 @@
 </div>
 
     
-<a name="N102BC"></a><a name="menu_xml_generation"></a>
+<a name="N102D3"></a><a name="menu_xml_generation"></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>
@@ -924,7 +942,7 @@
 </div>
 
     
-<a name="N10342"></a><a name="linkrewriting_impl"></a>
+<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
@@ -933,7 +951,7 @@
 <p>This statement is Cocoon's linking system in action.  A full
         description is provided in <a href="../docs/linking.html">Menus and
           Linking</a>.  Here we describe the implementation of linking.</p>
-<a name="N10359"></a><a name="input_modules"></a>
+<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
@@ -964,13 +982,13 @@
           <a class="external" href="http://issues.apache.org/bugzilla/show_bug.cgi?id=15611">LinkRewriterTransformer</a>,
           currently distributed as a "block" in Cocoon 2.1
         </p>
-<a name="N1038D"></a><a name="implement_rewriting"></a>
+<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
           accomplished as follows.
         </p>
-<a name="N1039C"></a><a name="cocoon_xconf"></a>
+<a name="N103B3"></a><a name="cocoon_xconf"></a>
 <h4>cocoon.xconf</h4>
 <p>First, we declare all the input modules we will be needing:</p>
 <pre class="code">
@@ -1014,7 +1032,7 @@
 <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
             the next section.</p>
-<a name="N103DA"></a><a name="sitemap"></a>
+<a name="N103F1"></a><a name="sitemap"></a>
 <h4>sitemap.xmap</h4>
 <p>
             Now in the sitemap, we define the LinkRewriterTransformer, and
@@ -1114,7 +1132,7 @@
             <span class="codefrag">cocoon:/community/linkmap-index.html</span>
           
 </p>
-<a name="N1044D"></a><a name="dynamic_linkmap"></a>
+<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

Modified: forrest/site/docs/sitemap-ref.pdf
==============================================================================
Binary files. No diff available.

Modified: forrest/site/docs/your-project.html
==============================================================================
--- forrest/site/docs/your-project.html	(original)
+++ forrest/site/docs/your-project.html	Sun Oct  3 20:50:04 2004
@@ -985,15 +985,17 @@
 <div class="frame note">
 <div class="label">Note</div>
 <div class="content">
-        The sitemap syntax is described in the 
-        <a class="external" href="http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html">Cocoon
sitemap docs</a>.  The Forrest
-        sitemap is broken into multiple files. The main one is
+        We advise you to spend time to understand the Apache Cocoon sitemap.
+        See <a class="external" href="http://cocoon.apache.org/2.1/userdocs/concepts/sitemap.html">Cocoon
sitemap</a>
+        and <a class="external" href="http://cocoon.apache.org/2.1/userdocs/concepts/">Cocoon
concepts</a>
+        and related component documentation.
+        The Forrest sitemap is broken into multiple files. The main one is
         <strong>sitemap.xmap</strong> which delegates to others.  See the
          <a href="../docs/sitemap-ref.html">Sitemap Reference</a> for a tour
of the
         default sitemap.
       </div>
 </div>
-<a name="N101BC"></a><a name="adding_new_content_type"></a>
+<a name="N101C0"></a><a name="adding_new_content_type"></a>
 <h3 class="underlined_5">Example: Adding a new content type</h3>
 <p>
           Follow this worked example. In a fresh directory do 'forrest seed'
@@ -1131,7 +1133,7 @@
             will handle the aggregation with navigation menus etc. and will
             apply the normal skin.
           </p>
-<a name="N101FE"></a><a name="new_dtd"></a>
+<a name="N10202"></a><a name="new_dtd"></a>
 <h4>Registering a new DTD</h4>
 <p>
                  By default, Forrest requires that all XML files be valid, i.e.
@@ -1157,7 +1159,7 @@
                  Please see <a href="../docs/validation.html">XML Validation</a>
                  for the full story.
                </p>
-<a name="N10223"></a><a name="adding_new_content_type_2"></a>
+<a name="N10227"></a><a name="adding_new_content_type_2"></a>
 <h3 class="underlined_5">Example: Adding a new content type (advanced)</h3>
 <p>
               The simple user sitemap in the previous example is fine for
@@ -1225,7 +1227,7 @@
               can be used, because the project sitemap is the first sitemap
               to be consulted.
             </p>
-<a name="N1023E"></a><a name="integrating_rss"></a>
+<a name="N10242"></a><a name="integrating_rss"></a>
 <h3 class="underlined_5">Example: integrating external RSS content</h3>
 <p>Similar to the previous example, we can integrate RSS into our
               site simply by providing a match in our project sitemap.xmap ...
@@ -1257,7 +1259,7 @@
 </div>
 
       
-<a name="N10259"></a><a name="skins"></a>
+<a name="N1025D"></a><a name="skins"></a>
 <h2 class="underlined_10">Forrest skins</h2>
 <div class="section">
 <p>
@@ -1277,7 +1279,7 @@
           many capabilities so that extra skins are not needed.
         </div>
 </div>
-<a name="N10272"></a><a name="skin-configuration"></a>
+<a name="N10276"></a><a name="skin-configuration"></a>
 <h3 class="underlined_5">Configuration of skins</h3>
 <p>
           All configuration is done via your project
@@ -1285,7 +1287,7 @@
           It contains many comments to describe each capability.
           Please read those, there is no point repeating here.
           </p>
-<a name="N1027F"></a><a name="new_skin"></a>
+<a name="N10283"></a><a name="new_skin"></a>
 <h3 class="underlined_5">Defining a new skin</h3>
 <p>Consider discussing your needs on the mailing lists. There may
           be planned enhancements to the core skins. Also consider contributing
@@ -1353,7 +1355,7 @@
 </div>
 
     
-<a name="N102C3"></a><a name="webapp"></a>
+<a name="N102C7"></a><a name="webapp"></a>
 <h2 class="underlined_10">Interactive Forrest: faster turnaround when developing your
docs</h2>
 <div class="section">
 <p>
@@ -1367,7 +1369,7 @@
         a "live" Forrest webapp instance, the Forrest-based documentation
         development can be faster and easier than with comparable tools.
       </p>
-<a name="N102D4"></a><a name="forrest_run"></a>
+<a name="N102D8"></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
@@ -1379,7 +1381,7 @@
           servlet container, type <span class="codefrag">forrest webapp</span>
to build an open
           webapp in <span class="codefrag">build/webapp/</span>)
         </p>
-<a name="N102ED"></a><a name="using_webapp"></a>
+<a name="N102F1"></a><a name="using_webapp"></a>
 <h4>Using the webapp</h4>
 <p>
             You can now edit the XML content in
@@ -1388,7 +1390,7 @@
           </p>
 </div>
     
-<a name="N102FC"></a><a name="invoking_from_ant"></a>
+<a name="N10300"></a><a name="invoking_from_ant"></a>
 <h2 class="underlined_10">Invoking Forrest from Ant</h2>
 <div class="section">
 <p>

Modified: forrest/site/docs/your-project.pdf
==============================================================================
Binary files. No diff available.

Modified: forrest/site/faq.html
==============================================================================
--- forrest/site/faq.html	(original)
+++ forrest/site/faq.html	Sun Oct  3 20:50:04 2004
@@ -1008,7 +1008,7 @@
     &lt;map:generate src="{project:content.xdocs}resolver-{1}.xml"/&gt;
     &lt;map:transform
       src="file:///usr/share/sgml/docbook/xsl-stylesheets/xhtml/docbook.xsl"/&gt;
-    &lt;map:serialize type="xml"/&gt;
+    &lt;map:serialize type="xhtml"/&gt;
    &lt;/map:match&gt;
   &lt;/map:pipeline&gt;
  &lt;/map:pipelines&gt;

Modified: forrest/site/faq.pdf
==============================================================================
Binary files. No diff available.

Modified: forrest/site/faq.xml
==============================================================================
--- forrest/site/faq.xml	(original)
+++ forrest/site/faq.xml	Sun Oct  3 20:50:04 2004
@@ -446,11 +446,11 @@
 &lt;map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0"&gt;
  &lt;map:pipelines&gt;
   &lt;map:pipeline&gt;
-    &lt;map:match pattern="**/resolver-*.html"&gt;
-      &lt;map:generate src="{project:content.xdocs}{1}/resolver-{2}.xml"/&gt;
-      &lt;map:transform
-          src="file:///usr/share/sgml/docbook/xsl/xhtml/docbook.xsl"/&gt;
-      &lt;map:serialize/&gt;
+   &lt;map:match pattern="resolver-*.html"&gt;
+    &lt;map:generate src="{project:content.xdocs}resolver-{1}.xml"/&gt;
+    &lt;map:transform
+      src="file:///usr/share/sgml/docbook/xsl-stylesheets/xhtml/docbook.xsl"/&gt;
+    &lt;map:serialize type="xhtml"/&gt;
    &lt;/map:match&gt;
   &lt;/map:pipeline&gt;
  &lt;/map:pipelines&gt;

Modified: forrest/site/linkmap.html
==============================================================================
--- forrest/site/linkmap.html	(original)
+++ forrest/site/linkmap.html	Sun Oct  3 20:50:04 2004
@@ -724,6 +724,7 @@
       
       
       
+      
     
 </ul>
     

Mime
View raw message