Return-Path: Delivered-To: apmail-forrest-svn-archive@www.apache.org Received: (qmail 84401 invoked from network); 6 Mar 2006 01:30:26 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 6 Mar 2006 01:30:26 -0000 Received: (qmail 97503 invoked by uid 500); 6 Mar 2006 01:31:12 -0000 Delivered-To: apmail-forrest-svn-archive@forrest.apache.org Received: (qmail 97450 invoked by uid 500); 6 Mar 2006 01:31:12 -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 97439 invoked by uid 99); 6 Mar 2006 01:31:11 -0000 Received: from asf.osuosl.org (HELO asf.osuosl.org) (140.211.166.49) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 05 Mar 2006 17:31:11 -0800 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [209.237.227.194] (HELO minotaur.apache.org) (209.237.227.194) by apache.org (qpsmtpd/0.29) with SMTP; Sun, 05 Mar 2006 17:31:10 -0800 Received: (qmail 84297 invoked by uid 65534); 6 Mar 2006 01:30:03 -0000 Message-ID: <20060306013003.84296.qmail@minotaur.apache.org> Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit Subject: svn commit: r383447 - in /forrest/site: docs_0_70/primer.pdf docs_0_80/howto/howto-buildPlugin.html docs_0_80/howto/howto-buildPlugin.pdf forrest-issues.html forrest-issues.pdf thanks.html thanks.pdf Date: Mon, 06 Mar 2006 01:30:02 -0000 To: svn@forrest.apache.org From: crossley@apache.org X-Mailer: svnmailer-1.0.7 X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N Author: crossley Date: Sun Mar 5 17:29:59 2006 New Revision: 383447 URL: http://svn.apache.org/viewcvs?rev=383447&view=rev Log: Automatic publish from forrestbot Modified: forrest/site/docs_0_70/primer.pdf forrest/site/docs_0_80/howto/howto-buildPlugin.html forrest/site/docs_0_80/howto/howto-buildPlugin.pdf forrest/site/forrest-issues.html forrest/site/forrest-issues.pdf forrest/site/thanks.html forrest/site/thanks.pdf Modified: forrest/site/docs_0_70/primer.pdf URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_70/primer.pdf?rev=383447&r1=383446&r2=383447&view=diff ============================================================================== Binary files - no diff available. Modified: forrest/site/docs_0_80/howto/howto-buildPlugin.html URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/howto/howto-buildPlugin.html?rev=383447&r1=383446&r2=383447&view=diff ============================================================================== --- forrest/site/docs_0_80/howto/howto-buildPlugin.html (original) +++ forrest/site/docs_0_80/howto/howto-buildPlugin.html Sun Mar 5 17:29:59 2006 @@ -719,8 +719,14 @@ The files plugins/plugins.xml and whiteboard/plugins/plugins.xml are the "Plugins Descriptor" files. Each plugin is described with its name, purpose, location, and version information. These descriptors - are deployed to the forrest website so that your application can - manage its plugins. + are deployed to the forrest website. +

+

+ Each plugin has a build.xml file which defines its version information. + Please keep that synchronised with the plugins.xml files. + Later + FOR-533 + will generate this from the various build.xml files.

