Return-Path: Delivered-To: apmail-forrest-svn-archive@www.apache.org Received: (qmail 53958 invoked from network); 28 Mar 2007 06:35:37 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 28 Mar 2007 06:35:37 -0000 Received: (qmail 85759 invoked by uid 500); 28 Mar 2007 06:35:36 -0000 Delivered-To: apmail-forrest-svn-archive@forrest.apache.org Received: (qmail 85713 invoked by uid 500); 28 Mar 2007 06:35:36 -0000 Mailing-List: contact svn-help@forrest.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: "Forrest Developers List" List-Id: Delivered-To: mailing list svn@forrest.apache.org Received: (qmail 85690 invoked by uid 99); 28 Mar 2007 06:35:34 -0000 X-ASF-Spam-Status: No, hits=-99.5 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [140.211.11.3] (HELO eris.apache.org) (140.211.11.3) by apache.org (qpsmtpd/0.29) with ESMTP; Tue, 27 Mar 2007 23:35:31 -0700 Received: by eris.apache.org (Postfix, from userid 65534) id 7FC981A9838; Tue, 27 Mar 2007 23:34:33 -0700 (PDT) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r523195 [1/2] - in /forrest/site: ./ docs_0_80/ docs_0_80/howto/ procedures/release/ Date: Wed, 28 Mar 2007 06:34:32 -0000 To: svn@forrest.apache.org From: crossley@apache.org X-Mailer: svnmailer-1.1.0 Message-Id: <20070328063433.7FC981A9838@eris.apache.org> X-Virus-Checked: Checked by ClamAV on apache.org Author: crossley Date: Tue Mar 27 23:34:31 2007 New Revision: 523195 URL: http://svn.apache.org/viewvc?view=rev&rev=523195 Log: Automatic publish from forrestbot Modified: forrest/site/committed-1.png forrest/site/docs_0_80/changes.html forrest/site/docs_0_80/changes.pdf forrest/site/docs_0_80/changes.rss forrest/site/docs_0_80/changes.xml forrest/site/docs_0_80/glossary.html forrest/site/docs_0_80/glossary.pdf forrest/site/docs_0_80/howto/howto-custom-html-source.html forrest/site/docs_0_80/howto/howto-custom-html-source.pdf forrest/site/docs_0_80/locationmap.html forrest/site/docs_0_80/locationmap.pdf forrest/site/docs_0_80/sitemap-ref.html forrest/site/docs_0_80/sitemap-ref.pdf forrest/site/forrest-issues.html forrest/site/forrest-issues.pdf forrest/site/procedures/release/How_to_release.html forrest/site/procedures/release/How_to_release.pdf forrest/site/procedures/release/announce_code_freeze.txt forrest/site/procedures/release/test_and_vote_on_rel_cand.txt Modified: forrest/site/committed-1.png URL: http://svn.apache.org/viewvc/forrest/site/committed-1.png?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== Binary files - no diff available. Modified: forrest/site/docs_0_80/changes.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/changes.html?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== --- forrest/site/docs_0_80/changes.html (original) +++ forrest/site/docs_0_80/changes.html Tue Mar 27 23:34:31 2007 @@ -343,13 +343,13 @@ Version 0.7.1-dev (not released) @@ -360,16 +360,16 @@ Changes to Project Administration
  • -Changes to Build +Changes to Build
  • -Changes to the Code Base +Changes to the Code Base
  • -Changes to Documentation +Changes to Documentation
  • -Contributors to this release +Contributors to this release
  • @@ -377,19 +377,19 @@ Version 0.6 (2004-10-15) @@ -397,13 +397,13 @@ Version 0.5.1 (2003-10-06) @@ -411,13 +411,13 @@ Version 0.5 (2003-09-13) @@ -425,13 +425,13 @@ Version 0.4 (2003-02-12) @@ -439,16 +439,16 @@ Version 0.3 (2003-01-30) @@ -456,10 +456,10 @@ Version 0.2 (2002-11-16) @@ -467,22 +467,22 @@ Version 0.2rc1 (2002-11-13) @@ -520,6 +520,14 @@
    • add + Add initial DOAP plugin to Whiteboard. + Committed by RDG.
    • +
    • +add + Add initial Solr plugin to Whiteboard. + Committed by TS.
    • +
    • +add Added initial whiteboard input plugin "odt". Use OpenDocument ODT as input. Committed by TS.
    • @@ -802,6 +810,12 @@ Diff Committed by RDG.
    • +update + Rename webapp build target to run-webapp to distinguish the resulting + webapp from one suitable for deployment (use the war target for that) + and provide a new xconf that is used in the war to ensure plugins can be found in war files + Committed by RDG. See Issue FOR-735.
    • +
    • update FOR-924 Readding the loading from (default-)forrest.properties which got removed in r430588 when closing FOR-916. Thanks Martin Stockhammer for pointing it out, providing us with a patch and for your @@ -1057,7 +1071,7 @@ forrest site fails resume dtd validation Diff Committed by TS. Thanks to kevin. See Issue FOR-670.
    - +

    Changes to Documentation

    • @@ -1260,21 +1274,21 @@ how to debug forrest java classes to the faq Diff Committed by TS.
    - +

    Contributors to this release

    We thank the following people for their contributions to this release.

    This is a list of all people who participated as committers:
    Antonio Gallardo (AG), Bertrand Delacretaz (BD), Cyriaque Dupoirieux (CD), David Crossley (DC), Diwaker Gupta (DG), Ferdinand Soethe (FSO), Juan Jose Pablos (JJP), Johannes Schaefer (JS), Ross Gardler (RDG), Thorsten Scherler (TS), Tim Williams (TWW).

    This is a list of other contributors:
    Addison Berry, Alan Chandler, Anil Ramnanan, Brian Dube, Clay Leeds, Community, Dave Brosius, David Crossley, Gavin, Gavin McDonald, Jan Materne, Jim Dixon, Joachim Breitsprecher, Josias Thoeny, kevin, Martin Stockhammer, Mathieu Champlon, Paul Devine, Paul Kronenwetter, Phillip Evens, Pier Fumagalli, Rasik Pandey, Richard Calmbach, Ross Gardler, Sjur N. Moshagen, Steve Masover, Tom HANAX, Torsten Stolpmann.

    - +

    Version 0.7.1-dev (not released)

    See each plugin for its detailed changes.

    - +

    Changes to the Code Base

    • @@ -1310,7 +1324,7 @@ Doing 'forrest clean' will remove both sections. Committed by DC.
    - +

    Changes to Documentation

    - +

    Contributors to this release

    We thank the following people for their contributions to this release.

    This is a list of all people who participated as committers:
    David Crossley (DC), Ferdinand Soethe (FSO).

    This is a list of other contributors:
    Steve Masover.

    - +

    Version 0.7 (2005-06-23)

    See each plugin for its detailed changes.

    - +

    Changes to Project Administration

    • @@ -1342,7 +1356,7 @@ Added testing facilities to plugins to facilitate integration testing. Committed by RDG.
    - +

    Changes to Build

    • @@ -1352,7 +1366,7 @@ Ant "import" task. Committed by DC.
    - +

    Changes to the Code Base

    • @@ -1485,6 +1499,18 @@ to the Cocoon cli.xconf Committed by DC. Thanks to Upayavira. See Issue FOR-204.
    • +add + Add initial PDF plugin + Committed by RDG.
    • +
    • +add + Add initial Wiki plugin + Committed by RDG.
    • +
    • +add + Add initial Feeder plugin + Committed by RDG.
    • +
    • fix The "extra-css" from skinconf.xml is now inserted at the very end of the CSS. That enables it to properly override other elements. @@ -1629,7 +1655,7 @@ starting with Forrest-0.7-dev Committed by DC.
    - +

    Changes to Documentation

    • @@ -1719,17 +1745,17 @@ tab to create subject-specific aggregated documents. Committed by TS.
    - +

    Contributors to this release

    We thank the following people for their contributions to this release.

    This is a list of all people who participated as committers:
    Antonio Gallardo (AG), Dave Brondsema (DB), David Crossley (DC), Juan Jose Pablos (JJP), Ross Gardler (RDG), Rick Tessner (RFT), Thorsten Scherler (TS).

    This is a list of other contributors:
    Cyriaque Dupoirieux, Ferdinand Soethe, Florian G. Haas, Gary Feldman, Ian P. Springer, Joao Ferreira, Johannes Schaefer, Jörg Werner, Kevin, Mark Eggers, Ron Blaschke, Sjur N. Moshagen, Stephan E. Schlierf, Tamara Harpster, Upayavira.

    - +

    Version 0.6 (2004-10-15)

    - +

    Changes to Project Administration

    • @@ -1740,7 +1766,7 @@ OpenSymphony's OSUser for flexible authentication. Committed by DB.
    - +

    Changes to Build

    • @@ -1764,7 +1790,7 @@ Add more descriptions to forrest targets. Highlight the most common ones. Committed by DB. See Issue FOR-216.
    - +

    Changes to the Code Base

    • @@ -2499,7 +2525,7 @@ Sort action types order to "add","remove","update","fix". Committed by JJP.
    - +

    Changes to Documentation

    - +

    Contributors to this release

    We thank the following people for their contributions to this release.

    This is a list of all people who participated as committers:
    Antonio Gallardo (AG), Dave Brondsema (DB), David Crossley (DC), Juan Jose Pablos (JJP), Nicola Ken Barozzi (NKB), Ross Gardler (RDG), Reinhard Pötz (RP), Thorsten Scherler (TS).

    @@ -2564,10 +2590,10 @@
    - +

    Version 0.5.1 (2003-10-06)

    - +

    Changes to Build

    • @@ -2575,7 +2601,7 @@ forrest.antproxy.xml script now properly fails when Cocoon fails Committed by JT.
    - +

    Changes to the Code Base

    • @@ -2612,17 +2638,17 @@ ~/.antrc, which solves problems on some *nix distributions. Committed by JT.
    - +

    Contributors to this release

    We thank the following people for their contributions to this release.

    This is a list of all people who participated as committers:
    Jeff Turner (JT).

    - +

    Version 0.5 (2003-09-13)

    - +

    Changes to the Code Base

    • @@ -3000,7 +3026,7 @@ the xinclude, linkrewriter, and idgen steps. Committed by NKB.
    - +

    Changes to Documentation

    • @@ -3009,17 +3035,17 @@ upgrading to v0.5 Committed by JT.
    - +

    Contributors to this release

    We thank the following people for their contributions to this release.

    This is a list of all people who participated as committers:
    David Crossley (DC), Juan Jose Pablos (JJP), Jeff Turner (JT), Nicola Ken Barozzi (NKB), Steven Noels (SN).

    This is a list of other contributors:
    Dave Brondsema, Eirik Bjørsnøs, Frederic Robesyn, J.Pietschmann, Joerg Heinicke, Juan Jose Pablos, Ralf Hauser, Ramón Prades, Ringo de Smet, Ross Gardler, Stefan Bodewig.

    - +

    Version 0.4 (2003-02-12)

    - +

    Changes to the Code Base

    • @@ -3096,7 +3122,7 @@ Switched all loglevels to ERROR. Committed by NKB.
    - +

    Changes to Documentation

    • @@ -3105,7 +3131,7 @@ to the forrestbar.xpi generated by Gump every day. Committed by NKB.
    - +

    Contributors to this release

    We thank the following people for their contributions to this release.

    This is a list of all people who participated as committers:
    Jeff Turner (JT), Marc Portier (MP), Nicola Ken Barozzi (NKB).

    @@ -3113,10 +3139,10 @@
    - +

    Version 0.3 (2003-01-30)

    - +

    Changes to Build

    • @@ -3131,7 +3157,7 @@ instead of Cocoon + Centipede logos. Committed by JT.
    - +

    Changes to the Code Base

    • @@ -3362,7 +3388,7 @@ We need icons for the new buttons. Committed by NKB.
    - +

    Changes to Documentation

    • @@ -3372,17 +3398,17 @@ Stylesheets not yet done. Committed by NKB.
    - +

    Contributors to this release

    We thank the following people for their contributions to this release.

    This is a list of all people who participated as committers:
    David Crossley (DC), Jeff Turner (JT), Nicola Ken Barozzi (NKB).

    This is a list of other contributors:
    Nick Chalko, Omar Belhaj, Stefan Michels.

    - +

    Version 0.2 (2002-11-16)

    - +

    Changes to the Code Base

    • @@ -3401,16 +3427,16 @@ Webapp now works under JDK 1.3 (parsers weren't being copied) Committed by JT.
    - +

    Contributors to this release

    We thank the following people for their contributions to this release.

    This is a list of all people who participated as committers:
    David Crossley (DC), Jeff Turner (JT).

    - +

    Version 0.2rc1 (2002-11-13)

    - +

    Changes to Project Administration

    • @@ -3418,7 +3444,7 @@ Initial Import Committed by SM.
    - +

    Changes to Build

    • @@ -3518,7 +3544,7 @@ Added basic Forrest descriptor. Committed by NKB.
    - +

    Changes to the Code Base

    • @@ -3666,7 +3692,7 @@ Put the internal matches in a separate pipeline with internal-only="true". Committed by NKB.
    - +

    Changes to Design

    • @@ -3675,7 +3701,7 @@ cross-browser issues. Committed by BK.
    - +

    Changes to Documentation

    • @@ -3763,14 +3789,14 @@ validated using these DTDs and OASIS Catalogs. Committed by DC. Thanks to Steven Noels.
    - +

    Contributors to this release

    We thank the following people for their contributions to this release.

    This is a list of all people who participated as committers:
    Bert Van Kets (BK), David Crossley (DC), Jeff Turner (JT), Nicola Ken Barozzi (NKB), Stefano Mazzocchi (SM), Steven Noels (SN).

    This is a list of other contributors:
    Bert Van Kets, Bruno Dumon, Kevin Ross, Leo Simons, Marc Portier, Peter Donald, Steven Noels.

    - +

    All Committers

    This is a list of all people who have ever participated Modified: forrest/site/docs_0_80/changes.pdf URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/changes.pdf?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== Binary files - no diff available. Modified: forrest/site/docs_0_80/changes.rss URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/changes.rss?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== --- forrest/site/docs_0_80/changes.rss (original) +++ forrest/site/docs_0_80/changes.rss Tue Mar 27 23:34:31 2007 @@ -61,6 +61,36 @@ code update + (bug FOR-735) + changes.htmlcode update + by + RDG + (fixes bug FOR-735) + + : + + Rename webapp build target to run-webapp to distinguish the resulting + webapp from one suitable for deployment (use the war target for that) + and provide a new xconf that is used in the war to ensure plugins can be found in war files + + + code addchanges.htmlcode add + by + RDG + : + + Add initial DOAP plugin to Whiteboard. + + + code addchanges.htmlcode add + by + TS + : + + Add initial Solr plugin to Whiteboard. + + + code update (bug FOR-924) changes.htmlcode update by @@ -2216,6 +2246,30 @@ Java 1.4 is required starting with Forrest-0.7-dev + + code addchanges.htmlcode add + by + RDG + : + + Add initial PDF plugin + + + code addchanges.htmlcode add + by + RDG + : + + Add initial Wiki plugin + + + code addchanges.htmlcode add + by + RDG + : + + Add initial Feeder plugin + code addchanges.htmlcode add @@ -5486,6 +5540,30 @@ Added document to facilitate upgrading to v0.8 + code update + (bug FOR-735) + changes.htmlcode update + by + RDG + (fixes bug FOR-735) + + : + + Rename webapp build target to run-webapp to distinguish the resulting + webapp from one suitable for deployment (use the war target for that) + and provide a new xconf that is used in the war to ensure plugins can be found in war files + code addchanges.htmlcode add + by + RDG + : + + Add initial DOAP plugin to Whiteboard. + code addchanges.htmlcode add + by + TS + : + + Add initial Solr plugin to Whiteboard. code update (bug FOR-924) changes.htmlcode update Modified: forrest/site/docs_0_80/changes.xml URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/changes.xml?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== --- forrest/site/docs_0_80/changes.xml (original) +++ forrest/site/docs_0_80/changes.xml Tue Mar 27 23:34:31 2007 @@ -8,6 +8,10 @@

    Changes to Build
    • Add new build target "clean-build". Committed by CD.
    Changes to the Code Base
    • + Add initial DOAP plugin to Whiteboard. + Committed by RDG.
    • + Add initial Solr plugin to Whiteboard. + Committed by TS.
    • Added initial whiteboard input plugin "odt". Use OpenDocument ODT as input. Committed by TS.
    • @@ -192,7 +196,11 @@ Remove xconf support for plugins. Cocoon has moved away from this XConfToolTask xpatch technique. Diff - Committed by RDG.
    • FOR-924 Readding the loading from + Committed by RDG.
    • + Rename webapp build target to run-webapp to distinguish the resulting + webapp from one suitable for deployment (use the war target for that) + and provide a new xconf that is used in the war to ensure plugins can be found in war files + Committed by RDG. See Issue FOR-735.
    • FOR-924 Readding the loading from (default-)forrest.properties which got removed in r430588 when closing FOR-916. Thanks Martin Stockhammer for pointing it out, providing us with a patch and for your contribution. Committed by TS. Thanks to Martin Stockhammer. See Issue FOR-924.
    • @@ -587,7 +595,13 @@ The brokenlinks file now contains referer information. Upgraded lib/core/cocoon.jar and added attribute "show-referrers" to the Cocoon cli.xconf - Committed by DC. Thanks to Upayavira. See Issue FOR-204.
    • + Committed by DC. Thanks to Upayavira. See Issue FOR-204.
    • + Add initial PDF plugin + Committed by RDG.
    • + Add initial Wiki plugin + Committed by RDG.
    • + Add initial Feeder plugin + Committed by RDG.
    • The "extra-css" from skinconf.xml is now inserted at the very end of the CSS. That enables it to properly override other elements. Committed by DC.
    • Modified: forrest/site/docs_0_80/glossary.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/glossary.html?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== --- forrest/site/docs_0_80/glossary.html (original) +++ forrest/site/docs_0_80/glossary.html Tue Mar 27 23:34:31 2007 @@ -438,7 +438,7 @@ Release Candidate

      - 1. A temporary Forrest release build from trunk during the release process to be tested and evaluated.
      + 1. A temporary Forrest package build from trunk during the release process to be tested and evaluated.

      @@ -488,9 +488,20 @@

      + +Standard Document Format +

      + 1. Forrests internal document format (defined by an XML-grammar). This format ist the common denominator + for all things going into or coming out of Forrest's core processing. All input-plugins will translate their supported documents into this + format, all output-plugins will create the output by transforming this format into something else. Currently Forrest uses document-v13-dtd as its internal format. +
      + +

      + +
    - +

    X

    Modified: forrest/site/docs_0_80/glossary.pdf URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/glossary.pdf?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== Binary files - no diff available. Modified: forrest/site/docs_0_80/howto/howto-custom-html-source.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/howto/howto-custom-html-source.html?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== --- forrest/site/docs_0_80/howto/howto-custom-html-source.html (original) +++ forrest/site/docs_0_80/howto/howto-custom-html-source.html Tue Mar 27 23:34:31 2007 @@ -365,9 +365,6 @@ Third Call for Content
  • -Introducing the File-Resolver -
  • -
  • html-Default Processing
  • @@ -428,11 +425,13 @@
  • - A basic understanding of coocons pipelines and their + A basic understanding of Cocoon's pipelines and their components. You should know about matchers, generators, transformers and serializers and have a rough idea how they work - together in a pipeline ( A good place to start learning about Cocoon is - Understanding Apache Cocoon). + together in a pipeline. A good place to start learning about Cocoon is + Understanding Apache Cocoon. + The Forrest Sitemap Reference + will also be helpful.
  • @@ -450,19 +449,9 @@ - +

    Understanding the HTML-Pipeline

    -
    -
    Warning
    -
    - The example sitemap fragments are out-of-date because since this - document was written, the core sitemaps in main/webapp/ have changed and - some of the specialised processing has moved to plugins. - View your source sitemaps when reading this document. - (See FOR-922.) -
    -

    The first part of this howto explains the html pipeline, so as to provide the background to enable you to add additional processing @@ -470,7 +459,7 @@ then skip to the section about Customizing the html pipeline.

    - +

    Driven by Example

    The best way to learn about Forrest pipelines is follow @@ -481,9 +470,9 @@ So let's see what happens, when a client asks Forrest to serve the document
    - 'http://some.domain.org/mytest/mybad.html'. + 'http://my.domain.org/mytest/mybad.html'.

    - +

    Finding the Sitemap

    Like all applications based on Apache Cocoon, each request for @@ -503,26 +492,17 @@ this file is quite simple in structure and easy to read.

    -

    - To help you to easily follow the next steps, we have added - comments and anchors to 'sitemap.xmap', - so that you can quickly jump to all relevant sections - and read them more easily. -

    - Follow this link to the - + Search for map:sitemap to find the start of the Sitemap. - - -

    +

    - As the comment explains, this sitemap is the starting point + This sitemap is the starting point for all requests. So even if there are other sitemaps (which we will see later on), we always start looking for a matching pattern right here.

    - +

    Find the Beginning of the Pipelines Section

    Modular as everything else in Cocoon, Forrest's sitemap @@ -532,11 +512,7 @@

    So let's skip right to the start of the - Pipelines-Section. Search for <map:pipelines> or - follow this link to the - - beginning of the pipelines-element - + Pipelines-Section. Search for map:pipelines

    @@ -549,39 +525,47 @@ Pipelines from top to bottom until it encounters a Pipeline that will take care of our request.

    - +

    Looking for a Match

    Like all Cocoon applications, Forrest knows which pipeline to use for processing a certain request by looking at the entry criteria for each pipeline it comes - across. These can be a match against a given pattern, + across. This can be a match against a given pattern, the test if a certain files exists or one of many other possible tests that Cocoon supports.

    -

    +

    To better know what we are talking about, let's follow - Forrest down the list to the - - Test for the First Pipeline - . + Forrest down the list to the Test for the First Pipeline:

    +

    + Scroll down to the line + <map:match pattern="cprofile.*"> + +

    Here you can see that very specialized matches need to occur early in the sitemap. The requested file (and pathname) is compared to a pattern - '*.xlex' that would match if our request ended with - '.xlex' and had no pathname. Since it doesn't, we don't + 'cprofile.*' that would match if our request started with + 'cprofile', endet with any kind of extension and had no pathname. Since it doesn't, we don't have a match and need to keep looking.

    - Skip forward until we find the - - First Match for "**/*.html" - - (<map:match pattern="**/*.html">). + Skip forward until you find + <map:match pattern="**/*.html">. +

    - +
    +
    Note
    +
    While scrolling down you may have noticed the match-pattern + <map:match pattern="*.html"> a couple of + lines earlier. This will not match our request since *.something in Cocoon matches only + files in the root directory. +
    +
    +

    Processing in the '**/*.html' Pipeline

    Let's take a quick look at this pipeline to understand @@ -589,18 +573,18 @@

     <map:match pattern="**/*.html">
    -    <map:aggregate element="site">
    -      <map:part src="cocoon:/skinconf.xml"/>
    -      <map:part src="cocoon:/build-info"/>
    -      <map:part src="cocoon:/{1}/tab-{2}.html"/>
    -      <map:part src="cocoon:/{1}/menu-{2}.html"/>
    -      <map:part src="cocoon:/{1}/body-{2}.html"/>
    -    </map:aggregate>
    -    <map:call resource="skinit">
    -      <map:parameter name="type" value="site2xhtml"/>
    -      <map:parameter name="path" value="{0}"/>
    -    </map:call>
    -</map:match>
    + <map:aggregate element="site"> + <map:part src="cocoon:/skinconf.xml"/> + <map:part src="cocoon:/build-info"/> + <map:part src="cocoon:/{1}/tab-{2}.html"/> + <map:part src="cocoon:/{1}/menu-{2}.html"/> + <map:part src="cocoon:/{1}/body-{2}.html"/> + </map:aggregate> + <map:call resource="skinit"> + <map:parameter name="type" value="transform.site.xhtml"/> + <map:parameter name="path" value="{0}"/> + </map:call> + </map:match>

    In the first part of this pipeline, the aggregate-element assembles information required to build @@ -625,7 +609,7 @@ back into our pipeline. (The 'pseudo' goes back to the fact that unlike 'http' or 'ftp', which are real protocols, you can use cocoon: - only within the cocoon environments as only they will know what to + only within the cocoon environments as only Cocoon will know what to do with it.)

    @@ -634,7 +618,7 @@ where it comes from. To find out, we have to look at the sources of the aggregation.

    - +

    Following the Pseudo-Protocols

    To find out what goes into our aggregation, we'll need to look @@ -689,7 +673,7 @@ As you can easily tell, we are suddenly calling for a whole new document. Let's see where that takes us:

    - +

    Second Call for Content

    Processing of cocoon-calls is not much different from @@ -701,12 +685,10 @@ from the beginning and look for a pipeline to match that call.

    - Search for '**body-*.html' from the beginning of the - sitemap or jump to the - First Match for '**body-*.html' - to see where we find our next match. + Search for **body-*.html from the beginning of the + sitemap to see where we find our next match.

    - +

    First Match for '**body-*.html'

    Our first match is different to the previous ones because @@ -715,12 +697,12 @@

     <map:select type="exists">
    -   <map:when test="{properties:content.xdocs}mytests/mybad.ehtml">
    + <map:when test="{lm:project.{1}{2}.ehtml}">

    we quickly discover that there can't be a file of that name in the project-directory.
    - (The variable '{properties:content.xdocs}' is always replaced with + (The variable '{lm:project.}' is always replaced with the name of your project directory that you can change in the 'forrest.properties'-file.)

    @@ -729,12 +711,11 @@ In this case Forrest will simply keep looking for the next match further down.

    - +

    Second Match for '**body-*.html'

    Continue searching downwards for '**body-*.html' in the - sitemap-file or jump directly to the - Second Match for '**body-*.html'. + sitemap-file.

    Looking at the pipeline that handles the request, we see that @@ -789,15 +770,14 @@ we get

    <map:generate src="cocoon:/mytests/mybad.xml"/>
    - +

    Third Call for Content

    So let's scan the main sitemap looking for a match for '/mytests/mybad.xml'.

    - We find it in the pattern - '**.xml'>, + We find it in the pattern <map:match pattern="**.xml">, which is the standard handling for all xml-requests.

    @@ -815,49 +795,43 @@ matching pattern.

    - Our search leads us to the - - Second Match for '**.xml' - , - a pipeline designed to handle internationalisation if that - feature is configured. Since it is not, all it does is - call the file-resolver-resource with the full pathname of - our file but no extension. + Our search first leads us to the matcher <map:match type="wildcard" pattern="**.xml"> + with a number of submatchers embedded into it.

    -
    -<map:call resource="file-resolver">
    -  <map:parameter name="uri" value="mytests/mybad"/>
    -</map:call>
    - -

    Introducing the File-Resolver

    -

    - To find out more about the working of the file-resolver, - search for the definition of the - - <map:resource name="file-resolver"> - - higher up in the file. +

    The first one, <map:match type="wildcard" pattern="**.xml">, would handle input coming from Forrest plugins. + We won't go into details here.

    +

    + All further matchers <map:match type="i18n" pattern="{properties:content.xdocs}{1}.*.xml"> . + implement what we call a cascade of matchers. By testing for the existence of one source file after another Forrest will use and process the + first of the tested source-formats found.

    +
    +
    Note
    +
    Using the i18n-matcher here, Forrest will do a lot more than just finding content in one of many possible source formats. + It will also make sure that the the proper language version of the conent (if there are several) is used. + Read more about this matcher http://cocoon.apache.org/2.1/apidocs/org/apache/cocoon/matching/LocaleMatcher.html +
    +

    - Here you will find a pipeline that tests for the existence of - the file with different extensions. '.html' is second in this + Checking each matcher in turn you will find that a pipeline that tests for the existence of + the file with different extensions. '.html' is third in this list and leads to the processing steps shown below:

    - +

    html-Default Processing

    - The default processing of html-files consists of four + The default processing of html-files consists of three processing steps:

    1. -<map:generate src="{properties:content.xdocs}{uri}.html" type="html"/> +<map:generate src="{source}" type="html" />
      - Using the html-generator, Forrest reads the html-document + Using Cocoons html-generator, Forrest reads the html-document from file and uses JTidy to clean up and convert it to xml - (which is required for all processing in cocoon pipelines). + (which is required for all processing in Cocoon pipelines). At the output of this transformer we will have a valid XHTML-document althought it might still contain some unwanted elements. We'll deal with those later (see @@ -866,17 +840,11 @@
    2. -<map:transform src="{forrest:forrest.stylesheets}/html2document.xsl"/> -
      - Using the standard stylesheet 'html2document.xsl', this XHTML is - transformed into Forrest standard document format. -
    3. - -
    4. - -<map:transform type="idgen"/> +<map:transform src="{lm:transform.html.document}" />
      - This step generates IDs required for navigation within the page. + Using the standard stylesheet 'html-to-document.xsl', this XHTML is + transformed into Forrest's Standard Document Format. (refer to a detailed explanation of locationsmaps + to understand exactly how and where that stylesheet is found!)
    5. @@ -901,12 +869,12 @@ machine and there is an html-page of that name). - +

      Returning to the '**body-*.html'-Pipeline

      On returning into the - '**body-*.html' pipeline, - procesing continues with the next components in this pipeline: + '**body-*.html'-Pipeline (in sitemap.xmap), + processing continues with the next components in this pipeline:

        @@ -932,7 +900,7 @@
      • - The final transformation, as the name suggests, will take + The final transformation, <map:transform src="{lm:transform.html.broken-links}" /> as the name suggests, will take care of reporting broken site-links.
      • @@ -951,7 +919,7 @@ and there is an html-page of that name). - +

        Returning to the '**/*.html'-Pipeline

        At the end of this pipeline, processing returns the results into @@ -960,13 +928,13 @@ merges it with other data, skins and serializes for presentation in the requesting client.

        - +

        Customizing the html pipeline

        In this last part of this document, we will show how to customize the HTML-pipeline to add your additional steps to the default processing.

        - +

        When to customize?

        The html-Pipeline in Forrest is designed to be able to also @@ -988,30 +956,26 @@ then you will see the original page from your legacy website, menu and all, embedded in your new Forrest site.

        - +

        How to customize?

        To add your own custom processing for a group of pages, you will - create a project sitemap with pipelines that process documents + enhance the project sitemap with pipelines that process your documents according to your specifications.

        This project sitemap is located in the file 'src/documentation/sitemap.xmap' in your Forrest project directory - and will be created automatically when you seed a new project. - At this point it contains only one - - pipeline for handling the '**custom.xml'-pattern as an example. + and is created automatically whenever you seed a new project. + At this point it already contains a few examples for custom pipelines.

        To add your own custom processing, edit the file and add a new pipeline to the project sitemap. Since the project sitemap is - loaded into the main sitemap - - right at the top, your pipeline intercepts practically all - of Forrest's standard pipelines. + loaded into the main sitemap right at the top (search for 'This is the user pipeline'), + your pipeline intercepts practically all of Forrest's standard pipelines.

        - +

        What to intercept?

        Where to intercept standard processing is really a matter of your @@ -1031,7 +995,7 @@ copy the steps the original processor is doing and add a transformation of our own to it.

        - +

        Intercept pattern

        Take great care when intercepting very basic pipelines. @@ -1059,23 +1023,21 @@ </map:match> </map:pipeline>

        - Open the 'forrest.xmap', navigate to the file-resolver-section, - copy the four lines for handling *.html files and paste them into - your new pipeline. + Open the 'forrest.xmap', search for <map:match type="i18n" pattern="{properties:content.xdocs}{1}.*.html">, + copy the three lines for handling *.html files and paste them into your new pipeline.

         <!--Custom Pipeline for my bad html-pages-->        
         <map:pipeline>
             <map:match pattern="mytest/*.xml">
        -      <map:generate src="{properties:content.xdocs}{uri}.html" type="html"/>
        -      <map:transform src="{forrest:forrest.stylesheets}/html2document.xsl"/>
        -      <map:transform type="idgen"/>
        +      <map:generate src="mytest/{1}.html" type="html" />
        +      <map:transform src="{lm:transform.html.document}" />
               <map:serialize type="xml-document"/>
             </map:match>
         </map:pipeline>

        Your custom pipeline will now behave exactly like the standard - html-handler. Now all that is left to be done is creating the + html-handler. All that is left to be done is creating the custom transformation and adding it the pipeline.

        @@ -1093,12 +1055,11 @@ <!--Custom Pipeline for my bad html-pages--> <map:pipeline> <map:match pattern="mytest/*.xml"> - <map:generate src="{properties:content.xdocs}{uri}.html" type="html" /> - + <map:generate src="mytest/{1}.html" type="html" /> + <map:transform src="{properties:resources.stylesheets}/fixMyBadHTML.xsl"/> - - <map:transform src="{forrest:forrest.stylesheets}/html2document.xsl" /> - <map:transform type="idgen" /> + + <map:transform src="{lm:transform.html.document}" /> <map:serialize type="xml-document"/> </map:match> </map:pipeline> Modified: forrest/site/docs_0_80/howto/howto-custom-html-source.pdf URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/howto/howto-custom-html-source.pdf?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== Binary files - no diff available. Modified: forrest/site/docs_0_80/locationmap.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/locationmap.html?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== --- forrest/site/docs_0_80/locationmap.html (original) +++ forrest/site/docs_0_80/locationmap.html Tue Mar 27 23:34:31 2007 @@ -467,18 +467,18 @@ Using the Locationmap it is possible to make these files come from elsewhere. This is useful if you want to pull files from different directory structures, or even remote repositories. For example, the following location match - will match any request for a document below "remoteDemo" and will retrieve + will match any request for a document below "remote." and will retrieve the source file from the Apache Forrest SVN repository (directly from the ASF's SVN webserver). This is an ideal way to ensure that your published docs are always up-to-date.

        - <match pattern="remoteDemo/**.xml">
        + <match pattern="project.remote.**.xml">
            <location src="http://svn.apache.org/repos/asf/forrest/trunk/site-author/content/xdocs/{1}.xml" />
          </match>
                 

        Note that because this is a wildcard matcher you can request any page from the svn server simply by requesting - /remoteDemo/PATH/TO/FILE/FILENAME.html. In addition, we + /remote.PATH/TO/FILE/FILENAME.html. In addition, we can request any other output format available via Forrest plugins.

        When including resources from remote repositories one has to be careful about things like site and ext Modified: forrest/site/docs_0_80/locationmap.pdf URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/locationmap.pdf?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== Binary files - no diff available. Modified: forrest/site/docs_0_80/sitemap-ref.html URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/sitemap-ref.html?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== --- forrest/site/docs_0_80/sitemap-ref.html (original) +++ forrest/site/docs_0_80/sitemap-ref.html Tue Mar 27 23:34:31 2007 @@ -413,9 +413,10 @@ 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. + and related component documentation. It is also necessary to understand + the "**" and "*" pattern matching and replacements. See the email thread: + "Re: explain sitemap matches and pass parameters to transformers" + FOR-874. @@ -437,11 +438,13 @@ - +

        Getting started

        - Forrest's sitemap comprises the $FORREST_HOME/main/webapp/*.xmap files. + Forrest's sitemap comprises the multiple $FORREST_HOME/main/webapp/*.xmap files. + The main one is sitemap.xmap which delegates to others, + including to sitemaps in the various plugins.

        You can add pre-processing sitemaps to your project @@ -454,15 +457,15 @@

        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/ + run' on a Forrest-using site. Making changes to the core + *.xmap files will now be immediately effective + at http://localhost:8888/

        - +

        Sitemap Overview

        @@ -606,7 +609,7 @@ --> - +

        Source pipelines (**.xml)

        @@ -646,7 +649,7 @@ (*.xml) (in forrest.xmap, faq.xmap, etc) - +

        forrest.xmap

        Most of the usual Source pipelines are defined in @@ -668,7 +671,7 @@ <map:transform src="{forrest:forrest.stylesheets}/howto-to-document.xsl" /> </map:when> - +

        Other source pipelines

        As mentioned above, all non-core Source pipelines are distributed in independent *.xmap files. There is a block of @@ -702,7 +705,7 @@ </map:match> .... .... - +

        Late-binding pipelines

        One point of interest here is that the sub-sitemap is often not @@ -725,7 +728,7 @@

        - +

        Output pipelines

        @@ -737,7 +740,7 @@ We now wish to render the XML from these pipelines to output formats like HTML and PDF.

        - +

        PDF output

        Note
        @@ -782,7 +785,7 @@

    Lastly, we generate a PDF using the fo2pdf serializer.

    - +

    HTML output

    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. @@ -828,10 +831,10 @@ - +

    Intermediate pipelines

    - +

    Page body

    Here is the matcher which generates the page body:

    @@ -891,7 +894,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:

    @@ -910,7 +913,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:

    @@ -930,7 +933,7 @@
     
         
         
    -
    +
     

    Resolving Resources

    Many resources are resolved by the locationmap. This allow us to provide @@ -942,7 +945,7 @@

    - +

    Menu XML generation

    The "book" pipeline is defined in sitemap.xmapas:

    @@ -1043,7 +1046,7 @@
    - +

    Link rewriting

    In numerous places in sitemap.xmap you will see the @@ -1052,7 +1055,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.

    - +

    Cocoon foundations: Input Modules

    The implementation of site: linking is heavily based on @@ -1083,13 +1086,13 @@ LinkRewriterTransformer, currently distributed as a "block" in Cocoon 2.1

    - +

    Implementing "site:" rewriting

    Using the above components, "site:" URI rewriting is accomplished as follows.

    - +

    cocoon.xconf

    First, we declare all the input modules we will be needing:

    @@ -1133,7 +1136,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 @@ -1233,7 +1236,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_0_80/sitemap-ref.pdf URL: http://svn.apache.org/viewvc/forrest/site/docs_0_80/sitemap-ref.pdf?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== Binary files - no diff available. Modified: forrest/site/forrest-issues.html URL: http://svn.apache.org/viewvc/forrest/site/forrest-issues.html?view=diff&rev=523195&r1=523194&r2=523195 ============================================================================== --- forrest/site/forrest-issues.html (original) +++ forrest/site/forrest-issues.html Tue Mar 27 23:34:31 2007 @@ -192,19 +192,16 @@

    @@ -243,15 +231,7 @@ all open issues). The listing below is regenerated on each Forrest run.
    - -

    [FOR-868] add relevant notes to the "Upgrading" xdoc

    -
    -

    -http://issues.apache.org/jira/browse/FOR-868 -

    -

    We need to add some notes to the upgrading_0*.html doc for the upcoming release. This would most easily be done after attending to <a href="https://issues.apache.org/jira/browse/FOR-865" title="Add missing entries to status.xml to generate the changes list">FOR-865</a> &quot;Add missing entries to status.xml to generate the changes list&quot;.

    -
    - +

    [FOR-911] decide content of release

    @@ -263,7 +243,7 @@ &nbsp;content of release [was: Re: review list of scheduled issues for 0.8 release]<br/> &nbsp;<a href="http://marc.theaimsgroup.com/?t=115257903800001">http://marc.theaimsgroup.com/?t=115257903800001</a>

    - +

    [FOR-855] verify the license situation prior to each release

    @@ -278,6 +258,14 @@ B) Scan the whole trunk repository to add missing ASF license headers to source files and to ensure that the ASF license headers have not been accidently added to external files. See etc/relicense.txt<br/>

    + +

    [FOR-868] add relevant notes to the "Upgrading" xdoc

    +
    +

    +http://issues.apache.org/jira/browse/FOR-868 +

    +

    We need to add some notes to the upgrading_0*.html doc for the upcoming release. This would most easily be done after attending to <a href="https://issues.apache.org/jira/browse/FOR-865" title="Add missing entries to status.xml to generate the changes list">FOR-865</a> &quot;Add missing entries to status.xml to generate the changes list&quot;.

    +

    [FOR-865] Add missing entries to status.xml to generate the changes list

    @@ -291,19 +279,7 @@ Re: better use of changes.html (Was: Community health)<br/> <a href="http://marc.theaimsgroup.com/?t=114274836600001">http://marc.theaimsgroup.com/?t=114274836600001</a>

    - -

    [FOR-735] Plugins are not correctly deployed in webapp mode

    -
    -

    -http://issues.apache.org/jira/browse/FOR-735 -

    -

    (At this point I didn't try this scenario step by step any more; basically it is what we did to setup the site, except that we copied our project data from forrest 0.6 before trying the pdf links)<br/> -<br/> -- run forrest webapp to create an empty webapp<br/> -- configure Tomcat to run the webapp (we did it by creating a context descriptor and put it onder Tomcat's config directory)<br/> -- the pdf links give an error &quot;Resource Not Found&quot;

    -
    - +

    [FOR-742] trouble accessing unversioned plugin for a released version of Forrest, e.g. projectInfo

    @@ -314,7 +290,7 @@ The solution is discussed here:<br/> <a href="http://marc.theaimsgroup.com/?t=113176328300002">http://marc.theaimsgroup.com/?t=113176328300002</a>

    - +

    [FOR-533] Auto Generate plugins.xml entry

    @@ -326,7 +302,7 @@ <br/> This change will require that the plugins.xml file be retrieved from the build directory rather than the plugins directory when building the plugin documentation pages. We will therefore need a fall back to retrieve this file from the network if it is not currently available - this can be done with the locationmap

    - +

    [FOR-644] code-style cleanup for xml files

    @@ -335,7 +311,7 @@

    We have much inconsistent whitespace in all of our files. This is known to cause trouble in a collaborative environment. See discussion at: <a href="http://marc.theaimsgroup.com/?t=112450901100001">http://marc.theaimsgroup.com/?t=112450901100001</a> and <a href="http://marc.theaimsgroup.com/?t=112495618800002">http://marc.theaimsgroup.com/?t=112495618800002</a> and various linked discussions.<br/>

    - +

    [FOR-241] character entities (e.g. ampersand) are expanded again for href or src attributes

    @@ -362,7 +338,7 @@ The ampersand in the link element text is properly handled but<br/> the ampersand in the link href attribute is not.

    - +

    [FOR-922] update all docs that explain sitemap fragments

    @@ -374,47 +350,13 @@ <br/> These changes need to be reflected in the current docs.

    - -

    [FOR-960] PNG Images not transparent in IE6 or below

    -
    -

    -http://issues.apache.org/jira/browse/FOR-960 -

    -

    As an example, the project logo images appear with a white-ish background when viewed in IE6 or earlier. Fine in Firefox etc. -<br/> - -<br/> -This can be overcome with an AlphaImageLoader fix applied.

    -
    - +

    [FOR-765] forrest war and classpath issues with Jetty

    http://issues.apache.org/jira/browse/FOR-765

    Until recently we could run forrest as a WAR with Jetty. With today's SVN r356945 it gets past the Cocoon startup phase, then on the first client request it suffers some error which causes a NoSuchMethodError. See attached log ... no other clues. This happens for any site, e.g. 'forrest seed-sample war'. All is okay for 'forrest seed-sample run'. This indicates a classpath issue with Jetty/Forrest configuration.

    -
    - -

    [FOR-861] Update locationmap docs for working with remote files

    -
    -

    -http://issues.apache.org/jira/browse/FOR-861 -

    -

    The docs for retrieving content from remote locations [1] have not kept up with Tims wonderful naming conventions for the locationmap [2]<br/> -<br/> -We need to update the docs to reflect the situation described in [3] (don't miss the correction in the next message)<br/> -<br/> -[1] <a href="http://forrest.apache.org/docs_0_80/locationmap.html#source-via-http">http://forrest.apache.org/docs_0_80/locationmap.html#source-via-http</a><br/> -[2] <a href="http://forrest.apache.org/docs_0_80/locationmap.html#namingConvention">http://forrest.apache.org/docs_0_80/locationmap.html#namingConvention</a><br/> -[3] <a href="http://marc.theaimsgroup.com/?t=114492612100001&r=1&w=2">http://marc.theaimsgroup.com/?t=114492612100001&amp;r=1&amp;w=2</a>

    -
    - -

    [FOR-635] images not reproduced in PDFs, if sources are in xdocs/images directory

    -
    -

    -http://issues.apache.org/jira/browse/FOR-635 -

    -

    We used to enable images to be placed in the xdocs/images directory. However, now they are intended to go in the resources/images directory instead. Both methods will work for html pages, but only the latter method for the PDF pages.