Author: crossley Date: Wed Dec 1 19:30:11 2004 New Revision: 109442 URL: http://svn.apache.org/viewcvs?view=rev&rev=109442 Log: Minor text add to Introduction.
Modified: cocoon/site/site/2.1/plan/review-sitemap-docs.html cocoon/site/site/2.1/plan/review-sitemap-docs.pdf Modified: cocoon/site/site/2.1/plan/review-sitemap-docs.html Url: http://svn.apache.org/viewcvs/cocoon/site/site/2.1/plan/review-sitemap-docs.html?view=diff&rev=109442&p1=cocoon/site/site/2.1/plan/review-sitemap-docs.html&r1=109441&p2=cocoon/site/site/2.1/plan/review-sitemap-docs.html&r2=109442 ============================================================================== --- cocoon/site/site/2.1/plan/review-sitemap-docs.html (original) +++ cocoon/site/site/2.1/plan/review-sitemap-docs.html Wed Dec 1 19:30:11 2004 @@ -216,7 +216,7 @@ </table> <ul class="minitoc"> <li> -<a href="#Overview">Overview</a> +<a href="#Introduction">Introduction</a> </li> <li> <a href="#Coordination+table">Coordination table</a> @@ -249,8 +249,8 @@ </li> </ul> -<a name="N10013"></a><a name="Overview"></a> -<h3>Overview</h3> +<a name="N10013"></a><a name="Introduction"></a> +<h3>Introduction</h3> <div style="margin-left: 0 ; border: 2px"> <p> This is a coordination table to assist the systematic review of the @@ -261,7 +261,16 @@ (actions generators matchers readers selectors serializers transformers). </p> <p> - Please see the <a href="#To+Do">To Do</a> section at the bottom. + This review focusses only on this set of documentation, as part of + the overall documentation review. This set is a key part, because it + addresses the heart of Cocoon - the sitemap components. Having a + well-defined "User Guide" will assist both users and developers to + be more productive. + </p> +<p> + Please assist by sending discussion to the dev mailing list and + patches of xdocs and java code via the issue tracker. + See the <a href="#To+Do">To Do</a> section at the bottom. </p> <p> This documentation is generated as part of the Cocoon 'build docs' process. @@ -286,7 +295,7 @@ <li>@cocoon.sitemap.component.hide - If this tag is specified, the component is not added to the sitemap (optional)</li> -<li>@cocoon.sitemap.component.documentation.disabled - If this tag is specified no documentation is generated (optional)</li> +<li>@cocoon.sitemap.component.documentation.disabled - If this tag is specified, no documentation is generated (optional)</li> <li>@cocoon.sitemap.component.documentation description - The documentation (optional)</li> @@ -304,7 +313,7 @@ </div> -<a name="N10054"></a><a name="Coordination+table"></a> +<a name="N10057"></a><a name="Coordination+table"></a> <h3>Coordination table</h3> <div style="margin-left: 0 ; border: 2px"> <p>The table columns are:</p> @@ -312,9 +321,10 @@ <li>Java source - The name of the Java source file and link to javadoc.</li> -<li>Document - The name of the generated document and a link to it.</li> +<li>Document - The name of the generated document and a link to it. + This is also the @cocoon.sitemap.component.name</li> -<li>A - The xdoc is present to supply additional manual content.</li> +<li>A - The xdoc is available to supply additional manual content.</li> <li>B - The java code is in "core" or as a "block".</li> @@ -338,7 +348,7 @@ </ul> <p>There are 282 entries.</p> -<a name="N10089"></a><a name="Actions"></a> +<a name="N1008C"></a><a name="Actions"></a> <h4>Actions</h4> <div style="margin-left: 0 ; border: 2px"> <table class="ForrestTable" cellspacing="1" cellpadding="4"> @@ -1204,7 +1214,7 @@ </table> </div> -<a name="N10BDE"></a><a name="Generators"></a> +<a name="N10BE1"></a><a name="Generators"></a> <h4>Generators</h4> <div style="margin-left: 0 ; border: 2px"> <table class="ForrestTable" cellspacing="1" cellpadding="4"> @@ -1839,7 +1849,7 @@ </table> </div> -<a name="N11459"></a><a name="Matchers"></a> +<a name="N1145C"></a><a name="Matchers"></a> <h4>Matchers</h4> <div style="margin-left: 0 ; border: 2px"> <table class="ForrestTable" cellspacing="1" cellpadding="4"> @@ -2188,7 +2198,7 @@ </table> </div> -<a name="N118E0"></a><a name="Readers"></a> +<a name="N118E3"></a><a name="Readers"></a> <h4>Readers</h4> <div style="margin-left: 0 ; border: 2px"> <table class="ForrestTable" cellspacing="1" cellpadding="4"> @@ -2317,7 +2327,7 @@ </table> </div> -<a name="N11A8F"></a><a name="Selectors"></a> +<a name="N11A92"></a><a name="Selectors"></a> <h4>Selectors</h4> <div style="margin-left: 0 ; border: 2px"> <table class="ForrestTable" cellspacing="1" cellpadding="4"> @@ -2567,7 +2577,7 @@ </table> </div> -<a name="N11DD8"></a><a name="Serializers"></a> +<a name="N11DDB"></a><a name="Serializers"></a> <h4>Serializers</h4> <div style="margin-left: 0 ; border: 2px"> <table class="ForrestTable" cellspacing="1" cellpadding="4"> @@ -2894,7 +2904,7 @@ </table> </div> -<a name="N12216"></a><a name="Transformers"></a> +<a name="N12219"></a><a name="Transformers"></a> <h4>Transformers</h4> <div style="margin-left: 0 ; border: 2px"> <table class="ForrestTable" cellspacing="1" cellpadding="4"> @@ -3576,7 +3586,7 @@ </div> -<a name="N12B1D"></a><a name="To+Do"></a> +<a name="N12B20"></a><a name="To+Do"></a> <h3>To Do</h3> <div style="margin-left: 0 ; border: 2px"> <p>Not a list of everything to be done, just a few notes ...</p> Modified: cocoon/site/site/2.1/plan/review-sitemap-docs.pdf Url: http://svn.apache.org/viewcvs/cocoon/site/site/2.1/plan/review-sitemap-docs.pdf?view=diff&rev=109442&p1=cocoon/site/site/2.1/plan/review-sitemap-docs.pdf&r1=109441&p2=cocoon/site/site/2.1/plan/review-sitemap-docs.pdf&r2=109442 ============================================================================== Binary files. No diff available.
