forrest-svn mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From cross...@apache.org
Subject svn commit: r391467 - in /forrest/site: docs_0_80/howto/howto-buildPlugin.html docs_0_80/howto/howto-buildPlugin.pdf forrest-issues.html forrest-issues.pdf
Date Wed, 05 Apr 2006 02:32:56 GMT
Author: crossley
Date: Tue Apr  4 19:32:55 2006
New Revision: 391467

URL: http://svn.apache.org/viewcvs?rev=391467&view=rev
Log:
Automatic publish from forrestbot

Modified:
    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

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=391467&r1=391466&r2=391467&view=diff
==============================================================================
--- forrest/site/docs_0_80/howto/howto-buildPlugin.html (original)
+++ forrest/site/docs_0_80/howto/howto-buildPlugin.html Tue Apr  4 19:32:55 2006
@@ -366,6 +366,11 @@
 </li>
 <li>
 <a href="#resources">Create the Necessary Resource Files</a>
+<ul class="minitoc">
+<li>
+<a href="#dtd-catalog">Entity catalog for DTDs and other resources</a>
+</li>
+</ul>
 </li>
 <li>
 <a href="#samples">Create Samples in the Documentation</a>
@@ -623,10 +628,16 @@
 <a name="N1013A"></a><a name="resources"></a>
 <h3 class="underlined_5">Create the Necessary Resource Files</h3>
 <div class="fixme">
-<div class="label">Fixme (rdg)</div>
+<div class="label">Fixme (open)</div>
 <div class="content">Discuss the XSL files and other such resources</div>
 </div>
-<a name="N10145"></a><a name="samples"></a>
+<a name="N10144"></a><a name="dtd-catalog"></a>
+<h4>Entity catalog for DTDs and other resources</h4>
+<p>If the plugin uses non-core DTDs and other entities, then add them to  the
+          <span class="codefrag">resources/schema</span> directory and configure
a catalog.xcat file.
+          The best way to do this is to copy an example from another plugin (e.g. listLocations)
+          and edit it to suit.</p>
+<a name="N10152"></a><a name="samples"></a>
 <h3 class="underlined_5">Create Samples in the Documentation</h3>
 <p>Plugin documentation should provide (as a minimum) an
       index page that provides an overview and a set of samples that demonstrate
@@ -636,7 +647,7 @@
       and <span class="codefrag">tabs.xml</span> configuration files.</p>
 <p>Try to provide a sample for all the major functions of your plugin
       and document any configuration that is available.</p>
-<a name="N1015B"></a><a name="test"></a>
+<a name="N10168"></a><a name="test"></a>
 <h3 class="underlined_5">Testing a Plugin</h3>
 <p>Since your documentation for the plugin illustrates all of its 
       functionality, you can use that site for testing the plugin. However, you
@@ -662,31 +673,35 @@
       as writing your tests.</p>
 <p>Ensure that your sitemaps are robust and handle matches for files
       in sub-directories, as well as those at the root level.</p>
-<a name="N10188"></a><a name="Testing+During+Development"></a>
+<a name="N10195"></a><a name="Testing+During+Development"></a>
 <h4>Testing During Development</h4>
 <p>In the current plugin system plugins are not used from their
         src directories, they must first be deployed locally. To do this
-        run the command <span class="codefrag">ant local-deploy</span>.</p>
+        run the command
+        <span class="codefrag">$FORREST_HOME/tools/ant/bin/ant local-deploy</span>
+</p>
 <div class="note">
 <div class="label">Note</div>
-<div class="content">The test target will do this deployment automatically for you.
+<div class="content">The "test" target will do this deployment automatically for you.
         You need only run it manually if you wish to test the plugin whilst
         editing content in a live Forrest instance.</div>
 </div>
+<p>When you make changes to the plugin while doing its development,
+        then you need to do the local-deploy again for those changes to have effect.</p>
 <p>In most cases you can locally deploy a plugin without having to 
         restart Forrest. However, if your plugin changes any configuration
         files in the <span class="codefrag">conf</span> directory you will, most
likely, have 
         to restart Forrest to see these changes.</p>
-<a name="N1019F"></a><a name="release"></a>
+<a name="N101AE"></a><a name="release"></a>
 <h3 class="underlined_5">Releasing a Plugin</h3>
