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 block
Date Mon, 02 Oct 2006 17:30:04 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 block (unchanged)
Document Type: Cocoon Document (unchanged)
Updated on: 10/2/06 2:46:28 PM
Updated by: Helma van der Linden

A new version has been created, state: draft

Parts
=====

Content
-------
This part has been updated.
Mime type: text/xml (unchanged)
File name:  (unchanged)
Size: 2086 bytes (previous version: 861 bytes)
Content diff:
(7 equal lines skipped)
    site.</p>
    
    <p>The following steps outline the process to go through to create a block site.
--- </p>
+++ As an example we use the CForms block.</p>
    
    <h1>Create the collection</h1>
    
    <p>In Daisy, open Administration -&gt; Manage collections.<br/>
    Add a new collection for the block. The name should be
    <tt>cdocs-blockname</tt>, where <tt>blockname</tt> is the part
of the name of
    the block after cocoon. Example: when the block is named <tt>cocoon-forms</tt>,
--- the name of the collection should be <tt>cdocs-forms</tt>.<br/>
--- Note the id of the collection (in this case 7).</p>
+++ the name of the collection should be <em>cdocs-forms</em>. <br/>
+++ Note the id of the collection (in this case <em>7</em>).</p>
    
+++ <h1>Create the navigation document</h1>
+++ 
+++ <p>Each block has its own navigation document, which simplifies the packaging of
+++ the documation strictly for that block.</p>
+++ 
+++ <ol>
+++ <li>In Daisy, create a New Document and choose type <tt>Book Definition</tt>.
+++ </li>
+++ <li>Set the name of the document to <tt>&lt;user friendly name&gt;
Block
+++ [navigation]</tt>. For the CForms block that would be <em>Forms Block
+++ [navigation]</em>.</li>
+++ <li>Go to the Misc tab and add the proper collection, in this case cdocs-forms.
+++ </li>
+++ <li>Underneath the root, add the toplevel folder for this block, by adding a new
+++ section node. Set the title to a user friendly name of the block. For the CForms
+++ block that would be <em>Forms</em>.</li>
+++ <li>Underneath this folder, add two documents, one is called
+++ <strong>Introduction</strong>, one is called <strong>Samples</strong>.
You can
+++ create the documents by adding a new section node, and then select the "link to
+++ new document" button (second button after the document ID). Make sure these
+++ documents are also part of the proper collection, i.e. the
+++ <em>cdocs-forms</em>.</li>
+++ </ol>
+++ 
+++ <p>Note the id of the navigation document (in this case <em>489</em>).</p>
+++ 
    </body>
    </html>


Mime
View raw message