Return-Path: Delivered-To: apmail-cocoon-docs-archive@www.apache.org Received: (qmail 11888 invoked from network); 26 Mar 2006 16:53:51 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (209.237.227.199) by minotaur.apache.org with SMTP; 26 Mar 2006 16:53:51 -0000 Received: (qmail 16597 invoked by uid 500); 26 Mar 2006 16:53:50 -0000 Delivered-To: apmail-cocoon-docs-archive@cocoon.apache.org Received: (qmail 16440 invoked by uid 500); 26 Mar 2006 16:53:49 -0000 Mailing-List: contact docs-help@cocoon.apache.org; run by ezmlm Precedence: bulk list-help: list-unsubscribe: List-Post: Reply-To: docs@cocoon.apache.org List-Id: Delivered-To: mailing list docs@cocoon.apache.org Received: (qmail 16429 invoked by uid 99); 26 Mar 2006 16:53:49 -0000 X-ASF-Spam-Status: No, hits=0.6 required=10.0 tests=NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [207.7.158.203] (HELO cocoon.zones.apache.org) (207.7.158.203) by apache.org (qpsmtpd/0.29) with ESMTP; Sun, 26 Mar 2006 08:53:48 -0800 Message-ID: <12722803.1143391988831.JavaMail.daisy@cocoon.zones.apache.org> Date: Sun, 26 Mar 2006 16:53:08 +0000 (GMT+00:00) From: daisy@cocoon.zones.apache.org To: docs@cocoon.apache.org Subject: [DAISY] Created: Sitemap component documentation Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-Virus-Checked: Checked by ClamAV on apache.org X-Spam-Rating: minotaur.apache.org 1.6.2 0/1000/N A new document has been created. http://cocoon.zones.apache.org/daisy/documentation/1066.html Document ID: 1066 Branch: main Language: default Name: Sitemap component documentation Document Type: Cocoon Document Created: 3/26/06 4:52:48 PM Creator (owner): Bruno Dumon State: publish Parts ===== Content ------- Mime type: text/xml Size: 2138 bytes Content:

For documenting sitemap components, we use a system whereby certain parts of the documentation are extracted automatically from the Java sources using a tool called sitemaptags2daisy.

Editing the documentation of a sitemap component

Only edit the content of the the Long Description part in Daisy. The short description and the value of the fields are automatically assigned from the Java sources, so if you change them in Daisy, these changes will get overwritten the next time the sitemaptags2daisy tool is run.

Adding documentation for a new sitemap component

If running the sitemaptags2daisy tool is not an option (no time, no privileges, ...) then create manually a document of type "Sitemap Component". In the JavaClass field, enter the fully qualified name of the implementation class. Leave the other fields and the Short Description part empty, they will be assigned the next time the sitemaptags2daisy tool runs. Enter the documentation in the Long Description part.

Adding javadoc tags

The following special javadoc tags are supported (none of these are strictly required by the sitemaptags2daisy tool):

@cocoon.sitemap.component.name
default name with which this component is declared in the sitemap
@cocoon.sitemap.component.documentation.disabled
excludes the component from the documentation
@cocoon.sitemap.component.documentation
A short (one-paragraph) description of the component. Can contain HTML markup (preferably only inline tags).
@cocoon.sitemap.component.documentation.caching
A comment about the caching of this component. The cacheability of the component is figured out automatially by its implemented interfaces, but this tag allows to provide a short comment on the chaching conditions. This is mapped to a field in Daisy, thus should not contain HTML markup.

Next to these, the @deprecated tag is also synced with the Daisy document.

Running the sitemaptags2daisy tool

TODO, see the README.txt in the sources for now.

Collections =========== The document belongs to the following collections: documentation