-<a name="N101A5"></a><a name="register"></a>
+<a name="N101B4"></a><a name="register"></a>
 <h4>Register the Plugin with Apache Forrest</h4>
 <div class="fixme">
 <div class="label">Fixme (rdg)</div>
 <div class="content">Describe making a request of Forrest devs for 
         inclusion</div>
 </div>
-<a name="N101B0"></a><a name="deploy"></a>
+<a name="N101BF"></a><a name="deploy"></a>
 <h4>Deploying the Plugin</h4>
 <p>To deploy the plugin so that others can use it, it must be made 
         available as a zip from the URL indicated in the 
@@ -715,7 +730,7 @@
         that you only deploy working plugins. This adds a little time to
         the deploy cycle, but we feel the peace of mind is worth it.</div>
 </div>
-<a name="N101E2"></a><a name="descriptor"></a>
+<a name="N101F1"></a><a name="descriptor"></a>
 <h4>Managing the plugins descriptors</h4>
 <p>
           The files plugins/plugins.xml and whiteboard/plugins/plugins.xml are
@@ -774,7 +789,7 @@
              Start adding changes notes.</li>
         
 </ul>
-<a name="N10221"></a><a name="experimental"></a>
+<a name="N10230"></a><a name="experimental"></a>
 <h3 class="underlined_5">Experimental Functionality</h3>
 <div class="warning">
 <div class="label">Warning</div>
@@ -789,14 +804,14 @@
 <div class="content">For an example of each of these features in use see the 
       <span class="codefrag">org.apache.forrest.internal.NoteTaking</span> plugin.</div>
 </div>
-<a name="N10230"></a><a name="Locationmap"></a>
+<a name="N1023F"></a><a name="Locationmap"></a>
 <h4>Locationmap</h4>
 <p>Plugins can use the Forrest locationmap to expose resources to your
         project and other plgins. To use this functionality add your 
         <span class="codefrag">locationmap.xml</span> file to the root of the
plugin directory.</p>
 <p>We have an <a href="http://issues.apache.org/jira/browse/FOR-200">issue</a>
         for the status of locationmap development.</p>
-<a name="N10244"></a><a name="Dispatcher"></a>
+<a name="N10253"></a><a name="Dispatcher"></a>
 <h4>Dispatcher</h4>
 <p>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
@@ -817,35 +832,35 @@
         your plugin.</p>
 <p>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.</p>
-<a name="N10264"></a><a name="Plugin+Properties"></a>
+<a name="N10273"></a><a name="Plugin+Properties"></a>
 <h4>Plugin Properties</h4>
 <p>Plugins can define properties that each project can over-ride.
         For more information see the issue below.</p>
 <p>We have an <a href="http://issues.apache.org/jira/browse/FOR-588">issue</a>
         for the status of this new configuration system.</p>
-<a name="N10276"></a><a name="examples"></a>
+<a name="N10285"></a><a name="examples"></a>
 <h3 class="underlined_5">Examples</h3>
 <p>This section will provide some example plugins to help illustrate the
       steps discussed above.</p>
-<a name="N1027F"></a><a name="input"></a>
+<a name="N1028E"></a><a name="input"></a>
 <h4>Input Plugin</h4>
 <div class="fixme">
 <div class="label">Fixme (RDG)</div>
 <div class="content">Discuss OpenOffice.org plugin here</div>
 </div>
-<a name="N1028A"></a><a name="output"></a>
+<a name="N10299"></a><a name="output"></a>
 <h4>Output Plugin</h4>
 <div class="fixme">
 <div class="label">Fixme (RDG)</div>
 <div class="content">Discuss s5 plugin here</div>
 </div>
-<a name="N10295"></a><a name="internal"></a>
+<a name="N102A4"></a><a name="internal"></a>
 <h4>Internal Plugin</h4>
 <div class="fixme">
 <div class="label">Fixme (RDG)</div>
 <div class="content">Discuss IMSManifest plugin here</div>
 </div>
-<a name="N102A1"></a><a name="extension"></a>
+<a name="N102B0"></a><a name="extension"></a>
 <h3 class="underlined_5">Further Reading</h3>
 <ul>
         
