svn commit: r1311666 [2/12] - in /cocoon/site/site: ./ css/ images/ js/
[email protected] Tue, 10 Apr 2012 10:24:49 -0000
Newsgroups
gmane.text.xml.cocoon.cvs
Message-ID
<[email protected] >
Modified: cocoon/site/site/1223_1_1.html
URL: http://svn.apache.org/viewvc/cocoon/site/site/1223_1_1.html?rev=1311666&r1=1311665&r2=1311666&view=diff
==============================================================================
--- cocoon/site/site/1223_1_1.html (original)
+++ cocoon/site/site/1223_1_1.html Tue Apr 10 10:24:47 2012
@@ -1,482 +1,426 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-
-
-
-
-
-
-
-<html>
- <head>
- <title> Cocoon Main Site - How to create documentation for a deployment unit (e.g. a block)?
- </title>
- <style type="text/css" media="all">
- @import url("./css/maven-base.css");
- @import url("./css/maven-theme.css");
- @import url("./css/site.css");
- </style>
- <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <script src="./js/getBlank.js" language="javascript" type="text/javascript"></script>
- <meta name="author" content="The Cocoon Community" />
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
- </head>
- <body>
- <div id="breadtrail">
- <p><a href="http://www.apache.org">Apache</a> » <a href="./">Cocoon</a> »</p>
- </div>
- <div id="top">
- <div id="header">
- <div class="projectlogo">
- <a href="./"><img class="logoImage"
- src="images/cocoon_logo.jpg"
- alt="Apache Cocoon" border="0" /></a>
- </div>
- <div class="grouplogo">
- <p class="grouptitle"><a href="./">The Apache Cocoon Project</a><img
- src="images/apache-logo.jpg" alt="Cocoon Project Logo" /></p>
- <form class="searchbox" action="http://www.google.com/search" method="get">
- <input value="cocoon.apache.org" name="sitesearch" type="hidden" />
- <input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google" />
- <input class="searchboxsubmit" name="Search" value="Search" type="submit" />
- </form>
- </div>
- </div>
- <div id="projectBar">
- <p class="cocoonHome"><a href="./index.html"><img
- src="images/pmc-home.gif"
- alt=" Apache Cocoon
- homepage"
- border="0" title=" Apache Cocoon
- homepage" /></a></p>
- <h1 class="projectTitle"><a href="./index.html"> Apache Cocoon
- </a></h1>
- <ul class="projectList">
- <li><strong><a href="./2.2/">Cocoon 2.2</a></em></strong></li>
- <li><a href="./2.2/core-modules/">Core <span class="pl-version-small">2.2</span></a></li>
- <li><a href="./2.2/blocks/">Blocks <span class="pl-version-small">2.2</span></a></li>
- <li><a href="./2.2/maven-plugins/">Maven Plugins <span class="pl-version-small">2.2</span></a></li>
- <li><strong><a href=".//3.0/">Cocoon 3.0 <span class="pl-version-small">[alpha]</span></a></em></strong></li>
- <li><strong><a href="./subprojects/">Subprojects</a></strong></li>
- </ul>
- </div>
- <div class="projectBarClear"><!-- --></div>
- </div>
- <!-- end of top -->
-
- <div id="content">
- <ul id="menu">
- <li>
- About Cocoon
- <ul>
-
- <li >
- <a href="1285_1_1.html">Welcome</a>
- </li>
-
- <li >
- <a href="1363_1_1.html">Features</a>
- </li>
-
- <li >
- <a href="1284_1_1.html">Versions & Download</a>
- </li>
-
- <li >
- <a href="1271_1_1.html">Professional Services</a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class='menuCollapse'>
- <a href="1365_1_1.html">Who uses Cocoon?</a>
- </li>
-
- <li >
- <a href="1272_1_1.html">Weblogs</a>
- </li>
-
- <li >
- <a href="1178_1_1.html">History</a>
- </li>
-
- <li >
- <a href="1508_1_1.html">Privacy Policy</a>
- </li>
- </ul>
- </li>
- <li>
- Getting started
- <ul>
-
- <li >
- <a href="1370_1_1.html">Tutorials</a>
- </li>
- </ul>
- </li>
- <li>
- Getting better
- <ul>
-
- <li >
- <a href="1286_1_1.html">About the online documentation</a>
- </li>
-
- <li >
- <a href="1287_1_1.html">Presentations</a>
- </li>
-
- <li >
- <a href="1368_1_1.html">How-Tos</a>
- </li>
-
- <li >
- <a href="1288_1_1.html">Articles</a>
- </li>
-
- <li >
- <a href="1289_1_1.html">Books</a>
- </li>
- </ul>
- </li>
- <li>
- Getting involved
- <ul>
-
- <li >
- <a href="1273_1_1.html">How to contribute?</a>
- </li>
-
- <li >
- <a href="1275_1_1.html">Communication tools that we use</a>
- </li>
-
- <li >
- <a href="1276_1_1.html">Other tools that we use</a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class='menuExpand'>
- <a href="798_1_1.html">Committer's and contributor's section</a>
- <ul>
-
-
-
-
-
-
-
-
-
-
-
- <li class='menuCollapse'>
- <a href="798_1_1.html">Working with Cocoon from SVN</a>
- </li>
-
- <li >
- <a href="1301_1_1.html">Debugging Cocoon in Eclipse</a>
- </li>
-
- <li >
- <a href="636_1_1.html">Apache Cocoon Tests</a>
- </li>
-
- <li >
- <a href="1199_1_1.html">Releasing Cocoon</a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class='menuExpand'>
- <a href="1418_1_1.html">Documentation</a>
- <ul>
-
- <li >
- <a href="1418_1_1.html">How to publish docs to cocoon.apache.org</a>
- </li>
-
- <li >
- <a href="1256_1_1.html">How to build the site locally</a>
- </li>
-
- <li >
- <strong>How to create documentation for a deployment unit (e.g. a block)?</strong>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- <li>
- Project Documentation
- <ul>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class='menuCollapse'>
- <a href="project-info.html">Project Information</a>
- </li>
- </ul>
- </li>
- <li class="menuVersions">Versions
- <ul>
- <li><a href="./3.0/">Cocoon 3.0 <span class="pl-version-small">[alpha]</span></a></li>
- <li><a href="./2.2/">Cocoon 2.2</a></li>
- <li><a href="./2.1/">Cocoon 2.1</a></li>
- <li><a href="./2.0/">Cocoon 2.0</a></li>
- <li><a href="./1.x/">Cocoon 1.x</a></li>
- </ul>
- </li>
- </ul>
- <div class="main">
- <div id="contentBody"><div id="bodyText"><h1 class="docTitle">How to create documentation for a deployment unit (e.g. a block)?</h1><p>In Cocoon 2.2 each block has its own release cycle and also its own
-documentation set. This set is created through a separate site in Daisy. Each
-set has its own collection which is used by the Daisy export plugin in Maven to
-build the complete site, either locally at your hard disk, or at the official
-site.</p><p>The following steps outline the process to go through to create a block site.
-As an example we use the CForms block.</p><h1 xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">Create the collection</h1><p>In Daisy, open Administration -> Manage collections.<br></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 <em>cdocs-forms</em>. <br></br>
-Note the id of the collection (in this case <em>7</em>).</p><h1 xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">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 type="1">
-<li>In Daisy, create a New Document and choose type <tt>Book Definition</tt>.
-</li>
-<li>Set the name of the document to <tt><user friendly name> 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>
-<li>Publish the document (mark a checkbox 'Publish changes immediately').</li>
-</ol>Note the id of the navigation document (in this case <em>1152</em>).<h1 xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">Create a new Daisy site</h1>Each block gets its own site in Daisy. Before adding documentation about the
-block, the site should be selected. This way all documents will automatically be
-in the proper collection.The steps below describe how to create a new Daisy site.<ol type="1">
-<li>Log in to cocoon.zones.apache.org with your username and password</li>
-<li>change to user daisy: <tt>sudo su - daisy</tt></li>
-<li><tt>cd daisywikidata/sites</tt></li>
-<li>copy another block to the new block with blockname equal to the collection
-name. Example: <tt>cp -R cdocs-fop cdocs-forms</tt></li>
-<li>cd into the new folder: <tt>cd cdocs-forms</tt></li>
-<li>modify the siteconf.xml file:
-<ul>
-<li>change the <tt>title</tt> to match the name of the navigation document
-(without the [navigation] part), e.g. <em>Forms Block</em></li>
-<li>change the <tt>description</tt> to match the block name, e.g.<em>
-Documentation of the Forms Block<br></br>
-</em></li>
-<li>change the <tt>navigationDocId</tt> to the id of the navigation document (in
-this case <em>1152</em>)</li>
-<li>change the <tt>homepageDocId</tt> to the id of the introduction document (in
-this case <em>489</em>)</li>
-<li>change the <tt>collectionId</tt> to the id of the new collection (in this
-case <em>7</em>)</li>
-</ul>
-</li>
-<li>save the file and logout of the server.</li>
-</ol><h1 xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">Add the navigation to the master navigation file</h1>To show the block documentation in the total Cocoon documentation site, which
-is the source for the official documentation, you need to add the navigation
-document to the master navigation file. Do this step <strong>after</strong>
-creating the site, as a reminder that the site should be created as well.<br></br>
-These are the steps to take:<ol type="1">
-<li>In Daisy, go to the <tt>cdocs: Apache Cocoon</tt> site</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.
-</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>
-with the id of the navigation document (in this case <em>1152</em>)</li>
-</ol><div class="note"><div><strong>Note: </strong>When adding documentation for the block, be sure you select the
-proper site first!</div></div><h1 xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">Configuring the Maven pom files</h1>With the Daisy Maven plugin the information can be extracted from Daisy and
-built into the official site, either locally or at the official Cocoon
-documentation site.The steps below configure the Maven pom files to make this happen.<h2 xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">Configure the root pom.xml</h2>Create two properties in trunk/parent/pom.xml. This is makes it easier to
-maintain these two pieces of information throughout the documentation generation
-process:<pre><properties>
- [...]
- <docs.m.forms.version>1.0</docs.m.forms.version>
- <docs.m.forms.relPath>blocks/forms/${docs.m.forms.version}/</docs.m.forms.relPath>
-</properties>
-</pre>Open the pom.xml in the root and find the plugin with artifactId
-daisy-maven-plugin. Under <tt>collections</tt> add<pre> <collection>
- <name>cdocs-forms</name>
- <path>${docs.m.forms.relPath}</path>
- </collection></pre>Try to keep the collections in alphabetical order as well.<h2 xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">Configure the block pom.xml</h2><ul>
-<li>Open the <tt>pom.xml</tt> file of the block, e.g.
-<em>cocoon-forms-impl/pom.xml</em></li>
-<li>Open a pom.xml file of a block that is already configured, e.g. cocoon-fop
-and copy the plugin with the groupID <tt>org.daisycms </tt>and artifactId<tt>
-daisy-maven-plugin</tt></li>
-<li>Add this to your pom file under <build>, <plugins>, if necessary
-create these tags. The build section should look like this (at least containing
-the daisy-maven-plugin part)</li>
-</ul><ol type="1">
-</ol><pre> <build>
- <plugins>
- <plugin>
- <groupId>org.daisycms</groupId>
- <artifactId>daisy-maven-plugin</artifactId>
- <configuration>
- <navDocId>1152</navDocId>
- <collection>cdocs-forms</collection>
- <skipFirstNavigationDocumentLevel>true</skipFirstNavigationDocumentLevel>
- </configuration>
- </plugin>
- </plugins>
- </build></pre><ul>
-<li>Change the <tt>navDocId</tt> to the id of the navigation document, in this
-case <em>1152</em></li>
-<li>Change the <tt>collection</tt> to the name of the collection, in this case
-<em>cdocs-forms</em></li>
-<li>Add the distributionManagment part and the properties as well at the same
-level as the build tag.</li>
-</ul><pre> <distributionManagement>
- <site>
- <id>website</id>
- <url>${docs.deploymentBaseUrl}/${docs.m.forms.relPath}</url>
- </site>
- </distributionManagement>
- <properties>
- <docs.name><strong xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">Cocoon Forms</strong></docs.name>
- <docs.version>${docs.m.forms.version}</docs.version>
- </properties>
-</pre><ul>
-<li>Change the path in the <tt>url</tt> to match the block name, here
-<em>forms</em></li>
-<li>Change the property <tt>docs.name</tt> to match the user friendly name of
-the block, here <em>Cocoon Forms</em></li>
-<li>Set the <tt>docs.version</tt> property to 1.0 initially and update it to
-reflect the documentation version.</li>
-</ul><h2 xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">Configure the site pom.xml</h2>Open the pom.xml in the site and add a module to the section Cocoon Blocks:
-<pre> <module>../blocks/cocoon-forms/cocoon-forms-impl</module>
-</pre>Keep the modules in alphabetical order to ease maintenance.</div><div class="editUrl"><div><em>Errors and Improvements?</em> If you see any errors or potential improvements in this document please help
- us: <a href="http://cocoon.zones.apache.org/daisy/cdocs/1223?branch=1&language=1">View, Edit or comment</a> on the latest development version (registration required).
- </div></div></div>
- </div>
- </div>
-
- <!-- end of content -->
- <div id="footer">
- <p>©
- 1999-2009
-
- The Apache Software Foundation
- </p>
- </div>
- <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
- </script>
- <script type="text/javascript">
- _uacct = "UA-1740622-3";
- urchinTracker();
- </script>
-
- </body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+
+
+
+
+
+
+
+<html>
+ <head>
+ <title> Cocoon Main Site - How to create documentation for a deployment unit (e.g. a block)?
+ </title>
+ <link rel="stylesheet" href="./css/apache-cocoon-thien-maven-skin.min.css" />
+ <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
+ <script src="./js/apache-cocoon-thien-maven-skin.min.js" language="javascript" type="text/javascript"></script>
+ <meta name="author" content="Apache Cocoon Documentation Team" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ </head>
+ <body onload="javascript:prettyPrint();">
+ <div id="breadtrail">
+ <p><a href="http://www.apache.org">Apache</a> » <a href="./">Cocoon</a> »</p>
+ </div>
+ <div id="top">
+ <div id="header">
+ <div class="projectlogo">
+ <a href="./"><img class="logoImage"
+ src="images/cocoon_logo.jpg"
+ alt="Apache Cocoon" border="0" /></a>
+ </div>
+ <div class="grouplogo">
+ <p class="grouptitle"><a href="./">The Apache Cocoon Project</a><img
+ src="images/apache-logo.jpg" alt="Cocoon Project Logo" /></p>
+ <form class="searchbox" action="http://www.google.com/search" method="get">
+ <input value="cocoon.apache.org" name="sitesearch" type="hidden" />
+ <input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google" />
+ <input class="searchboxsubmit" name="Search" value="Search" type="submit" />
+ </form>
+ </div>
+ </div>
+ <div id="projectBar">
+ <p class="cocoonHome"><a href="./index.html"><img
+ src="images/pmc-home.gif"
+ alt=" Apache Cocoon
+ homepage"
+ border="0" title=" Apache Cocoon
+ homepage" /></a></p>
+ <h1 class="projectTitle"><a href="./index.html"> Apache Cocoon
+ </a></h1>
+ <ul class="projectList">
+ <li><strong><a href="./2.2/">Cocoon 2.2</a></em></strong></li>
+ <li><a href="./2.2/core-modules/">Core <span class="pl-version-small">2.2</span></a></li>
+ <li><a href="./2.2/blocks/">Blocks <span class="pl-version-small">2.2</span></a></li>
+ <li><a href="./2.2/maven-plugins/">Maven Plugins <span class="pl-version-small">2.2</span></a></li>
+ <li><strong><a href=".//3.0/">Cocoon 3.0</a></em></strong></li>
+ <li><strong><a href="./subprojects/">Subprojects</a></strong></li>
+ </ul>
+ </div>
+ <div class="projectBarClear"><!-- --></div>
+ </div>
+ <!-- end of top -->
+
+ <div id="content">
+ <ul id="menu">
+ <li>
+ About Cocoon
+ <ul>
+
+ <li >
+ <a href="index.html">Welcome</a>
+ </li>
+
+ <li >
+ <a href="1363_1_1.html">Features</a>
+ </li>
+
+ <li >
+ <a href="1284_1_1.html">Versions & Download</a>
+ </li>
+
+ <li >
+ <a href="1271_1_1.html">Professional Services</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class='menuCollapse'>
+ <a href="1365_1_1.html">Who uses Cocoon?</a>
+ </li>
+
+ <li >
+ <a href="1272_1_1.html">Weblogs</a>
+ </li>
+
+ <li >
+ <a href="1178_1_1.html">History</a>
+ </li>
+
+ <li >
+ <a href="1508_1_1.html">Privacy Policy</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ Getting Started
+ <ul>
+
+ <li >
+ <a href="1370_1_1.html">Tutorials</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ Getting Better
+ <ul>
+
+ <li >
+ <a href="1286_1_1.html">About the online documentation</a>
+ </li>
+
+ <li >
+ <a href="1287_1_1.html">Presentations</a>
+ </li>
+
+ <li >
+ <a href="1368_1_1.html">How-Tos</a>
+ </li>
+
+ <li >
+ <a href="1288_1_1.html">Articles</a>
+ </li>
+
+ <li >
+ <a href="1289_1_1.html">Books</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ Getting involved
+ <ul>
+
+ <li >
+ <a href="1273_1_1.html">How to contribute?</a>
+ </li>
+
+ <li >
+ <a href="1275_1_1.html">Communication tools that we use</a>
+ </li>
+
+ <li >
+ <a href="1276_1_1.html">Other tools that we use</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class='menuCollapse'>
+ <a href="1199_1_1.html">Committer's and contributor's section</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ Project Documentation
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class='menuCollapse'>
+ <a href="project-info.html">Project Information</a>
+ </li>
+ </ul>
+ </li>
+ <li class="menuVersions">Versions
+ <ul>
+ <li><a href="./3.0/">Cocoon 3.0</a></li>
+ <li><a href="./2.2/">Cocoon 2.2</a></li>
+ <li><a href="./2.1/">Cocoon 2.1</a></li>
+ <li><a href="./2.0/">Cocoon 2.0</a></li>
+ <li><a href="./1.x/">Cocoon 1.x</a></li>
+ </ul>
+ </li>
+ </ul>
+ <div class="main">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License. -->
+ <div id="contentBody"><div id="bodyText"><h1 class="docTitle">How to create documentation for a deployment unit (e.g. a block)?</h1><p>In Cocoon 2.2 each block has its own release cycle and also its own
+documentation set. This set is created through a separate site in Daisy. Each
+set has its own collection which is used by the Daisy export plugin in Maven to
+build the complete site, either locally at your hard disk, or at the official
+site.</p><p>The following steps outline the process to go through to create a block site.
+As an example we use the CForms block.</p><h1>Create the collection</h1><p>In Daisy, open Administration -> 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 <i>cdocs-forms</i>. <br />
+Note the id of the collection (in this case <i>7</i>).</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 style="list-style-type: decimal">
+<li>In Daisy, create a New Document and choose type <tt>Book Definition</tt>.
+</li>
+<li>Set the name of the document to <tt><user friendly name> Block
+[navigation]</tt>. For the CForms block that would be <i>Forms Block
+[navigation]</i>.</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 <i>Forms</i>.</li>
+<li>Underneath this folder, add two documents, one is called
+<b>Introduction</b>, one is called <b>Samples</b>. 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
+<i>cdocs-forms</i>.</li>
+<li>Publish the document (mark a checkbox 'Publish changes immediately').</li>
+</ol>Note the id of the navigation document (in this case <i>1152</i>).<h1>Create a new Daisy site</h1>Each block gets its own site in Daisy. Before adding documentation about the
+block, the site should be selected. This way all documents will automatically be
+in the proper collection.The steps below describe how to create a new Daisy site.<ol style="list-style-type: decimal">
+<li>Log in to cocoon.zones.apache.org with your username and password</li>
+<li>change to user daisy: <tt>sudo su - daisy</tt></li>
+<li><tt>cd daisywikidata/sites</tt></li>
+<li>copy another block to the new block with blockname equal to the collection
+name. Example: <tt>cp -R cdocs-fop cdocs-forms</tt></li>
+<li>cd into the new folder: <tt>cd cdocs-forms</tt></li>
+<li>modify the siteconf.xml file:
+<ul>
+<li>change the <tt>title</tt> to match the name of the navigation document
+(without the [navigation] part), e.g. <i>Forms Block</i></li>
+<li>change the <tt>description</tt> to match the block name, e.g.<i>
+Documentation of the Forms Block<br />
+</i></li>
+<li>change the <tt>navigationDocId</tt> to the id of the navigation document (in
+this case <i>1152</i>)</li>
+<li>change the <tt>homepageDocId</tt> to the id of the introduction document (in
+this case <i>489</i>)</li>
+<li>change the <tt>collectionId</tt> to the id of the new collection (in this
+case <i>7</i>)</li>
+</ul>
+</li>
+<li>save the file and logout of the server.</li>
+</ol><h1>Add the navigation to the master navigation file</h1>To show the block documentation in the total Cocoon documentation site, which
+is the source for the official documentation, you need to add the navigation
+document to the master navigation file. Do this step <b>after</b>
+creating the site, as a reminder that the site should be created as well.<br />
+These are the steps to take:<ol style="list-style-type: decimal">
+<li>In Daisy, go to the <tt>cdocs: Apache Cocoon</tt> site</li>
+<li>Select <tt>Administration</tt> in the <i>navigation menu</i> (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.
+</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>
+with the id of the navigation document (in this case <i>1152</i>)</li>
+</ol><div class="note"><div><b>Note: </b>When adding documentation for the block, be sure you select the
+proper site first!</div></div><h1>Configuring the Maven pom files</h1>With the Daisy Maven plugin the information can be extracted from Daisy and
+built into the official site, either locally or at the official Cocoon
+documentation site.The steps below configure the Maven pom files to make this happen.<div class="section" style="background:none;padding:0;"><h2 style="background:none;padding:0;">Configure the root pom.xml<a name="Configure_the_root_pom.xml"></a></h2></div>Create two properties in trunk/parent/pom.xml. This is makes it easier to
+maintain these two pieces of information throughout the documentation generation
+process:<div><pre><properties>
+ [...]
+ <docs.m.forms.version>1.0</docs.m.forms.version>
+ <docs.m.forms.relPath>blocks/forms/${docs.m.forms.version}/</docs.m.forms.relPath>    
+</properties>
+</pre></div>Open the pom.xml in the root and find the plugin with artifactId
+daisy-maven-plugin. Under <tt>collections</tt> add<div><pre> <collection>
+ <name>cdocs-forms</name>
+ <path>${docs.m.forms.relPath}</path>
+ </collection></pre></div>Try to keep the collections in alphabetical order as well.<div class="section" style="background:none;padding:0;"><h2 style="background:none;padding:0;">Configure the block pom.xml<a name="Configure_the_block_pom.xml"></a></h2></div><ul>
+<li>Open the <tt>pom.xml</tt> file of the block, e.g.
+<i>cocoon-forms-impl/pom.xml</i></li>
+<li>Open a pom.xml file of a block that is already configured, e.g. cocoon-fop
+and copy the plugin with the groupID <tt>org.daisycms </tt>and artifactId<tt>
+daisy-maven-plugin</tt></li>
+<li>Add this to your pom file under <build>, <plugins>, if necessary
+create these tags. The build section should look like this (at least containing
+the daisy-maven-plugin part)</li>
+</ul><ol style="list-style-type: decimal"> 
+</ol><div><pre>    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.daisycms</groupId>
+                <artifactId>daisy-maven-plugin</artifactId>
+                <configuration>
+                    <navDocId>1152</navDocId>
+                    <collection>cdocs-forms</collection>                   
+ <skipFirstNavigationDocumentLevel>true</skipFirstNavigationDocumentLevel>
+                </configuration>
+            </plugin>
+        </plugins>
+    </build></pre></div><ul>
+<li>Change the <tt>navDocId</tt> to the id of the navigation document, in this
+case <i>1152</i></li>
+<li>Change the <tt>collection</tt> to the name of the collection, in this case
+<i>cdocs-forms</i></li>
+<li>Add the distributionManagment part and the properties as well at the same
+level as the build tag.</li>
+</ul><div><pre> <distributionManagement>
+ <site>
+ <id>website</id>
+ <url>${docs.deploymentBaseUrl}/${docs.m.forms.relPath}</url>
+ </site>
+ </distributionManagement>
+ <properties>
+ <docs.name><b>Cocoon Forms</b></docs.name>
+ <docs.version>${docs.m.forms.version}</docs.version>
+ </properties>
+</pre></div><ul>
+<li>Change the path in the <tt>url</tt> to match the block name, here
+<i>forms</i></li>
+<li>Change the property <tt>docs.name</tt> to match the user friendly name of
+the block, here <i>Cocoon Forms</i></li>
+<li>Set the <tt>docs.version</tt> property to 1.0 initially and update it to
+reflect the documentation version.</li>
+</ul><div class="section" style="background:none;padding:0;"><h2 style="background:none;padding:0;">Configure the site pom.xml<a name="Configure_the_site_pom.xml"></a></h2></div>Open the pom.xml in the site and add a module to the section Cocoon Blocks:
+<div><pre> <module>../blocks/cocoon-forms/cocoon-forms-impl</module>
+</pre></div>Keep the modules in alphabetical order to ease maintenance.</div></div>
+
+ </div>
+ </div>
+
+ <!-- end of content -->
+ <div id="footer">
+ <p>Copyright ©
+ 1999-2012
+
+ The Apache Software Foundation
+ All Rights Reserved.</p>
+
+ <p>
+ Apache Cocoon, Apache, the Apache feather logo, and the Apache Cocoon project logos are trademarks of The Apache Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+ </p>
+ </div>
+ <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+ </script>
+ <script type="text/javascript">
+ _uacct = "UA-1740622-3";
+ urchinTracker();
+ </script>
+
+ </body>
+</html>
\ No newline at end of file
Modified: cocoon/site/site/1256_1_1.html
URL: http://svn.apache.org/viewvc/cocoon/site/site/1256_1_1.html?rev=1311666&r1=1311665&r2=1311666&view=diff
==============================================================================
--- cocoon/site/site/1256_1_1.html (original)
+++ cocoon/site/site/1256_1_1.html Tue Apr 10 10:24:47 2012
@@ -1,389 +1,333 @@
-<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
-<!--
- Licensed to the Apache Software Foundation (ASF) under one
- or more contributor license agreements. See the NOTICE file
- distributed with this work for additional information
- regarding copyright ownership. The ASF licenses this file
- to you under the Apache License, Version 2.0 (the
- "License"); you may not use this file except in compliance
- with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing,
- software distributed under the License is distributed on an
- "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
- KIND, either express or implied. See the License for the
- specific language governing permissions and limitations
- under the License.
--->
-
-
-
-
-
-
-
-
-<html>
- <head>
- <title> Cocoon Main Site - How to build the site locally
- </title>
- <style type="text/css" media="all">
- @import url("./css/maven-base.css");
- @import url("./css/maven-theme.css");
- @import url("./css/site.css");
- </style>
- <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <script src="./js/getBlank.js" language="javascript" type="text/javascript"></script>
- <meta name="author" content="The Cocoon Community" />
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
- </head>
- <body>
- <div id="breadtrail">
- <p><a href="http://www.apache.org">Apache</a> » <a href="./">Cocoon</a> »</p>
- </div>
- <div id="top">
- <div id="header">
- <div class="projectlogo">
- <a href="./"><img class="logoImage"
- src="images/cocoon_logo.jpg"
- alt="Apache Cocoon" border="0" /></a>
- </div>
- <div class="grouplogo">
- <p class="grouptitle"><a href="./">The Apache Cocoon Project</a><img
- src="images/apache-logo.jpg" alt="Cocoon Project Logo" /></p>
- <form class="searchbox" action="http://www.google.com/search" method="get">
- <input value="cocoon.apache.org" name="sitesearch" type="hidden" />
- <input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google" />
- <input class="searchboxsubmit" name="Search" value="Search" type="submit" />
- </form>
- </div>
- </div>
- <div id="projectBar">
- <p class="cocoonHome"><a href="./index.html"><img
- src="images/pmc-home.gif"
- alt=" Apache Cocoon
- homepage"
- border="0" title=" Apache Cocoon
- homepage" /></a></p>
- <h1 class="projectTitle"><a href="./index.html"> Apache Cocoon
- </a></h1>
- <ul class="projectList">
- <li><strong><a href="./2.2/">Cocoon 2.2</a></em></strong></li>
- <li><a href="./2.2/core-modules/">Core <span class="pl-version-small">2.2</span></a></li>
- <li><a href="./2.2/blocks/">Blocks <span class="pl-version-small">2.2</span></a></li>
- <li><a href="./2.2/maven-plugins/">Maven Plugins <span class="pl-version-small">2.2</span></a></li>
- <li><strong><a href=".//3.0/">Cocoon 3.0 <span class="pl-version-small">[alpha]</span></a></em></strong></li>
- <li><strong><a href="./subprojects/">Subprojects</a></strong></li>
- </ul>
- </div>
- <div class="projectBarClear"><!-- --></div>
- </div>
- <!-- end of top -->
-
- <div id="content">
- <ul id="menu">
- <li>
- About Cocoon
- <ul>
-
- <li >
- <a href="1285_1_1.html">Welcome</a>
- </li>
-
- <li >
- <a href="1363_1_1.html">Features</a>
- </li>
-
- <li >
- <a href="1284_1_1.html">Versions & Download</a>
- </li>
-
- <li >
- <a href="1271_1_1.html">Professional Services</a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class='menuCollapse'>
- <a href="1365_1_1.html">Who uses Cocoon?</a>
- </li>
-
- <li >
- <a href="1272_1_1.html">Weblogs</a>
- </li>
-
- <li >
- <a href="1178_1_1.html">History</a>
- </li>
-
- <li >
- <a href="1508_1_1.html">Privacy Policy</a>
- </li>
- </ul>
- </li>
- <li>
- Getting started
- <ul>
-
- <li >
- <a href="1370_1_1.html">Tutorials</a>
- </li>
- </ul>
- </li>
- <li>
- Getting better
- <ul>
-
- <li >
- <a href="1286_1_1.html">About the online documentation</a>
- </li>
-
- <li >
- <a href="1287_1_1.html">Presentations</a>
- </li>
-
- <li >
- <a href="1368_1_1.html">How-Tos</a>
- </li>
-
- <li >
- <a href="1288_1_1.html">Articles</a>
- </li>
-
- <li >
- <a href="1289_1_1.html">Books</a>
- </li>
- </ul>
- </li>
- <li>
- Getting involved
- <ul>
-
- <li >
- <a href="1273_1_1.html">How to contribute?</a>
- </li>
-
- <li >
- <a href="1275_1_1.html">Communication tools that we use</a>
- </li>
-
- <li >
- <a href="1276_1_1.html">Other tools that we use</a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class='menuExpand'>
- <a href="798_1_1.html">Committer's and contributor's section</a>
- <ul>
-
-
-
-
-
-
-
-
-
-
-
- <li class='menuCollapse'>
- <a href="798_1_1.html">Working with Cocoon from SVN</a>
- </li>
-
- <li >
- <a href="1301_1_1.html">Debugging Cocoon in Eclipse</a>
- </li>
-
- <li >
- <a href="636_1_1.html">Apache Cocoon Tests</a>
- </li>
-
- <li >
- <a href="1199_1_1.html">Releasing Cocoon</a>
- </li>
-
-
-
-
-
-
-
-
-
-
-
- <li class='menuExpand'>
- <a href="1418_1_1.html">Documentation</a>
- <ul>
-
- <li >
- <a href="1418_1_1.html">How to publish docs to cocoon.apache.org</a>
- </li>
-
- <li >
- <strong>How to build the site locally</strong>
- </li>
-
- <li >
- <a href="1223_1_1.html">How to create documentation for a deployment unit (e.g. a block)?</a>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- </ul>
- </li>
- <li>
- Project Documentation
- <ul>
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- <li class='menuCollapse'>
- <a href="project-info.html">Project Information</a>
- </li>
- </ul>
- </li>
- <li class="menuVersions">Versions
- <ul>
- <li><a href="./3.0/">Cocoon 3.0 <span class="pl-version-small">[alpha]</span></a></li>
- <li><a href="./2.2/">Cocoon 2.2</a></li>
- <li><a href="./2.1/">Cocoon 2.1</a></li>
- <li><a href="./2.0/">Cocoon 2.0</a></li>
- <li><a href="./1.x/">Cocoon 1.x</a></li>
- </ul>
- </li>
- </ul>
- <div class="main">
- <div id="contentBody"><div id="bodyText"><h1 class="docTitle">How to build the site locally</h1><p>This page explains how to build the Cocoon 2.2 documentation site with Maven2
-and the daisy-maven-plugin.</p><p>This plugin assumes that each block has its own collection and navigation
-document.</p><h1 xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">Configure settings.xml</h1><p>The documents can only be exported by a user with admin rights to the Daisy
-repository. We have created such a user <tt>daisy-export</tt>. The password for
-this user is available in a <tt>daisy-export-user-<tt>password.txt</tt>
-</tt>file in the home directory of the daisy user. If you want to use your own
-Daisy user, make sure that you have administration rights.</p><p>Open the <tt>~/.m2/setting.xml</tt> and add the following:</p><pre><settings>
-
- [...]
-
- <profiles>
- <profile>
- <id>localDocs</id>
- <properties>
- <docs.deploymentBaseUrl>file:///cocoon-site</docs.deploymentBaseUrl>
- </properties>
- </profile>
- </profiles>
-
- <servers>
- <server>
- <id>cocoon-daisy</id>
- <username>daisy-export</username>
- <password><strong xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">SECRET PASSWORD HERE</strong></password>
- </server>
- </servers>
-
-</settings>
-</pre><h1 xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">Build all modules required for the site generation</h1><pre>cd trunk
-mvn install -P daisy</pre><h1 xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">Build the site</h1><pre>cd trunk/site
-mvn site -o -P daisy,docs-sites
-</pre><div class="note"><div><strong>Note: </strong>You don't have to build the complete site for every module every
-time. You can also go to a module, that is configured to provide docs, of your
-choice and build its docs only if this fits your needs.</div></div><h1 xmlns:p="http://outerx.org/daisy/1.0#publisher" xmlns:ns="http://outerx.org/daisy/1.0">Deploy the site locally</h1><p>Deploy the site using the "localDocs" profile.</p><pre>mvn site:deploy -o -P daisy,docs-sites,localDocs
-</pre><p>If you want to checkin the local docs build to SVN in order to publish them,
-make sure that the profile above (localDocs) points to a local directory which
-is a checkout of our docs from SVN
-(<a href="http://svn.apache.org/repos/asf/cocoon/site/site/">http://svn.apache.org/repos/asf/cocoon/site/site/</a>).
-<br></br>
-There is a guide with additional information about <a href="1418_1_1.html">how to
-publish our docs</a>.</p></div><div class="editUrl"><div><em>Errors and Improvements?</em> If you see any errors or potential improvements in this document please help
- us: <a href="http://cocoon.zones.apache.org/daisy/cdocs/1256?branch=1&language=1">View, Edit or comment</a> on the latest development version (registration required).
- </div></div></div>
- </div>
- </div>
-
- <!-- end of content -->
- <div id="footer">
- <p>©
- 1999-2009
-
- The Apache Software Foundation
- </p>
- </div>
- <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
- </script>
- <script type="text/javascript">
- _uacct = "UA-1740622-3";
- urchinTracker();
- </script>
-
- </body>
-</html>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+
+
+
+
+
+
+
+
+<html>
+ <head>
+ <title> Cocoon Main Site - How to build the site locally
+ </title>
+ <link rel="stylesheet" href="./css/apache-cocoon-thien-maven-skin.min.css" />
+ <link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
+ <script src="./js/apache-cocoon-thien-maven-skin.min.js" language="javascript" type="text/javascript"></script>
+ <meta name="author" content="Apache Cocoon Documentation Team" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+ </head>
+ <body onload="javascript:prettyPrint();">
+ <div id="breadtrail">
+ <p><a href="http://www.apache.org">Apache</a> » <a href="./">Cocoon</a> »</p>
+ </div>
+ <div id="top">
+ <div id="header">
+ <div class="projectlogo">
+ <a href="./"><img class="logoImage"
+ src="images/cocoon_logo.jpg"
+ alt="Apache Cocoon" border="0" /></a>
+ </div>
+ <div class="grouplogo">
+ <p class="grouptitle"><a href="./">The Apache Cocoon Project</a><img
+ src="images/apache-logo.jpg" alt="Cocoon Project Logo" /></p>
+ <form class="searchbox" action="http://www.google.com/search" method="get">
+ <input value="cocoon.apache.org" name="sitesearch" type="hidden" />
+ <input onFocus="getBlank (this, 'Search the site with google');" size="25" name="q" id="query" type="text" value="Search the site with google" />
+ <input class="searchboxsubmit" name="Search" value="Search" type="submit" />
+ </form>
+ </div>
+ </div>
+ <div id="projectBar">
+ <p class="cocoonHome"><a href="./index.html"><img
+ src="images/pmc-home.gif"
+ alt=" Apache Cocoon
+ homepage"
+ border="0" title=" Apache Cocoon
+ homepage" /></a></p>
+ <h1 class="projectTitle"><a href="./index.html"> Apache Cocoon
+ </a></h1>
+ <ul class="projectList">
+ <li><strong><a href="./2.2/">Cocoon 2.2</a></em></strong></li>
+ <li><a href="./2.2/core-modules/">Core <span class="pl-version-small">2.2</span></a></li>
+ <li><a href="./2.2/blocks/">Blocks <span class="pl-version-small">2.2</span></a></li>
+ <li><a href="./2.2/maven-plugins/">Maven Plugins <span class="pl-version-small">2.2</span></a></li>
+ <li><strong><a href=".//3.0/">Cocoon 3.0</a></em></strong></li>
+ <li><strong><a href="./subprojects/">Subprojects</a></strong></li>
+ </ul>
+ </div>
+ <div class="projectBarClear"><!-- --></div>
+ </div>
+ <!-- end of top -->
+
+ <div id="content">
+ <ul id="menu">
+ <li>
+ About Cocoon
+ <ul>
+
+ <li >
+ <a href="index.html">Welcome</a>
+ </li>
+
+ <li >
+ <a href="1363_1_1.html">Features</a>
+ </li>
+
+ <li >
+ <a href="1284_1_1.html">Versions & Download</a>
+ </li>
+
+ <li >
+ <a href="1271_1_1.html">Professional Services</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class='menuCollapse'>
+ <a href="1365_1_1.html">Who uses Cocoon?</a>
+ </li>
+
+ <li >
+ <a href="1272_1_1.html">Weblogs</a>
+ </li>
+
+ <li >
+ <a href="1178_1_1.html">History</a>
+ </li>
+
+ <li >
+ <a href="1508_1_1.html">Privacy Policy</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ Getting Started
+ <ul>
+
+ <li >
+ <a href="1370_1_1.html">Tutorials</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ Getting Better
+ <ul>
+
+ <li >
+ <a href="1286_1_1.html">About the online documentation</a>
+ </li>
+
+ <li >
+ <a href="1287_1_1.html">Presentations</a>
+ </li>
+
+ <li >
+ <a href="1368_1_1.html">How-Tos</a>
+ </li>
+
+ <li >
+ <a href="1288_1_1.html">Articles</a>
+ </li>
+
+ <li >
+ <a href="1289_1_1.html">Books</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ Getting involved
+ <ul>
+
+ <li >
+ <a href="1273_1_1.html">How to contribute?</a>
+ </li>
+
+ <li >
+ <a href="1275_1_1.html">Communication tools that we use</a>
+ </li>
+
+ <li >
+ <a href="1276_1_1.html">Other tools that we use</a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class='menuCollapse'>
+ <a href="1199_1_1.html">Committer's and contributor's section</a>
+ </li>
+ </ul>
+ </li>
+ <li>
+ Project Documentation
+ <ul>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class='menuCollapse'>
+ <a href="project-info.html">Project Information</a>
+ </li>
+ </ul>
+ </li>
+ <li class="menuVersions">Versions
+ <ul>
+ <li><a href="./3.0/">Cocoon 3.0</a></li>
+ <li><a href="./2.2/">Cocoon 2.2</a></li>
+ <li><a href="./2.1/">Cocoon 2.1</a></li>
+ <li><a href="./2.0/">Cocoon 2.0</a></li>
+ <li><a href="./1.x/">Cocoon 1.x</a></li>
+ </ul>
+ </li>
+ </ul>
+ <div class="main">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License. -->
+ <div id="contentBody"><div id="bodyText"><h1 class="docTitle">How to build the site locally</h1><p>This page explains how to build the Cocoon 2.2 documentation site with Maven2
+and the daisy-maven-plugin.</p><p>This plugin assumes that each block has its own collection and navigation
+document.</p><h1>Configure settings.xml</h1><p>The documents can only be exported by a user with admin rights to the Daisy
+repository. We have created such a user <tt>daisy-export</tt>. The password for
+this user is available in a <tt>daisy-export-user-<tt>password.txt</tt>
+</tt>file in the home directory of the daisy user. If you want to use your own
+Daisy user, make sure that you have administration rights.</p><p>Open the <tt>~/.m2/setting.xml</tt> and add the following:</p><div><pre><settings>
+
+ [...]
+
+ <profiles>
+  <profile>
+ <id>localDocs</id>
+ <properties>
+ <docs.deploymentBaseUrl>file:///cocoon-site</docs.deploymentBaseUrl>
+ </properties>
+ </profile>
+ </profiles>
+
+ <servers>
+ <server>
+ <id>cocoon-daisy</id>
+ <username>daisy-export</username>
+ <password><b>SECRET PASSWORD HERE</b></password>
+ </server>
+ </servers>
+
+</settings>
+</pre></div><h1>Build all modules required for the site generation</h1><div><pre>cd trunk
+mvn install -P daisy</pre></div><h1>Build the site</h1><div><pre>cd trunk/site
+mvn site -o -P daisy,docs-sites
+</pre></div><div class="note"><div><b>Note: </b>You don't have to build the complete site for every module every
+time. You can also go to a module, that is configured to provide docs, of your
+choice and build its docs only if this fits your needs.</div></div><h1>Deploy the site locally</h1><p>Deploy the site using the "localDocs" profile.</p><div><pre>mvn site:deploy -o -P daisy,docs-sites,localDocs
+</pre></div><p>If you want to checkin the local docs build to SVN in order to publish them,
+make sure that the profile above (localDocs) points to a local directory which
+is a checkout of our docs from SVN
+(<a class="externalLink" href="http://svn.apache.org/repos/asf/cocoon/site/site/">http://svn.apache.org/repos/asf/cocoon/site/site/</a>).
+<br />
+There is a guide with additional information about <a href="1418_1_1.html">how to
+publish our docs</a>.</p></div></div>
+
+ </div>
+ </div>
+
+ <!-- end of content -->
+ <div id="footer">
+ <p>Copyright ©
+ 1999-2012
+
+ The Apache Software Foundation
+ All Rights Reserved.</p>
+
+ <p>
+ Apache Cocoon, Apache, the Apache feather logo, and the Apache Cocoon project logos are trademarks of The Apache Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.
+ </p>
+ </div>
+ <script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
+ </script>
+ <script type="text/javascript">
+ _uacct = "UA-1740622-3";
+ urchinTracker();
+ </script>
+
+ </body>
+</html>
\ No newline at end of file
Modified: cocoon/site/site/1271_1_1.html
URL: http://svn.apache.org/viewvc/cocoon/site/site/1271_1_1.html?rev=1311666&r1=1311665&r2=1311666&view=diff
==============================================================================
--- cocoon/site/site/1271_1_1.html (original)
+++ cocoon/site/site/1271_1_1.html Tue Apr 10 10:24:47 2012
@@ -29,17 +29,13 @@
<head>
<title> Cocoon Main Site - Professional Services
</title>
- <style type="text/css" media="all">
- @import url("./css/maven-base.css");
- @import url("./css/maven-theme.css");
- @import url("./css/site.css");
- </style>
+ <link rel="stylesheet" href="./css/apache-cocoon-thien-maven-skin.min.css" />
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <script src="./js/getBlank.js" language="javascript" type="text/javascript"></script>
- <meta name="author" content="The Cocoon Community" />
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <script src="./js/apache-cocoon-thien-maven-skin.min.js" language="javascript" type="text/javascript"></script>
+ <meta name="author" content="Apache Cocoon Documentation Team" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
- <body>
+ <body onload="javascript:prettyPrint();">
<div id="breadtrail">
<p><a href="http://www.apache.org">Apache</a> » <a href="./">Cocoon</a> »</p>
</div>
@@ -74,7 +70,7 @@
<li><a href="./2.2/core-modules/">Core <span class="pl-version-small">2.2</span></a></li>
<li><a href="./2.2/blocks/">Blocks <span class="pl-version-small">2.2</span></a></li>
<li><a href="./2.2/maven-plugins/">Maven Plugins <span class="pl-version-small">2.2</span></a></li>
- <li><strong><a href=".//3.0/">Cocoon 3.0 <span class="pl-version-small">[alpha]</span></a></em></strong></li>
+ <li><strong><a href=".//3.0/">Cocoon 3.0</a></em></strong></li>
<li><strong><a href="./subprojects/">Subprojects</a></strong></li>
</ul>
</div>
@@ -89,7 +85,7 @@
<ul>
<li >
- <a href="1285_1_1.html">Welcome</a>
+ <a href="index.html">Welcome</a>
</li>
<li >
@@ -129,8 +125,6 @@
-
-
<li class='menuCollapse'>
<a href="1365_1_1.html">Who uses Cocoon?</a>
@@ -150,7 +144,7 @@
</ul>
</li>
<li>
- Getting started
+ Getting Started
<ul>
<li >
@@ -159,7 +153,7 @@
</ul>
</li>
<li>
- Getting better
+ Getting Better
<ul>
<li >
@@ -210,23 +204,13 @@
-
-
-
-
-
-
-
-
-
-
-
+
-
+
<li class='menuCollapse'>
- <a href="798_1_1.html">Committer's and contributor's section</a>
+ <a href="1199_1_1.html">Committer's and contributor's section</a>
</li>
</ul>
</li>
@@ -247,10 +231,6 @@
-
-
-
-
<li class='menuCollapse'>
<a href="project-info.html">Project Information</a>
@@ -259,7 +239,7 @@
</li>
<li class="menuVersions">Versions
<ul>
- <li><a href="./3.0/">Cocoon 3.0 <span class="pl-version-small">[alpha]</span></a></li>
+ <li><a href="./3.0/">Cocoon 3.0</a></li>
<li><a href="./2.2/">Cocoon 2.2</a></li>
<li><a href="./2.1/">Cocoon 2.1</a></li>
<li><a href="./2.0/">Cocoon 2.0</a></li>
@@ -268,45 +248,65 @@
</li>
</ul>
<div class="main">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License. -->
<div id="contentBody"><div id="bodyText"><h1 class="docTitle">Professional Services</h1><p>These companies provide professional services around Apache Cocoon (sorted by
alphabetical order):</p><ul>
-<li><strong><a href="http://www.agilepartners.com">Agile Partners</a></strong>,
-New York City and Chicago, USA<br></br>
+<li><b><a class="externalLink" href="http://www.agilepartners.com">Agile Partners</a></b>,
+New York City and Chicago, USA<br />
Development and consulting</li>
-<li><strong><a href="http://www.hippo.nl/en/home">Hippo</a></strong>, Amsterdam,
-Netherlands <br></br>
+<li><b><a class="externalLink" href="http://www.hippo.nl/en/home">Hippo</a></b>, Amsterdam,
+Netherlands <br />
Development, consulting and training</li>
<li>
-<strong><a href="http://www.indoqa.com/en/services/opensource-technology">{Indoqa}</a>,</strong>
-Vienna, Austria<br></br>
+<b><a class="externalLink" href="http://www.indoqa.com/en/services/opensource-technology">{Indoqa}</a>,</b>
+Vienna, Austria<br />
Consulting and training (Europe)</li>
-<li><strong><a href="http://www.fiveone.org">Jeremy Quinn</a></strong> London,
-UK<br></br>
+<li><b><a class="externalLink" href="http://www.fiveone.org">Jeremy Quinn</a></b> London,
+UK<br />
Consultancy</li>
-<li><strong><a href="http://www.otego.com">Otego AG</a></strong>, Zürich,
-Switzerland<br></br>
+<li><b><a class="externalLink" href="http://www.otego.com">Otego AG</a></b>, Zürich,
+Switzerland<br />
Consulting and training in Switzerland</li>
-<li><strong><a href="http://outerthought.org/">Outerthought</a></strong>,
-Belgium<br></br>
-International Cocoon and <a href="http://www.daisycms.org/">Daisy CMS</a>
+<li><b><a class="externalLink" href="http://outerthought.org/">Outerthought</a></b>,
+Belgium<br />
+International Cocoon and <a class="externalLink" href="http://www.daisycms.org/">Daisy CMS</a>
projects and services</li>
-<li><strong><a href="http://www.sourcesense.com/">Sourcesense</a></strong>
-Italy, Netherlands, UK<br></br>
+<li><b><a class="externalLink" href="http://www.sourcesense.com/">Sourcesense</a></b>
+Italy, Netherlands, UK<br />
European consulting and training</li>
-</ul>If you do not find your site here, use the <em>Edit</em> link below and add
-yourself. If you are not familiar with the CMS, read the <em>General
-documentation</em> section of <a href="1273_1_1.html">How to contribute?</a>.</div><div class="editUrl"><div><em>Errors and Improvements?</em> If you see any errors or potential improvements in this document please help
- us: <a href="http://cocoon.zones.apache.org/daisy/cdocs/1271?branch=1&language=1">View, Edit or comment</a> on the latest development version (registration required).
- </div></div></div>
+</ul>If you do not find your site here, use the <i>Edit</i> link below and add
+yourself. If you are not familiar with the CMS, read the <i>General
+documentation</i> section of <a href="1273_1_1.html">How to contribute?</a>.</div></div>
+
</div>
</div>
<!-- end of content -->
<div id="footer">
- <p>©
- 1999-2009
+ <p>Copyright ©
+ 1999-2012
The Apache Software Foundation
+ All Rights Reserved.</p>
+
+ <p>
+ Apache Cocoon, Apache, the Apache feather logo, and the Apache Cocoon project logos are trademarks of The Apache Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.
</p>
</div>
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
@@ -317,4 +317,4 @@ documentation</em> section of <a href="1
</script>
</body>
-</html>
+</html>
\ No newline at end of file
Modified: cocoon/site/site/1272_1_1.html
URL: http://svn.apache.org/viewvc/cocoon/site/site/1272_1_1.html?rev=1311666&r1=1311665&r2=1311666&view=diff
==============================================================================
--- cocoon/site/site/1272_1_1.html (original)
+++ cocoon/site/site/1272_1_1.html Tue Apr 10 10:24:47 2012
@@ -29,17 +29,13 @@
<head>
<title> Cocoon Main Site - Weblogs
</title>
- <style type="text/css" media="all">
- @import url("./css/maven-base.css");
- @import url("./css/maven-theme.css");
- @import url("./css/site.css");
- </style>
+ <link rel="stylesheet" href="./css/apache-cocoon-thien-maven-skin.min.css" />
<link rel="stylesheet" href="./css/print.css" type="text/css" media="print" />
- <script src="./js/getBlank.js" language="javascript" type="text/javascript"></script>
- <meta name="author" content="The Cocoon Community" />
- <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <script src="./js/apache-cocoon-thien-maven-skin.min.js" language="javascript" type="text/javascript"></script>
+ <meta name="author" content="Apache Cocoon Documentation Team" />
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
</head>
- <body>
+ <body onload="javascript:prettyPrint();">
<div id="breadtrail">
<p><a href="http://www.apache.org">Apache</a> » <a href="./">Cocoon</a> »</p>
</div>
@@ -74,7 +70,7 @@
<li><a href="./2.2/core-modules/">Core <span class="pl-version-small">2.2</span></a></li>
<li><a href="./2.2/blocks/">Blocks <span class="pl-version-small">2.2</span></a></li>
<li><a href="./2.2/maven-plugins/">Maven Plugins <span class="pl-version-small">2.2</span></a></li>
- <li><strong><a href=".//3.0/">Cocoon 3.0 <span class="pl-version-small">[alpha]</span></a></em></strong></li>
+ <li><strong><a href=".//3.0/">Cocoon 3.0</a></em></strong></li>
<li><strong><a href="./subprojects/">Subprojects</a></strong></li>
</ul>
</div>
@@ -89,7 +85,7 @@
<ul>
<li >
- <a href="1285_1_1.html">Welcome</a>
+ <a href="index.html">Welcome</a>
</li>
<li >
@@ -129,8 +125,6 @@
-
-
<li class='menuCollapse'>
<a href="1365_1_1.html">Who uses Cocoon?</a>
@@ -150,7 +144,7 @@
</ul>
</li>
<li>
- Getting started
+ Getting Started
<ul>
<li >
@@ -159,7 +153,7 @@
</ul>
</li>
<li>
- Getting better
+ Getting Better
<ul>
<li >
@@ -210,23 +204,13 @@
-
-
-
-
-
-
-
-
-
-
-
+
-
+
<li class='menuCollapse'>
- <a href="798_1_1.html">Committer's and contributor's section</a>
+ <a href="1199_1_1.html">Committer's and contributor's section</a>
</li>
</ul>
</li>
@@ -247,10 +231,6 @@
-
-
-
-
<li class='menuCollapse'>
<a href="project-info.html">Project Information</a>
@@ -259,7 +239,7 @@
</li>
<li class="menuVersions">Versions
<ul>
- <li><a href="./3.0/">Cocoon 3.0 <span class="pl-version-small">[alpha]</span></a></li>
+ <li><a href="./3.0/">Cocoon 3.0</a></li>
<li><a href="./2.2/">Cocoon 2.2</a></li>
<li><a href="./2.1/">Cocoon 2.1</a></li>
<li><a href="./2.0/">Cocoon 2.0</a></li>
@@ -268,26 +248,46 @@
</li>
</ul>
<div class="main">
+ <!-- Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License. -->
<div id="contentBody"><div id="bodyText"><h1 class="docTitle">Weblogs</h1><p>A list of feeds that have Apache Cocoon as one of their topics:</p><ul>
-<li><a href="http://www.andrewsavory.com/blog/">Andrew Savory</a></li>
-<li><a href="http://blogs.hippo.nl/reijn/">Jeroen Reijn</a></li>
-<li><a href="http://www.indoqa.com/en/people/reinhard.poetz/">Reinhard Pötz</a>
+<li><a class="externalLink" href="http://www.andrewsavory.com/blog/">Andrew Savory</a></li>
+<li><a class="externalLink" href="http://blogs.hippo.nl/reijn/">Jeroen Reijn</a></li>
+<li><a class="externalLink" href="http://www.indoqa.com/en/people/reinhard.poetz/">Reinhard Pötz</a>
</li>
-<li><a href="http://blog.reverycodes.com/">Vadim Gritsenko</a></li>
-</ul>If you do not find your feed here, use the <em>Edit</em> link below and add
-yourself. If you are not familiar with the CMS, read the <em>General
-documentation</em> section of <a href="1273_1_1.html">How to contribute?</a>.</div><div class="editUrl"><div><em>Errors and Improvements?</em> If you see any errors or potential improvements in this document please help
- us: <a href="http://cocoon.zones.apache.org/daisy/cdocs/1272?branch=1&language=1">View, Edit or comment</a> on the latest development version (registration required).
- </div></div></div>
+<li><a class="externalLink" href="http://blog.reverycodes.com/">Vadim Gritsenko</a></li>
+</ul>If you do not find your feed here, use the <i>Edit</i> link below and add
+yourself. If you are not familiar with the CMS, read the <i>General
+documentation</i> section of <a href="1273_1_1.html">How to contribute?</a>.</div></div>
+
</div>
</div>
<!-- end of content -->
<div id="footer">
- <p>©
- 1999-2009
+ <p>Copyright ©
+ 1999-2012
The Apache Software Foundation
+ All Rights Reserved.</p>
+
+ <p>
+ Apache Cocoon, Apache, the Apache feather logo, and the Apache Cocoon project logos are trademarks of The Apache Software Foundation.
+ All other marks mentioned may be trademarks or registered trademarks of their respective owners.
</p>
</div>
<script src="http://www.google-analytics.com/urchin.js" type="text/javascript">
@@ -298,4 +298,4 @@ documentation</em> section of <a href="1
</script>
</body>
-</html>
+</html>
\ No newline at end of file