You are viewing a plain text version of this content. The canonical link for it is here.
Posted to xindice-dev@xml.apache.org by vl...@apache.org on 2002/11/22 09:12:41 UTC
cvs commit: xml-xindice/src/documentation/content/xdocs/dev doc-contributing.xml book.xml
vladimir 2002/11/22 00:12:41
Modified: src/documentation/content/xdocs/dev book.xml
Added: src/documentation/content/xdocs/dev doc-contributing.xml
Log:
info about using forrest
Revision Changes Path
1.2 +2 -1 xml-xindice/src/documentation/content/xdocs/dev/book.xml
Index: book.xml
===================================================================
RCS file: /home/cvs/xml-xindice/src/documentation/content/xdocs/dev/book.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- book.xml 17 Nov 2002 08:16:03 -0000 1.1
+++ book.xml 22 Nov 2002 08:12:41 -0000 1.2
@@ -17,6 +17,7 @@
</menu>
<menu label="Documentation">
+ <menu-item label="How to contribute" href="doc-contributing.html"/>
<menu-item label="Administrator Guide" href="guide-administrator.html"/>
<menu-item label="User Guide" href="guide-user.html"/>
<menu-item label="Developer Guide" href="guide-developer.html"/>
1.1 xml-xindice/src/documentation/content/xdocs/dev/doc-contributing.xml
Index: doc-contributing.xml
===================================================================
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V1.1//EN" "document-v11.dtd">
<!--
- Version: $Revision: 1.1 $ $Date: 2002/11/22 08:12:41 $
- Author: Vladimir R. Bossicard (vladimir@apache.org)
-->
<document>
<header>
<title>Documentation: How to contribute</title>
<authors>
<person name="Vladimir R. Bossicard" email="vladimir@apache.org"/>
</authors>
</header>
<body>
<p></p>
<section>
<title>General rules</title>
<p>
Writing the documentation is a team effort so let's
first set some basic rules to prevent a mess:</p>
<ul>
<li>Four spaces, no tabs! Period.</li>
<li>
If you write a complete document or participate
substancially to one, please add your name to the
<code><header><authors></code> list.
</li>
<li>
If you only contribute partially to the document
(correcting errors), please add your name to the
<code>Author:</code> list.
</li>
</ul>
<note>
If you know an Open Source XML beautifier that can be
used in our build process, please drop <link
href="mailto:vladimir@apache.org">me</link> a line!
</note>
</section>
<section>
<title>Using Forrest</title>
<p>
The Xindice website and documentation are generated
using the <link
href="http://xml.apache.org/forrest">Forrest</link>
tool. If you are new to Forrest, please read the <link
href="http://xml.apache.org/forrest/your-project.html">Using
Forrest</link> guide to get you started. After several
tries, I recommand the following settings:
</p>
<ul>
<li>
Generate the documentation as a webapp by invoking
<code>forrest webapp</code> from the xml-xindice
repository.
</li>
<li>
Forrest copies the
<code>src/documentation/content/xdocs</code> files
into the <code>build/webapp/content/xdocs</code>
directory. If you want to only work with the
<code>src</code> directory, you will need to
create links. The directories/files that need to
be linked (and deleted from the webapp) are:
</li>
<ul>
<li>
<code>skinconf.xml</code>
</li>
<li>
<code>status.xml</code>
</li>
<li>
<code>content/xdocs</code>
</li>
<li>
<code>resources/images</code>
</li>
</ul>
<li>
Rename the <code>build/webapp</code> into another
name: this will prevent you from deleting the
documentation with a call to <code>ant
clean</code>...
</li>
<li>
Add the following context to the
<code>${TOMCAT_HOME}/conf/server.xml</code>
configuration file:
</li>
<source>
<![CDATA[
<Context path="/Xindice-documentation"
docBase="${path-to-the-webapp-documentation}/webapp"
reloadable="true"/>
]]>
</source>
</ul>
<p>
After restarting Tomcat, you can browse the
documentation on <link
href="http://localhost:8080/Xindice-documentation">
localhost:8080/Xindice-documentation</link> and edit
the source from the <code>src/documentation</code>
folder.
</p>
<p>
Have fun!
</p>
</section>
</body>
</document>