@@ -856,7 +871,7 @@
 <a href="../../pluginDocs/plugins_0_80/">Plugins Documentation</a> for users</li>
       
 </ul>
-<a name="N102B7"></a><a name="summarise"></a>
+<a name="N102C6"></a><a name="summarise"></a>
 <h3 class="underlined_5">Summarise the Entire Process</h3>
 <div class="fixme">
 <div class="label">Fixme (open)</div>

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=391467&r1=391466&r2=391467&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=391467&r1=391466&r2=391467&view=diff
==============================================================================
--- forrest/site/forrest-issues.html (original)
+++ forrest/site/forrest-issues.html Tue Apr  4 19:32:55 2006
@@ -189,9 +189,6 @@
 <div id="minitoc-area">
 <ul class="minitoc">
 <li>
-<a href="#%5BFOR-796%5D+Merge+all+view%2Fdispatcher+work+into+org.apache.forrest.plugin.internal.dispatcher+and+org.apache.forrest.themes.core">[FOR-796]
Merge all view/dispatcher work into org.apache.forrest.plugin.internal.dispatcher and org.apache.forrest.themes.core</a>
-</li>
-<li>
 <a href="#%5BFOR-713%5D+HTML-to-document.xsl+no+longer+generates+an+XDoc">[FOR-713]
HTML-to-document.xsl no longer generates an XDoc</a>
 </li>
 <li>
@@ -201,6 +198,9 @@
 <a href="#%5BFOR-762%5D+Default+page+URL+for+breadcrumbs+and+site%3A+links">[FOR-762]
Default page URL for breadcrumbs and site: links</a>
 </li>
 <li>
+<a href="#%5BFOR-796%5D+Merge+all+view%2Fdispatcher+work+into+org.apache.forrest.plugin.internal.dispatcher+and+org.apache.forrest.themes.core">[FOR-796]
Merge all view/dispatcher work into org.apache.forrest.plugin.internal.dispatcher and org.apache.forrest.themes.core</a>
+</li>
+<li>
 <a href="#%5BFOR-388%5D+Use+plugins+in-place+if+src+available">[FOR-388] Use plugins
in-place if src available</a>
 </li>
 <li>
@@ -273,82 +273,82 @@
        <a href="http://issues.apache.org/jira/secure/IssueNavigator.jspa?pid=12310000&resolutionIds=-1&tempMax=1000&reset=true">all</a>
open issues).
       The listing below is regenerated on each Forrest run.</div>
 </div>
-<a name="N10011"></a><a name="%5BFOR-796%5D+Merge+all+view%2Fdispatcher+work+into+org.apache.forrest.plugin.internal.dispatcher+and+org.apache.forrest.themes.core"></a>
-<h2 class="underlined_10">[FOR-796] Merge all view/dispatcher work into org.apache.forrest.plugin.internal.dispatcher
and org.apache.forrest.themes.core</h2>
-<div class="section">
-<p>
-<a href="http://issues.apache.org/jira/browse/FOR-796">http://issues.apache.org/jira/browse/FOR-796</a>
-</p>
-<p>This is the global issue to keep track on the merging effort</p>
-</div>
-<a name="N1001D"></a><a name="%5BFOR-713%5D+HTML-to-document.xsl+no+longer+generates+an+XDoc"></a>
+<a name="N10011"></a><a name="%5BFOR-713%5D+HTML-to-document.xsl+no+longer+generates+an+XDoc"></a>
 <h2 class="underlined_10">[FOR-713] HTML-to-document.xsl no longer generates an XDoc</h2>
 <div class="section">
 <p>
 <a href="http://issues.apache.org/jira/browse/FOR-713">http://issues.apache.org/jira/browse/FOR-713</a>
 </p>
 <p>html-to-document.xsl no longer converts content to an XDoc. Instead it renders converts
documents to XDoc, instead it allows H1, H2 etc. elements to pass through.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 The result is a page that seems to render correctly and in the single test case I have used
it still renders correctly in PDF and Text format. However, this is a backward incompatible
change that will break sites that use includes with XPath statements such as /section[@id=&amp;quot;foo&amp;quot;]
(sections are no longer created)
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 </p>
 </div>
