You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@couchdb.apache.org by Apache Wiki <wi...@apache.org> on 2012/08/01 12:49:33 UTC
[Couchdb Wiki] Update of "Documentation" by DaveCottlehuber
Dear Wiki user,
You have subscribed to a wiki page or wiki category on "Couchdb Wiki" for change notification.
The "Documentation" page has been changed by DaveCottlehuber:
http://wiki.apache.org/couchdb/Documentation
Comment:
more to come
New page:
<<Include(EditTheWiki)>>
<<TableOfContents(2)>>
Contributing Documentation to the CouchDB project is one of the most valuable things you can do. Every bit helps. Here's how.
= Take me to your Docs =
Documentation can be found in 3 places today;
* The Wiki (you're here)
* The [[http://guide.couchdb.org/draft/index.html|Definitive Guide]]
* The source tree, which is [[https://github.com/dch/couchdb/tree/docs/share/docs|under work]]
= Editing Documentation =
== DocBook Style ==
To add a new chapter, simply add the new chapter inclusion into the manual {{{share/docs/manual/couchdb-manual.xml}}}
{{{
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="couchdb-new-chapter.xml"/>
}}}
And then add a new chapter in the same folder the the above {{{href}}} as the filename. Here's a template, with the most common elements included:
{{{
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE section PUBLIC '-//OASIS//DTD DocBook XML V4.5//EN'
'http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd' [
<!ENTITY % every.entities SYSTEM "entities.ent">
%every.entities;
]>
<chapter id="couchdb-new-chapter">
<title>dch is on your couch</title>
<para>
Picture Time to get a new couch!!
</para>
<para>
You know
<ulink url="http://www.erlang.org/">Erlang</ulink>
is delicious.
</para>
<figure id="fig-couchdb-single-deathstar">
<title>deathstar fail</title>
<mediaobject>
<imageobject>
<imagedata width="100%" contentdepth="100%" scalefit="1"
fileref="images/deathstar_fail.png"
format="PNG" lang="en"/>
</imageobject>
<textobject>
<phrase lang="en">DeathStar Fail</phrase>
</textobject>
</mediaobject>
</figure>
<para>
This is a self-referential reference. Do not recurse without recourse!
<xref
linkend="couchdb-dch"/>.
</para>
<para>
List out my good points!
</para>
<itemizedlist>
<listitem>
<para>
I'm BIG in Germany.
</para>
</listitem>
<listitem>
<para>
RESTful is my nature
</para>
</listitem>
<listitem>
<para>My temperament is Relaxed.</para>
</listitem>
</itemizedlist>
<table>
<title><literal>couchdb</literal> statistics</title>
<tgroup cols="3">
<colspec colname="stat"/>
<colspec colname="desc"/>
<colspec colname="unit"/>
<thead>
<row>
<entry>
Statistic ID
</entry>
<entry>
Description
</entry>
<entry>
Unit
</entry>
</row>
</thead>
<tbody>
<row>
<entry><literal>auth_cache_hits</literal>
</entry>
<entry>
Number of authentication cache hits
</entry>
<entry>
number
</entry>
</row>
<row>
<entry><literal>auth_cache_misses</literal>
</entry>
<entry>
Number of authentication cache misses
</entry>
<entry>
number
</entry>
</row>
</tbody>
</tgroup>
</table>
</chapter>
}}}