If a project has a sitemap.xmap file in it's @@ -300,10 +313,10 @@
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.
+- The Cocoon sitemap syntax is documented fully - in Cocoon's documentation. 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.
+ - +- 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.
- The best way to experiment with the sitemap is to do 'forrest - run' on a Forrest-using site. Changes to the + You can add pre-processing sitemaps to your project + src/documentation directory (or wherever + ${project.sitemap-dir} 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 + "Using project sitemaps". +
++ Another way to experiment with the sitemap is to do 'forrest + run' on a Forrest-using site. Changes to the core *.xmap files will now be immediately visible at >http://localhost:8888/
@@ -545,7 +563,7 @@ (*.xml) (in forrest.xmap, faq.xmap, etc) - +
Most of the usual Source pipelines are defined in @@ -567,7 +585,7 @@ <map:transform src="{forrest:stylesheets}/howto2document.xsl" /> </map:when> - +
As mentioned above, all non-core Source pipelines are distributed in independent *.xmap files. There is a block of @@ -601,7 +619,7 @@ </map:match> .... .... - +
One point of interest here is that the sub-sitemap is often not @@ -624,7 +642,7 @@
@@ -636,7 +654,7 @@ We now wish to render the XML from these pipelines to output formats like HTML and PDF.
- +Easiest case first; PDFs don't require menus or headers, so we can @@ -675,7 +693,7 @@
Lastly, we generate a PDF using the fo2pdf serializer.
- +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 @@
Here is the matcher which generates the page body:
@@ -784,7 +802,7 @@
<html> and <body>) suitable for merging with the menu and tabs.
-
+
Page menu
In the sitemap.xmap file, the matcher generating HTML for the menu is:
@@ -803,7 +821,7 @@
How the menu XML is actually generated (the *book-*.html pipeline) is
sufficiently complex to require a
section of its own.
-
+
Page tabs
Tab generation is quite tame compared to menus:
@@ -823,7 +841,7 @@
The "book" pipeline is defined in sitemap.xmapas:
@@ -924,7 +942,7 @@In numerous places in sitemap.xmap you will see the @@ -933,7 +951,7 @@
This statement is Cocoon's linking system in action. A full description is provided in Menus and Linking. Here we describe the implementation of linking.
- +The implementation of site: linking is heavily based on @@ -964,13 +982,13 @@ LinkRewriterTransformer, currently distributed as a "block" in Cocoon 2.1
- +Using the above components, "site:" URI rewriting is accomplished as follows.
- +First, we declare all the input modules we will be needing:
@@ -1014,7 +1032,7 @@However at the moment, we have only declared the input modules. They will be configured in sitemap.xmap as described in the next section.
- +sitemap.xmap
Now in the sitemap, we define the LinkRewriterTransformer, and @@ -1114,7 +1132,7 @@ cocoon:/community/linkmap-index.html
- +Dynamically generating a linkmap
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 @@
- +Note- The sitemap syntax is described in the - Cocoon sitemap docs. 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 Cocoon sitemap + and Cocoon concepts + and related component documentation. + The Forrest sitemap is broken into multiple files. The main one is sitemap.xmap which delegates to others. See the Sitemap Reference for a tour of the default sitemap.Example: Adding a new content type
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.
- +Registering a new DTD
By default, Forrest requires that all XML files be valid, i.e. @@ -1157,7 +1159,7 @@ Please see XML Validation for the full story.
- +Example: Adding a new content type (advanced)
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.
- +Example: integrating external RSS content
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 @@
@@ -1277,7 +1279,7 @@ many capabilities so that extra skins are not needed.
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.
- +Consider discussing your needs on the mailing lists. There may be planned enhancements to the core skins. Also consider contributing @@ -1353,7 +1355,7 @@
@@ -1367,7 +1369,7 @@ a "live" Forrest webapp instance, the Forrest-based documentation development can be faster and easier than with comparable tools.
- +Type 'forrest run' in your project root to start Forrest's @@ -1379,7 +1381,7 @@ servlet container, type forrest webapp to build an open webapp in build/webapp/)
- +You can now edit the XML content in @@ -1388,7 +1390,7 @@
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 @@ <map:generate src="{project:content.xdocs}resolver-{1}.xml"/> <map:transform src="file:///usr/share/sgml/docbook/xsl-stylesheets/xhtml/docbook.xsl"/> - <map:serialize type="xml"/> + <map:serialize type="xhtml"/> </map:match> </map:pipeline> </map:pipelines> 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 @@ <map:sitemap xmlns:map="http://apache.org/cocoon/sitemap/1.0"> <map:pipelines> <map:pipeline> - <map:match pattern="**/resolver-*.html"> - <map:generate src="{project:content.xdocs}{1}/resolver-{2}.xml"/> - <map:transform - src="file:///usr/share/sgml/docbook/xsl/xhtml/docbook.xsl"/> - <map:serialize/> + <map:match pattern="resolver-*.html"> + <map:generate src="{project:content.xdocs}resolver-{1}.xml"/> + <map:transform + src="file:///usr/share/sgml/docbook/xsl-stylesheets/xhtml/docbook.xsl"/> + <map:serialize type="xhtml"/> </map:match> </map:pipeline> </map:pipelines> 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 @@ +