-<a name="N10029"></a><a name="%5BFOR-591%5D+MaxMemory+needs+increasing"></a>
+<a name="N1001D"></a><a name="%5BFOR-591%5D+MaxMemory+needs+increasing"></a>
 <h2 class="underlined_10">[FOR-591] MaxMemory needs increasing</h2>
 <div class="section">
 <p>
 <a href="http://issues.apache.org/jira/browse/FOR-591">http://issues.apache.org/jira/browse/FOR-591</a>
 </p>
 <p>Since the docs restructurng for the 0.7 release it has become necessary to increase
the maxmemory to be able to build the Forrest site.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 Does this indicate a memory leak?
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 Does someone have the tools to run some diagnostics?
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 (NB maxmemory has been increased in forrest.properties, if we resolve this issue it should
be reduced again)</p>
 </div>
-<a name="N10035"></a><a name="%5BFOR-762%5D+Default+page+URL+for+breadcrumbs+and+site%3A+links"></a>
+<a name="N10029"></a><a name="%5BFOR-762%5D+Default+page+URL+for+breadcrumbs+and+site%3A+links"></a>
 <h2 class="underlined_10">[FOR-762] Default page URL for breadcrumbs and site: links</h2>
 <div class="section">
 <p>
 <a href="http://issues.apache.org/jira/browse/FOR-762">http://issues.apache.org/jira/browse/FOR-762</a>
 </p>
 <p>When employing breadcrumbs,
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 example generated links:  home &amp;gt; dir &amp;gt; subdir
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 if the user is in node subdir, then clicks dir,
-&lt;br&gt;
+&lt;br/&gt;
 cocoon returns &amp;quot;The requested resource &amp;quot;/dir /&amp;quot; could
not be found.
-&lt;br&gt;
+&lt;br/&gt;
 The link's absolute path during testing is &lt;a href="http://localhost:8888/dir/"&gt;http://localhost:8888/dir/&lt;/a&gt;
-&lt;br&gt;
+&lt;br/&gt;
 Case 1. If you place an index.html file under &lt;a href="http://localhost:8888/dir/"&gt;http://localhost:8888/dir/&lt;/a&gt;
for a redirect or viewable content,
-&lt;br&gt;
+&lt;br/&gt;
 clicking on breadcrumbs'  dir link throws the error.
-&lt;br&gt;
+&lt;br/&gt;
 Case 2. If you manually enter the index.html in the browser path after &lt;a href="http://localhost:8888/dir/,"&gt;http://localhost:8888/dir/,&lt;/a&gt;
the request is handled.
-&lt;br&gt;
+&lt;br/&gt;
 Case 3. If sitemap has match=&amp;quot;dir/index.html&amp;quot;, cocoon still isn't
happy with request dir/
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 Cocoon does not appear to assume the end node directory is index.* and thus appends no file
automatically as tomcat or the http server does so it must be manually done. </p>
 </div>
+<a name="N10035"></a><a name="%5BFOR-796%5D+Merge+all+view%2Fdispatcher+work+into+org.apache.forrest.plugin.internal.dispatcher+and+org.apache.forrest.themes.core"></a>
+<h2 class="underlined_10">[FOR-796] Merge all view/dispatcher work into org.apache.forrest.plugin.internal.dispatcher
and org.apache.forrest.themes.core</h2>
+<div class="section">
+<p>
+<a href="http://issues.apache.org/jira/browse/FOR-796">http://issues.apache.org/jira/browse/FOR-796</a>
+</p>
+<p>This is the global issue to keep track on the merging effort</p>
+</div>
 <a name="N10041"></a><a name="%5BFOR-388%5D+Use+plugins+in-place+if+src+available"></a>
 <h2 class="underlined_10">[FOR-388] Use plugins in-place if src available</h2>
 <div class="section">
@@ -356,13 +356,13 @@
 <a href="http://issues.apache.org/jira/browse/FOR-388">http://issues.apache.org/jira/browse/FOR-388</a>
 </p>
 <p>At present Forrest will attempt to download plugins even if they are available in
src form in the local filesystem as part of an SVN checkout.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 Have Forrest mount plugins from designated directories in preference to downloading them
wherever possible (need more than posible location for src plugins as some people may be developing
their own plugins outside of Forrest)
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 </p>
 </div>
 <a name="N1004D"></a><a name="%5BFOR-533%5D+Auto+Generate+plugins.xml+entry"></a>
