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ö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: 3478 bytes (previous version: 37 bytes) Content diff: --- <html><body><p>TODO</p></body></html> +++ <html> +++ <body> +++ +++ <h1>General document</h1> +++ +++ <p>These instructions only work if you have an active account in our Daisy CMS +++ and got the doc editor role assigned. If you haven't, create your account at +++ <a href="http://cocoon.zones.apache.org/daisy/registration";>http://cocoon.zones.apache.org/daisy/registration</a> +++ and ask at dev[_at_]cocoon.apache.org for editing rights.</p> +++ +++ <p class="note">Doc editors are not allowed to publish a document. This can only +++ be done by Apache Cocoon committers.</p> +++ +++ <h2>Editing a document</h2> +++ +++ <p>Simply follow the "Edit" link at the bottom of a page, login in and select +++ <em>Page Actions - Edit</em> from the menu.</p> +++ +++ <h2>Adding a document</h2> +++ +++ <p>Go to http://cocoon.zones.apache.org/daisy/, login and select the +++ documentation site where you want to add your new document. Select <em>New +++ Document</em> from the menu. The recommended document type is <em>Cocoon +++ document</em>.<br/> +++ If you want to make your new document appear in a navigation menu, click on +++ <em>Go to navigation</em> document below the navigation menu and select +++ <em>Page Actions - Edit</em>.</p> +++ +++ <h1>Sitemap component</h1> +++ +++ <p>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.</p> +++ +++ <p>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.</p> +++ +++ <h2>Editing the documentation of a sitemap component</h2> +++ +++ <p>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.</p> +++ +++ <h2>Adding documentation for a new sitemap component</h2> +++ +++ <p>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.</p> +++ +++ <h2>Adding javadoc tags</h2> +++ +++ <p>The following special javadoc tags are supported (none of these are strictly +++ required by the sitemaptags2daisy tool):</p> +++ +++ <ul> +++ <li>@cocoon.sitemap.component.name<br/> +++ default name with which this component is declared in the sitemap</li> +++ <li>@cocoon.sitemap.component.documentation.disabled<br/> +++ excludes the component from the documentation</li> +++ <li>@cocoon.sitemap.component.documentation<br/> +++ A short (one-paragraph) description of the component. Can contain HTML markup +++ (preferably only inline tags).</li> +++ <li>@cocoon.sitemap.component.documentation.caching<br/> +++ 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.</li> +++ </ul> +++ +++ <p>Next to these, the @deprecated tag is also synced with the Daisy document. +++ </p> +++ +++ <h2>Running the sitemaptags2daisy tool</h2> +++ +++ <p>TODO, see the README.txt in the sources for now.</p> +++ +++ </body> +++ </html>
