cocoon-docs mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From da...@cocoon.zones.apache.org
Subject [DAISY] Updated: How to create documentation for a deployment unit (e.g. a block)?
Date Thu, 04 Jan 2007 16:01:27 GMT
A document has been updated:

http://cocoon.zones.apache.org/daisy/documentation/1223.html

Document ID: 1223
Branch: main
Language: default
Name: How to create documentation for a deployment unit (e.g. a block)? (unchanged)
Document Type: Cocoon Document (unchanged)
Updated on: 1/4/07 4:01:17 PM
Updated by: Reinhard Pötz

A new version has been created, state: publish

Parts
=====

Content
-------
This part has been updated.
Mime type: text/xml (unchanged)
File name:  (unchanged)
Size: 8296 bytes (previous version: 7900 bytes)
Content diff:
(85 equal lines skipped)
    
    <ol>
    <li>In Daisy, go to the <tt>cdocs</tt> site</li>
--- <li>Select <tt>Administration</tt> in the navigation menu (so not on
top)</li>
+++ <li>Select <tt>Administration</tt> in the <em>navigation menu</em>
(so not on
+++ top!!!)</li>
    <li>You should now see a tree that represents the navigation tree of the cdocs
    site. This page is here only to provide convenient links to all the navigation
    documents.</li>
    <li>Edit the document to add the links to the navigation document. Make sure the
--- block names are in alphabetical order and reflect the actual menu hierarchy.\
+++ block names are in alphabetical order and reflect the actual menu hierarchy.
    </li>
    <li>Save the document and select the <tt>Cocoon Book</tt> link.</li>
    <li>Edit the navigation document and add a <tt>new import navigation node</tt>
(11 equal lines skipped)
    
    <p>The steps below configure the Maven pom files to make this happen.</p>
    
+++ <h2>Configure the root pom.xml</h2>
+++ 
+++ <p>Create two properties in trunk/pom.xml. This is makes it easier to maintain
+++ these two pieces of information throughout the documentation generation process:
+++ </p>
+++ 
+++ <pre>&lt;properties&gt;
+++   [...] 
+++   &lt;docs.m.forms.version&gt;1.0&lt;/docs.m.pipeline-api.version&gt;
+++   &lt;docs.m.forms.relPath&gt;blocks/forms/${docs.m.forms.version}/&lt;/docs.m.forms.relPath&gt;    

+++ &lt;/properties&gt;
+++ </pre>
+++ 
+++ <p>Open the pom.xml in the root and find the plugin with artifactId
+++ daisy-maven-plugin. Under <tt>collections</tt> add</p>
+++ 
+++ <pre> &lt;collection&gt;
+++     &lt;name&gt;cdocs-forms&lt;/name&gt;
+++     &lt;path&gt;${docs.m.forms.relPath}&lt;/path&gt;
+++   &lt;/collection&gt;</pre>
+++ 
+++ <p>Try to keep the collections in alphabetical order as well.</p>
+++ 
    <h2>Configure the block pom.xml</h2>
    
    <ul>
(18 equal lines skipped)
                    &lt;configuration&gt;
                        &lt;navDocId&gt;1152&lt;/navDocId&gt;
                        &lt;collection&gt;cdocs-forms&lt;/collection&gt;                   
---                         &lt;skipFirstNavigationDocumentLevel&gt;true&lt;/skipFirstNavigationDocumentLevel&gt;
+++                     &lt;skipFirstNavigationDocumentLevel&gt;true&lt;/skipFirstNavigationDocumentLevel&gt;
                    &lt;/configuration&gt;
                &lt;/plugin&gt;
            &lt;/plugins&gt;
(11 equal lines skipped)
    <pre>  &lt;distributionManagement&gt;
        &lt;site&gt;
          &lt;id&gt;website&lt;/id&gt;
---       &lt;url&gt;${docs.deploymentBaseUrl}/blocks/<strong>forms</strong>/${docs.version}/&lt;/url&gt;
+++       &lt;url&gt;${docs.deploymentBaseUrl}/${docs.m.forms.relPath}&lt;/url&gt;
        &lt;/site&gt;
      &lt;/distributionManagement&gt;
      &lt;properties&gt;
        &lt;docs.name&gt;<strong>Cocoon Forms</strong>&lt;/docs.name&gt;
   
---     &lt;docs.version&gt;<strong>1.0</strong>&lt;/docs.version&gt;
+++     &lt;docs.version&gt;${docs.m.forms.version}&lt;/docs.version&gt;
      &lt;/properties&gt;
    </pre>
    
(16 equal lines skipped)
    
    <p>Keep the modules in alphabetical order to ease maintenance.</p>
    
--- <h2>Configure the root pom.xml</h2>
--- 
--- <p>Open the pom.xml in the root and find the plugin with artifactId
--- daisy-maven-plugin. Under <tt>collections</tt> add</p>
--- 
--- <pre> &lt;collection&gt;
---     &lt;name&gt;cdocs-forms&lt;/name&gt;
---     &lt;path&gt;blocks/forms/1.0/&lt;/path&gt;
---   &lt;/collection&gt;</pre>
--- 
--- <p>Try to keep the collections in alphabetical order as well.</p>
--- 
    </body>
    </html>


Mime
View raw message