@@ -372,13 +372,13 @@
 <a href="http://issues.apache.org/jira/browse/FOR-533">http://issues.apache.org/jira/browse/FOR-533</a>
 </p>
 <p>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.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 All the necessary values are now in the plugin build.xml file.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 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</p>
 </div>
 <a name="N10059"></a><a name="%5BFOR-735%5D+Plugins+are+not+correctly+deployed+in+webapp+mode"></a>
@@ -388,13 +388,13 @@
 <a href="http://issues.apache.org/jira/browse/FOR-735">http://issues.apache.org/jira/browse/FOR-735</a>
 </p>
 <p>(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)
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 - run forrest webapp to create an empty webapp
-&lt;br&gt;
+&lt;br/&gt;
 - configure Tomcat to run the webapp (we did it by creating a context descriptor and put
it onder Tomcat's config directory)
-&lt;br&gt;
+&lt;br/&gt;
 - the pdf links give an error &amp;quot;Resource Not Found&amp;quot;</p>
 </div>
 <a name="N10065"></a><a name="%5BFOR-711%5D+Cache+results+from+the+Locationmap"></a>
@@ -404,14 +404,14 @@
 <a href="http://issues.apache.org/jira/browse/FOR-711">http://issues.apache.org/jira/browse/FOR-711</a>
 </p>
 <p>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.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 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.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
-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)</p>
+&lt;br/&gt;
+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 &lt;a href="http://issues.apache.org/jira/browse/FOR-701" title="Missing
locationmap entry gives poor error"&gt;FOR-701&lt;/a&gt;)</p>
 </div>
 <a name="N10071"></a><a name="%5BFOR-742%5D+trouble+accessing+unversioned+plugin+for+a+released+version+of+Forrest%2C+e.g.+projectInfo"></a>
 <h2 class="underlined_10">[FOR-742] trouble accessing unversioned plugin for a released
version of Forrest, e.g. projectInfo</h2>
@@ -420,11 +420,11 @@
 <a href="http://issues.apache.org/jira/browse/FOR-742">http://issues.apache.org/jira/browse/FOR-742</a>
 </p>
 <p>The plugin retrieval and deployment process are not quite correct. Recently the
projectInfo plugin had its version number incremented and the &amp;quot;unversioned&amp;quot;
plugin now relates specifically to 0.8-dev version. That prevents 0.7 from accessing the relevant
plugin.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 The solution is discussed here:
-&lt;br&gt;
+&lt;br/&gt;
 &lt;a href="http://marc.theaimsgroup.com/?t=113176328300002"&gt;http://marc.theaimsgroup.com/?t=113176328300002&lt;/a&gt;</p>
 </div>
 <a name="N1007D"></a><a name="%5BFOR-707%5D+Document+i18n+features+of+Forrest"></a>
@@ -434,17 +434,17 @@
 <a href="http://issues.apache.org/jira/browse/FOR-707">http://issues.apache.org/jira/browse/FOR-707</a>
 </p>
 <p>There is next to no documentation about i18n, just a pretty poor FAQ entry that
points at an issue that has now been closed.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 Cheche wrote a blog entry on his work:
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 &lt;a href="http://casa.che-che.com/blog/2005/05/10/internalization-a-site-using-forrest-07-dev/"&gt;http://casa.che-che.com/blog/2005/05/10/internalization-a-site-using-forrest-07-dev/&lt;/a&gt;
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 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?)</p>
 </div>
 <a name="N10089"></a><a name="%5BFOR-639%5D+define+terminology+for+the+various+aspects+of+Dispatcher"></a>
@@ -454,9 +454,9 @@
 <a href="http://issues.apache.org/jira/browse/FOR-639">http://issues.apache.org/jira/browse/FOR-639</a>
 </p>
 <p>See the email thread:
-&lt;br&gt;
+&lt;br/&gt;
 &lt;a href="http://marc.theaimsgroup.com/?t=112276643700001"&gt;http://marc.theaimsgroup.com/?t=112276643700001&lt;/a&gt;
