249 lines
4.3 KiB
HTML
249 lines
4.3 KiB
HTML
<HTML
|
|
><HEAD
|
|
><TITLE
|
|
>How to write documentation</TITLE
|
|
><META
|
|
NAME="GENERATOR"
|
|
CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
|
|
"><LINK
|
|
REL="HOME"
|
|
TITLE="Caudium HOWTO"
|
|
HREF="index.html"><LINK
|
|
REL="UP"
|
|
TITLE="How to help the Caudium community"
|
|
HREF="helpcaudiumcommunity.html"><LINK
|
|
REL="PREVIOUS"
|
|
TITLE="How to promote Caudium"
|
|
HREF="promotecaudium.html"><LINK
|
|
REL="NEXT"
|
|
TITLE="How to get a CVS account"
|
|
HREF="cvsaccount.html"></HEAD
|
|
><BODY
|
|
CLASS="sect1"
|
|
BGCOLOR="#FFFFFF"
|
|
TEXT="#000000"
|
|
LINK="#0000FF"
|
|
VLINK="#840084"
|
|
ALINK="#0000FF"
|
|
><DIV
|
|
CLASS="NAVHEADER"
|
|
><TABLE
|
|
SUMMARY="Header navigation table"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
CELLPADDING="0"
|
|
CELLSPACING="0"
|
|
><TR
|
|
><TH
|
|
COLSPAN="3"
|
|
ALIGN="center"
|
|
>Caudium HOWTO</TH
|
|
></TR
|
|
><TR
|
|
><TD
|
|
WIDTH="10%"
|
|
ALIGN="left"
|
|
VALIGN="bottom"
|
|
><A
|
|
HREF="promotecaudium.html"
|
|
ACCESSKEY="P"
|
|
>Prev</A
|
|
></TD
|
|
><TD
|
|
WIDTH="80%"
|
|
ALIGN="center"
|
|
VALIGN="bottom"
|
|
>Chapter 7. How to help the Caudium community</TD
|
|
><TD
|
|
WIDTH="10%"
|
|
ALIGN="right"
|
|
VALIGN="bottom"
|
|
><A
|
|
HREF="cvsaccount.html"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
><HR
|
|
ALIGN="LEFT"
|
|
WIDTH="100%"></DIV
|
|
><DIV
|
|
CLASS="sect1"
|
|
><H1
|
|
CLASS="sect1"
|
|
><A
|
|
NAME="writedoc">7.2. How to write documentation</H1
|
|
><P
|
|
> There are two types of documentation needed for Caudium:
|
|
</P
|
|
><P
|
|
></P
|
|
><UL
|
|
><LI
|
|
><P
|
|
> Press articles.
|
|
</P
|
|
><P
|
|
>
|
|
You can write press articles about Caudium.
|
|
</P
|
|
><DIV
|
|
CLASS="note"
|
|
><P
|
|
></P
|
|
><TABLE
|
|
CLASS="note"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
><TR
|
|
><TD
|
|
WIDTH="25"
|
|
ALIGN="CENTER"
|
|
VALIGN="TOP"
|
|
><IMG
|
|
SRC="../images/note.gif"
|
|
HSPACE="5"
|
|
ALT="Note"></TD
|
|
><TH
|
|
ALIGN="LEFT"
|
|
VALIGN="CENTER"
|
|
><B
|
|
>Note for French writers:</B
|
|
></TH
|
|
></TR
|
|
><TR
|
|
><TD
|
|
> </TD
|
|
><TD
|
|
ALIGN="LEFT"
|
|
VALIGN="TOP"
|
|
><P
|
|
> You can contact us for that.
|
|
</P
|
|
></TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
><P
|
|
> This type of documentation is usually not really helpful since few in the
|
|
community will read it. It is useful mainly for advertising (even if you
|
|
made a very technical article, this is useful).
|
|
</P
|
|
></LI
|
|
><LI
|
|
><P
|
|
> Documentation available from Internet.
|
|
</P
|
|
><P
|
|
> This type of documentation is a must; Caudium can't exist
|
|
without it. This documentation will help Caudium's newbies,
|
|
and will also be useful for developers. One good way to
|
|
start with Caudium is using the Roxen 1.3 documentation. The
|
|
developers should also see the autodoc. These are in-line
|
|
documents made in the sources, and available as formatted
|
|
HTML output at <A
|
|
HREF="http://caudium.net/"
|
|
TARGET="_top"
|
|
>http://caudium.net/</A
|
|
>.
|
|
</P
|
|
><P
|
|
> There is also a lack for a more in-depth documentation for
|
|
developer. Examples include how to code non-blocking
|
|
sockets, how to use a backtrace, how to use the
|
|
<TT
|
|
CLASS="function"
|
|
>do_output_tag</TT
|
|
>, and when should I put <TT
|
|
CLASS="parameter"
|
|
><I
|
|
>thread_safe=1</I
|
|
></TT
|
|
>. I
|
|
remember spending hours trying to understand some
|
|
of these things on IRC without any documentation
|
|
available. This sort of documentation should be written by
|
|
one of the top developers.
|
|
</P
|
|
><P
|
|
> This documentation is written using XSLT, but if you don't
|
|
know it, that's not a problem. Give us whatever format you
|
|
want, we will translate it. It is the same for the
|
|
language. If you don't speak English, you can write it in
|
|
your own language and we will translate. We will also proof-read
|
|
your work carefully in order to correct any typos or inaccuracies
|
|
you might leave.
|
|
</P
|
|
><P
|
|
> To write this type of documentation, contact the person in charge of the
|
|
documentation project, ice at caudium dot net.
|
|
</P
|
|
></LI
|
|
></UL
|
|
></DIV
|
|
><DIV
|
|
CLASS="NAVFOOTER"
|
|
><HR
|
|
ALIGN="LEFT"
|
|
WIDTH="100%"><TABLE
|
|
SUMMARY="Footer navigation table"
|
|
WIDTH="100%"
|
|
BORDER="0"
|
|
CELLPADDING="0"
|
|
CELLSPACING="0"
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="promotecaudium.html"
|
|
ACCESSKEY="P"
|
|
>Prev</A
|
|
></TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="index.html"
|
|
ACCESSKEY="H"
|
|
>Home</A
|
|
></TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="cvsaccount.html"
|
|
ACCESSKEY="N"
|
|
>Next</A
|
|
></TD
|
|
></TR
|
|
><TR
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="left"
|
|
VALIGN="top"
|
|
>How to promote Caudium</TD
|
|
><TD
|
|
WIDTH="34%"
|
|
ALIGN="center"
|
|
VALIGN="top"
|
|
><A
|
|
HREF="helpcaudiumcommunity.html"
|
|
ACCESSKEY="U"
|
|
>Up</A
|
|
></TD
|
|
><TD
|
|
WIDTH="33%"
|
|
ALIGN="right"
|
|
VALIGN="top"
|
|
>How to get a CVS account</TD
|
|
></TR
|
|
></TABLE
|
|
></DIV
|
|
></BODY
|
|
></HTML
|
|
> |