Return-Path: Delivered-To: apmail-cocoon-docs-archive@www.apache.org Received: (qmail 99470 invoked from network); 30 Jan 2007 04:57:31 -0000 Received: from hermes.apache.org (HELO mail.apache.org) (140.211.11.2) by minotaur.apache.org with SMTP; 30 Jan 2007 04:57:31 -0000 Received: (qmail 87969 invoked by uid 500); 30 Jan 2007 04:57:36 -0000 Delivered-To: apmail-cocoon-docs-archive@cocoon.apache.org Received: (qmail 87945 invoked by uid 500); 30 Jan 2007 04:57:35 -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 87932 invoked by uid 99); 30 Jan 2007 04:57:35 -0000 X-ASF-Spam-Status: No, hits=-9.4 required=10.0 tests=ALL_TRUSTED,NO_REAL_NAME X-Spam-Check-By: apache.org Received: from [140.211.11.67] (HELO cocoon.zones.apache.org) (140.211.11.67) by apache.org (qpsmtpd/0.29) with ESMTP; Mon, 29 Jan 2007 20:57:35 -0800 Message-ID: <8725408.1170133029335.JavaMail.daisy@cocoon.zones.apache.org> Date: Tue, 30 Jan 2007 04:57:09 +0000 (GMT+00:00) From: daisy@cocoon.zones.apache.org To: docs@cocoon.apache.org Subject: [DAISY] Updated: How to contribute documentation? Mime-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: quoted-printable X-Virus-Checked: Checked by ClamAV on apache.org A document has been updated: http://cocoon.zones.apache.org/daisy/documentation/1274.html Document ID: 1274 Branch: main Language: default Name: How to contribute documentation? (unchanged) Document Type: Cocoon Document (unchanged) Updated on: 1/20/07 12:35:44 PM Updated by: Reinhard P=C3=B6tz A new version has been created, state: publish Parts =3D=3D=3D=3D=3D Content ------- This part has been updated. Mime type: text/xml (unchanged) File name: (unchanged) Size: 3478 bytes (previous version: 37 bytes) Content diff: ---

TODO

+++ +++ +++=20 +++

General document

+++=20 +++

These instructions only work if you have an active account in our Da= isy CMS +++ and got the doc editor role assigned. If you haven't, create your accou= nt at +++ http://co= coon.zones.apache.org/daisy/registration +++ and ask at dev[_at_]cocoon.apache.org for editing rights.

+++=20 +++

Doc editors are not allowed to publish a document. Th= is can only +++ be done by Apache Cocoon committers.

+++=20 +++

Editing a document

+++=20 +++

Simply follow the "Edit" link at the bottom of a page, login in and = select +++ Page Actions - Edit from the menu.

+++=20 +++

Adding a document

+++=20 +++

Go to http://cocoon.zones.apache.org/daisy/, login and select the +++ documentation site where you want to add your new document. Select = New +++ Document from the menu. The recommended document type is Cocoo= n +++ document.
+++ If you want to make your new document appear in a navigation menu, clic= k on +++ Go to navigation document below the navigation menu and select +++ Page Actions - Edit.

+++=20 +++

Sitemap component

+++=20 +++

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

+++=20 +++

If you are not a committer, make sure that you have checked out the = latest +++ version of the Java source file from SVN, make your changes and create = a patch +++ file. Create a new patch issue in JIRA and add your diff file.

+++=20 +++

Editing the documentation of a sitemap component

+++=20 +++

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 overwri= tten the +++ next time the sitemaptags2daisy tool is run.

+++=20 +++

Adding documentation for a new sitemap component

+++=20 +++

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

+++=20 +++

Adding javadoc tags

+++=20 +++

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

+++=20 +++

@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 t= o a field +++ in Daisy, thus should not contain HTML markup.

+++=20 +++

Next to these, the @deprecated tag is also synced with the Daisy doc= ument. +++

+++=20 +++

Running the sitemaptags2daisy tool

+++=20 +++

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

+++=20 +++ +++