-&lt;br&gt;
+&lt;br/&gt;
 </p>
 </div>
 <a name="N10095"></a><a name="%5BFOR-241%5D+character+entities+%28e.g.+ampersand%29+are+expanded+again+for+href+or+src+attributes"></a>
@@ -466,43 +466,43 @@
 <a href="http://issues.apache.org/jira/browse/FOR-241">http://issues.apache.org/jira/browse/FOR-241</a>
 </p>
 <p>If I have a url like this inside the XML source:
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 &lt;a href="http://sourceforge.net/sflogo.php?group_id=comics-grabber&amp;type=1"&gt;http://sourceforge.net/sflogo.php?group_id=comics-grabber&amp;amp;type=1&lt;/a&gt;
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 validate-xdocs fails because it wants the literal &amp;amp; to be typed out as
-&lt;br&gt;
+&lt;br/&gt;
 &amp;amp; instead. So I correct it to become:
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 &lt;a href="http://sourceforge.net/sflogo.php?group_id=comics-grabber&amp;type=1"&gt;http://sourceforge.net/sflogo.php?group_id=comics-grabber&amp;amp;type=1&lt;/a&gt;
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 However, the generated HTML has the entity resolution UNDONE!:
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 &lt;a href="http://sourceforge.net/sflogo.php?group_id=comics-grabber&amp;type=1"&gt;http://sourceforge.net/sflogo.php?group_id=comics-grabber&amp;amp;type=1&lt;/a&gt;
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 This HTML fails validation as 4.01 transitional.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 David Crossley adds:
-&lt;br&gt;
+&lt;br/&gt;
 There is a demonstration of the problem in the document
-&lt;br&gt;
+&lt;br/&gt;
 src/documentation/content/xdocs/docs/dreams.xml
-&lt;br&gt;
+&lt;br/&gt;
 The ampersand in the link element text is properly handled but
-&lt;br&gt;
+&lt;br/&gt;
 the ampersand in the link href attribute is not.</p>
 </div>
 <a name="N100A1"></a><a name="%5BFOR-211%5D+whole-site+html+and+pdf%3A+broken+ext+links"></a>
@@ -519,8 +519,8 @@
 <p>
 <a href="http://issues.apache.org/jira/browse/FOR-210">http://issues.apache.org/jira/browse/FOR-210</a>
 </p>
-<p>The &amp;quot;fresh-site&amp;quot; build from 'forrest seed site' reports
some failures for faq.html and various missing images. Wonder if sitemap issue?&lt;br&gt;
-&lt;br&gt;
+<p>The &amp;quot;fresh-site&amp;quot; build from 'forrest seed site' reports
some failures for faq.html and various missing images. Wonder if sitemap issue?&lt;br/&gt;
+&lt;br/&gt;
 </p>
 </div>
 <a name="N100B9"></a><a name="%5BFOR-209%5D+First+level+selected+tab+is+not+highlighted+when+containing+2nd+level+tabs"></a>
@@ -530,11 +530,11 @@
 <a href="http://issues.apache.org/jira/browse/FOR-209">http://issues.apache.org/jira/browse/FOR-209</a>
 </p>
 <p>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.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 This is checked with both the default skin, and with tigris-style.
-&lt;br&gt;
+&lt;br/&gt;
 </p>
 </div>
 <a name="N100C5"></a><a name="%5BFOR-203%5D+2nd+level+tabs+are+not+selected+appropriately"></a>
@@ -543,20 +543,20 @@
 <p>
 <a href="http://issues.apache.org/jira/browse/FOR-203">http://issues.apache.org/jira/browse/FOR-203</a>
 </p>
