head     1.1;
branch   1.1.1;
access   ;
symbols  start:1.1.1.1 cdocs:1.1.1;
locks    ; strict;
comment  @# @;


1.1
date     2001.01.30.04.13.29;  author neotron;  state Exp;
branches 1.1.1.1;
next     ;

1.1.1.1
date     2001.01.30.04.13.29;  author neotron;  state Exp;
branches ;
next     ;


desc
@@



1.1
log
@Initial revision
@
text
@READ THIS FIRST

    This directory contains source files and a setup for converting
    the Caudium XML documentation into presentation formats like HTML
    and RTF. You should not have to bother with this unless you are
    writing documentation yourself, or if you simply are curious about
    how the XML stuff works.

    If you just want to read the documentation, download it from
    http://caudium.net/cdocs/

INTRODUCTION

    All the documentation is written with XML using the DocBook 4.1.2
    XML DTD. See:
    
        http://www.oasis-open.org/docbook/
    
    If you want to produce something viewable, you need Jade and
    Norman Walsh's modular DocBook stylesheets. See:
    
        http://www.jclark.com/jade/
        http://nwalsh.com/docbook/dsssl/
    
    There is a DTD reference for DocBook at
    
        http://www.oasis-open.org/docbook/documentation/reference/

    RPMs with the necessary software can be found at
    ftp://sourceware.cygnus.com/pub/docbook-tools/

    Most major linux distributions should already come with 
    ready to use packages.

CONVENTIONS

    1.  Insert ID attributes in all major section tags such
        as part, chapter, sect1 etc.  The HTML stylesheet will
        name the HTML files after these IDs.

    2.  Function reference IDs look like this (case does not matter):
        `function.imageloadfont'.  Please note that underscores cannot
        be used in IDs, they should be replaced by minus signs (-).

    3.  Function section titles (<reference><title>...</>...) look
        like this: `ref.category'.

    4.  The contents of examples with program listings start on column
        0 in the XML code.


ADD THIS TO THE END OF ALL FILES 

<!-- 
Local variables:
mode: sgml
mode: auto-fill
sgml-omittag:nil
sgml-shorttag:nil
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
sgml-parent-document:nil
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->


@


1.1.1.1
log
@Imported documentation skeleton tree
@
text
@@