The Apache Forrest committers manage these files in SVN and publish @@ -738,7 +744,7 @@

  • Edit the skinconf.xml to ensure that all version numbers are "0.7", e.g. the MOTD.
    • -
  • Edit the plugins descriptor to ensure that the "forrestVersion" is 0.7 and that the "version" is appropriate.
    • +
  • Edit the plugin's descriptors to ensure that the "forrestVersion" is 0.7 and that the "version" is appropriate.
  • Ensure that the "website" parameter includes "pluginDocs/plugins_0_70"
    • @@ -757,7 +763,7 @@
  • Edit the skinconf.xml to ensure that all version numbers are "0.8-dev", e.g. the MOTD.
    • -
  • Edit the plugins descriptor to ensure that the "forrestVersion" is +
  • Edit the plugin's descriptors to ensure that the "forrestVersion" is 0.8 and that the "version" is incremented.
  • Ensure that the "website" parameter includes "pluginDocs/plugins_0_80"
    • @@ -766,7 +772,7 @@ Start adding changes notes. - +

    Experimental Functionality

    Warning
    @@ -781,14 +787,14 @@
    For an example of each of these features in use see the org.apache.forrest.internal.NoteTaking plugin.
    - +

    Locationmap

    Plugins can use the Forrest locationmap to expose resources to your project and other plgins. To use this functionality add your locationmap.xml file to the root of the plugin directory.

    We have an issue for the status of locationmap development.

    - +

    Dispatcher

    Dispatcher (previous codename Forrest Views) is the collective name for the various pieces of functionality that are intended to replace skins in the future. They allow for a much more @@ -809,35 +815,35 @@ your plugin.

    Once Dispatcher becomes stable we will add this match to the default locationmap which is generated when you seed a new plugin, but for now it must be done manually.

    - +

    Plugin Properties

    Plugins can define properties that each project can over-ride. For more information see the issue below.

    We have an issue for the status of this new configuration system.

    - +

    Examples

    This section will provide some example plugins to help illustrate the steps discussed above.

    - +

    Input Plugin

    Fixme (RDG)
    Discuss OpenOffice.org plugin here
    - +

    Output Plugin

    Fixme (RDG)
    Discuss s5 plugin here
    - +

    Internal Plugin

    Fixme (RDG)
    Discuss IMSManifest plugin here
    - +

    Further Reading

    - +

    Summarise the Entire Process

    Fixme (open)
    Modified: forrest/site/docs_0_80/howto/howto-buildPlugin.pdf URL: http://svn.apache.org/viewcvs/forrest/site/docs_0_80/howto/howto-buildPlugin.pdf?rev=383447&r1=383446&r2=383447&view=diff ============================================================================== Binary files - no diff available. Modified: forrest/site/forrest-issues.html URL: http://svn.apache.org/viewcvs/forrest/site/forrest-issues.html?rev=383447&r1=383446&r2=383447&view=diff ============================================================================== --- forrest/site/forrest-issues.html (original) +++ forrest/site/forrest-issues.html Sun Mar 5 17:29:59 2006 @@ -202,31 +202,31 @@ [FOR-388] Use plugins in-place if src available
  • -[FOR-707] Document i18n features of Forrest +[FOR-533] Auto Generate plugins.xml entry
  • -[FOR-742] trouble accessing unversioned plugin for a released version of Forrest, e.g. projectInfo +[FOR-735] Plugins are not correctly deployed in webapp mode
  • -[FOR-711] Cache results from the Locationmap +[FOR-707] Document i18n features of Forrest
  • -[FOR-735] Plugins are not correctly deployed in webapp mode +[FOR-711] Cache results from the Locationmap
  • -[FOR-533] Auto Generate plugins.xml entry +[FOR-742] trouble accessing unversioned plugin for a released version of Forrest, e.g. projectInfo
  • [FOR-241] character entities (e.g. ampersand) are expanded again for href or src attributes
  • -[FOR-209] First level selected tab is not highlighted when containing 2nd level tabs +[FOR-211] whole-site html and pdf: broken ext links
  • [FOR-210] whole-site html and pdf: broken link faq, broken image links
  • -[FOR-211] whole-site html and pdf: broken ext links +[FOR-209] First level selected tab is not highlighted when containing 2nd level tabs
  • [FOR-203] 2nd level tabs are not selected appropriately @@ -244,10 +244,10 @@ [FOR-562] Update Plugins howto
  • -[FOR-644] whitespace cleanup +[FOR-645] patches for whitespace cleanup
  • -[FOR-645] patches for whitespace cleanup +[FOR-644] whitespace cleanup
  • [FOR-726] use locationmap in all of the plugins @@ -363,87 +363,87 @@ <br>

    • - -

    [FOR-707] Document i18n features of Forrest

    + +

    [FOR-533] Auto Generate plugins.xml entry

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

    -

    There is next to no documentation about i18n, just a pretty poor FAQ entry that points at an issue that has now been closed. -<br> - -<br> -Cheche wrote a blog entry on his work: +

    The information in the plugins.xml file would be better kept in the plugin directory and added to the plugins.xml file when deployed. This would reduce the amount of duplication in the plugins config files. <br> <br> -<a href="http://casa.che-che.com/blog/2005/05/10/internalization-a-site-using-forrest-07-dev/">http://casa.che-che.com/blog/2005/05/10/internalization-a-site-using-forrest-07-dev/</a> +All the necessary values are now in the plugin build.xml file. <br> <br> -We could, at the very least use the locationmap to pull this content into our site [OT: I wonder if this could be a way to generate more documentation?)

    +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-742] trouble accessing unversioned plugin for a released version of Forrest, e.g. projectInfo

    + +

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

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

    -

    The plugin retrieval and deployment process are not quite correct. Recently the projectInfo plugin had its version number incremented and the &quot;unversioned&quot; plugin now relates specifically to 0.8-dev version. That prevents 0.7 from accessing the relevant plugin. +

    (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> -The solution is discussed here: +- run forrest webapp to create an empty webapp <br> -<a href="http://marc.theaimsgroup.com/?t=113176328300002">http://marc.theaimsgroup.com/?t=113176328300002</a>

    +- 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-711] Cache results from the Locationmap

    + +

    [FOR-707] Document i18n features of Forrest

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

    -

    Now that we are using the locationmap extensively it is showing up just how innefficient it is. The problem is that for the majority of requests there are multiple reqeuests to the locationmap. We can make things much faster (especially on the first page request) by caching results in the locationmap. +

    There is next to no documentation about i18n, just a pretty poor FAQ entry that points at an issue that has now been closed. <br> <br> -I think a simple cache will sufice, lets just provide a static hashmap using the hint as a key and, of course, the location as the value. +Cheche wrote a blog entry on his work: <br> <br> -If we test all locationmaps and find no result we should record that tere is no result in this hashmap. This will also be a good place to throw an exception so that Cocoon can better report such errors (see FOR-701)

    +<a href="http://casa.che-che.com/blog/2005/05/10/internalization-a-site-using-forrest-07-dev/">http://casa.che-che.com/blog/2005/05/10/internalization-a-site-using-forrest-07-dev/</a> +<br> + +<br> +We could, at the very least use the locationmap to pull this content into our site [OT: I wonder if this could be a way to generate more documentation?)

    - -

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

    + +

    [FOR-711] Cache results from the Locationmap

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

    -

    (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) +

    Now that we are using the locationmap extensively it is showing up just how innefficient it is. The problem is that for the majority of requests there are multiple reqeuests to the locationmap. We can make things much faster (especially on the first page request) by caching results in the locationmap. <br> <br> -- run forrest webapp to create an empty webapp +I think a simple cache will sufice, lets just provide a static hashmap using the hint as a key and, of course, the location as the value. <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;

    +If we test all locationmaps and find no result we should record that tere is no result in this hashmap. This will also be a good place to throw an exception so that Cocoon can better report such errors (see FOR-701)

    - -

    [FOR-533] Auto Generate plugins.xml entry

    + +

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

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

    -

    The information in the plugins.xml file would be better kept in the plugin directory and added to the plugins.xml file when deployed. This would reduce the amount of duplication in the plugins config files. +

    The plugin retrieval and deployment process are not quite correct. Recently the projectInfo plugin had its version number incremented and the &quot;unversioned&quot; plugin now relates specifically to 0.8-dev version. That prevents 0.7 from accessing the relevant plugin. <br> <br> -All the necessary values are now in the plugin build.xml file. -<br> - +The solution is discussed here: <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

    +<a href="http://marc.theaimsgroup.com/?t=113176328300002">http://marc.theaimsgroup.com/?t=113176328300002</a>

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

    @@ -491,19 +491,13 @@ <br> the ampersand in the link href attribute is not.

    - -

    [FOR-209] First level selected tab is not highlighted when containing 2nd level tabs

    + +

    [FOR-211] whole-site html and pdf: broken ext links

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

    -

    When there are two levels of tabs, the selected first level tab does not get highlighted, nor are there any other visual or structural clues as to which first-level tab is active, and which contains the displayed 2nd level tabs. -<br> - -<br> -This is checked with both the default skin, and with tigris-style. -<br> +http://issues.apache.org/jira/browse/FOR-211

    +

    In the the generated site.html all of the external links are broken (i.e. the href attributes are like ... error:#ext:forrest).

    [FOR-210] whole-site html and pdf: broken link faq, broken image links

    @@ -515,13 +509,19 @@ <br>

    - -

    [FOR-211] whole-site html and pdf: broken ext links

    + +

    [FOR-209] First level selected tab is not highlighted when containing 2nd level tabs

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

    +

    When there are two levels of tabs, the selected first level tab does not get highlighted, nor are there any other visual or structural clues as to which first-level tab is active, and which contains the displayed 2nd level tabs. +<br> + +<br> +This is checked with both the default skin, and with tigris-style. +<br>

    -

    In the the generated site.html all of the external links are broken (i.e. the href attributes are like ... error:#ext:forrest).

    [FOR-203] 2nd level tabs are not selected appropriately

    @@ -625,7 +625,15 @@ <br>

    - + +

    [FOR-645] patches for whitespace cleanup

    +
    +

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

    +

    Use this issue to provide patches for the whitespace cleanup.

    +
    +

    [FOR-644] whitespace cleanup

    @@ -636,14 +644,6 @@ <br> This Issue will be used to announce which section of the repository is due to be cleaned next. Please keep discussion on that mail thread.

    -
    - -

    [FOR-645] patches for whitespace cleanup

    -
    -

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

    -

    Use this issue to provide patches for the whitespace cleanup.

    [FOR-726] use locationmap in all of the plugins

    Modified: forrest/site/forrest-issues.pdf URL: http://svn.apache.org/viewcvs/forrest/site/forrest-issues.pdf?rev=383447&r1=383446&r2=383447&view=diff ============================================================================== Binary files - no diff available. Modified: forrest/site/thanks.html URL: http://svn.apache.org/viewcvs/forrest/site/thanks.html?rev=383447&r1=383446&r2=383447&view=diff ============================================================================== --- forrest/site/thanks.html (original) +++ forrest/site/thanks.html Sun Mar 5 17:29:59 2006 @@ -245,7 +245,8 @@ IntelliJ IDEA or Eclipse. - Most tools do not require attribution, but some do ... + Most tools do not require attribution, but some do + (YourKit Java Profiler).

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