-<p>The 2nd level tabs are not shown for menu entries that caused the issue FOR-111.
This happens because the starts-with() path comparison fails for menu entries that do not
reside the same directory as is specified in the &amp;quot;dir&amp;quot; attribute
of the 2nd level tabs.
-&lt;br&gt;
+<p>The 2nd level tabs are not shown for menu entries that caused the issue &lt;a
href="http://issues.apache.org/jira/browse/FOR-111" title="Seem to get all tab menus, not
default tab's menus."&gt;&lt;strike&gt;FOR-111&lt;/strike&gt;&lt;/a&gt;.
This happens because the starts-with() path comparison fails for menu entries that do not
reside the same directory as is specified in the &amp;quot;dir&amp;quot; attribute
of the 2nd level tabs.
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 See the attached bug-demo.tgz for an example. Select &amp;quot;Samples/Apache document&amp;quot;
and notice that the 2nd level tabs are shown. Now select &amp;quot;Samples/BUG DEMO&amp;quot;
and notice that the 2nd level tabs are not shown.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 This is because the document corresponding to &amp;quot;Samples/Apache document&amp;quot;
resides in the directory &amp;quot;/samples&amp;quot; whereas the document corresponding
to &amp;quot;Samples/BUG DEMO&amp;quot; resides in the directory &amp;quot;/bug-sample&amp;quot;.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 Kind regards,
-&lt;br&gt;
+&lt;br/&gt;
 &amp;nbsp;&amp;nbsp;Lorenz Froihofer.</p>
 </div>
 <a name="N100D1"></a><a name="%5BFOR-200%5D+Locationmap+for+Forrest+and+Users"></a>
@@ -566,9 +566,9 @@
 <a href="http://issues.apache.org/jira/browse/FOR-200">http://issues.apache.org/jira/browse/FOR-200</a>
 </p>
 <p>The locationmap gives us the ability to specify where sources are, both for Forrest
and for the users.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 Beware that it will not work for raw files that are not linked, as this &amp;quot;feature&amp;quot;
currently uses a fixed dir being being copied by Ant.</p>
 </div>
 <a name="N100DD"></a><a name="%5BFOR-546%5D+Sitemap+reference+doc+should+be+updated+to+reflect+plugin+architecture"></a>
@@ -578,29 +578,29 @@
 <a href="http://issues.apache.org/jira/browse/FOR-546">http://issues.apache.org/jira/browse/FOR-546</a>
 </p>
 <p>The example at &lt;a href="http://forrest.apache.org/0.7/docs/sitemap-ref.html#pdf"&gt;http://forrest.apache.org/0.7/docs/sitemap-ref.html#pdf&lt;/a&gt;
uses a fo2pdf serializer.  This probaly worked in versions &amp;lt; 0.7, because the PDF
output feature was in the core, and the serializer was very likely declared there.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 With version 0.7, PDF output is moved to a plugin, the fo2pdf serializer seems to be no longer
there.  The serializer should probably be added to the example, for completeness.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 &amp;nbsp;&amp;nbsp;&amp;lt;map:components&amp;gt;
-&lt;br&gt;
+&lt;br/&gt;
 &amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;map:serializers&amp;gt;
-&lt;br&gt;
+&lt;br/&gt;
 &amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;map:serializer
name=&amp;quot;fo2pdf&amp;quot;
-&lt;br&gt;
+&lt;br/&gt;
 &amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;src=&amp;quot;org.apache.cocoon.serialization.FOPSerializer&amp;quot;
-&lt;br&gt;
+&lt;br/&gt;
 &amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;mime-type=&amp;quot;application/pdf&amp;quot;/&amp;gt;
-&lt;br&gt;
+&lt;br/&gt;
 &amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;nbsp;&amp;lt;/map:serializers&amp;gt;
-&lt;br&gt;
+&lt;br/&gt;
 &amp;nbsp;&amp;nbsp;&amp;lt;/map:components&amp;gt;
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 I found out about this because my sitemap uses the fo2pdf too (docbook to PDF), and had to
add the serializer.</p>
 </div>
 <a name="N100E9"></a><a name="%5BFOR-560%5D+Remove+duplicate+jars+from+eclipse+plugins"></a>
@@ -618,25 +618,25 @@
 <a href="http://issues.apache.org/jira/browse/FOR-562">http://issues.apache.org/jira/browse/FOR-562</a>
 </p>
 <p>The document at &lt;a href="http://forrest.apache.org/docs_0_70/howto/howto-buildPlugin.html"&gt;http://forrest.apache.org/docs_0_70/howto/howto-buildPlugin.html&lt;/a&gt;
needs to be updated in the following ways:
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 - remove warnings about instability
-&lt;br&gt;
+&lt;br/&gt;
 - add details about creating plugins outside of FORREST_HOME (mkdir PROJECT_HOME/plugins,
copy whiteboard/plugins/build.xml to PROJECT_HOME/plugins, edit forrest.plugins.dir property)
-&lt;br&gt;
+&lt;br/&gt;
 - update section on seeding a plugin to reflect working outside of FORREST_HOME
-&lt;br&gt;
+&lt;br/&gt;
 - remove the existing note about copying build.xml
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 NB here should be no need to edit the forrest.plugins.dir, simply set it to '.'
-&lt;br&gt;
+&lt;br/&gt;
 In addition the buil file template should really be provided from the plugins directory rather
than the whiteboard dir
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 </p>
 </div>
 <a name="N10101"></a><a name="%5BFOR-645%5D+patches+for+whitespace+cleanup"></a>
@@ -654,9 +654,9 @@
 <a href="http://issues.apache.org/jira/browse/FOR-644">http://issues.apache.org/jira/browse/FOR-644</a>
 </p>
 <p>We have much inconsistent whitespace in all of our files. This is known to cause
trouble in a collaborative environment. See discussion at: &lt;a href="http://marc.theaimsgroup.com/?t=112450901100001"&gt;http://marc.theaimsgroup.com/?t=112450901100001&lt;/a&gt;
and see the list at trunk/etc/whitespace-cleanup.txt
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 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.</p>
 </div>
 <a name="N10119"></a><a name="%5BFOR-726%5D+use+locationmap+in+all+of+the+plugins"></a>
@@ -666,9 +666,9 @@
 <a href="http://issues.apache.org/jira/browse/FOR-726">http://issues.apache.org/jira/browse/FOR-726</a>
 </p>
 <p>Each plugin has sitemaps that need to use the locationmap.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 (Perhaps we need Jira sub-tasks for each plugin.)</p>
 </div>
 <a name="N10125"></a><a name="%5BFOR-721%5D+entries+without+labels+in+site.xml+are+now+being+crawled+and+generated"></a>
@@ -678,10 +678,10 @@
 <a href="http://issues.apache.org/jira/browse/FOR-721">http://issues.apache.org/jira/browse/FOR-721</a>
 </p>
 <p>In our forrest/site-author/content/xdocs/site.xml there are two entries without
&amp;quot;label&amp;quot; attributes. Previously these documents were not being generated.
Not sure if this change in behaviour is good or bad. Needs investigation.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
-This is most likely a side-effect of the workaround for issue FOR-675</p>
+&lt;br/&gt;
+This is most likely a side-effect of the workaround for issue &lt;a href="http://issues.apache.org/jira/browse/FOR-675"
title="upgrading to commons-jxpath-1.2.jar causes failures with linkrewriter protocols site:
etc."&gt;FOR-675&lt;/a&gt;</p>
 </div>
 <a name="N10131"></a><a name="%5BFOR-677%5D+leading+slash+in+gathered+URIs+causes+double+the+number+of+links+to+be+processed"></a>
 <h2 class="underlined_10">[FOR-677] leading slash in gathered URIs causes double the
number of links to be processed</h2>
@@ -690,17 +690,17 @@
 <a href="http://issues.apache.org/jira/browse/FOR-677">http://issues.apache.org/jira/browse/FOR-677</a>
 </p>
 <p>Doing 'forrest' starts at the virtual document called linkmap.html where the Cocoon
crawler gathers the initial set of links, then starts crawling and generating pages. Any new
links are pushed onto the linkmap. However, for some sites, such as our own &amp;quot;seed-sample&amp;quot;
and our &amp;quot;site-author&amp;quot;, there is a sudden jump in the number of URIs
remaining to be processed.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 This is due to a URI with a leading slash (e.g. /samples/faq.html). When that URI is processed,
it gains a whole new set of links all with leading slashes, and so the list of URIs is potentially
doubled.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 This issue could be due to a user error, i.e. adding a link that deliberately begins with
a slash. Sometimes, that is unavoidable.
-&lt;br&gt;
+&lt;br/&gt;
 
-&lt;br&gt;
+&lt;br/&gt;
 However, we do have a sitemap transformer to &amp;quot;relativize&amp;quot; and &amp;quot;absolutize&amp;quot;
the links. Should it always trim the leading slash? Or are there cases where that should not
happen, so cannot generalise?</p>
 </div>
 </div>

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



Mime
View raw message