head	1.3;
access;
symbols
	camas_1_2_7:1.1
	camas_1_2_6:1.1
	camas_1_2_5:1.1
	camas_1_2_4:1.1
	camas_1_2_3:1.1
	camas_1_2_2:1.1
	camas_1_2_1:1.1
	camas_1_2:1.1.0.2;
locks; strict;
comment	@# @;


1.3
date	2003.03.19.12.03.44;	author kiwi;	state Exp;
branches;
next	1.2;

1.2
date	2003.03.18.09.29.58;	author vida;	state dead;
branches;
next	1.1;

1.1
date	2002.01.29.14.54.10;	author kiwi;	state Exp;
branches;
next	;


desc
@@


1.3
log
@Fixing.....
@
text
@This is a little note how to setup a Caudium Webserver as autodocs displayer


 Note that your Caudium MUST have PiXSL support to allow this. So don't
 forget to install the sablotron libs before compiling caudium.


1- Virtual server Configuration

 You'll need the following modules on a "bare-bone" server :

 o Content types
 o Core RXML Tags
 o Directory parsing module
 o Filesystem
 o Graphics text
 o Standard RXML Entities
 o Tablify
 o XML-Compliant RXML Parser
 o XSLT Tag
 o XSLT Templates

 1a - Special configuration of each modules

 Filesystem modules :

 You'll need at least one file-system module that will handle CAMAS www
 files and an other that will handle autodocs :

 /var/www/camas (the camas webfiles) -> mounted on /
 /var/www/autodocs/stable/docs/ (autodoc generated) -> mounted on /docs/stable/
 /var/www/autodocs/devel/docs/ (autodoc generated) -> mounted on /docs/devel/

 XSLT Tag :

 Leave as is

 XSLT Templates :

 This module will be configured as is :
  . Default XSLT stylesheet : <empty>
  . Index file extension: html
  . Index file name : index.xml
  . Show raw XML files: No
  . Template directory : (the place where the source of caudium exist, example)
                         /usr/local/caudium/cvs/caudium/doc/
  . XML source file extension: .xml
  . XSLT stylesheet extension: .xsl


2- Autocreation of xml files from CVS sources

 2a- Get the files from CVS :

  As usual get the files from cvs. To simply we will say that camas 1.0 
  repository is /var/cvs/camas-1.0 and camas 1.1 is /var/cvs/camas-1.1

  $ cd /var/cvs/camas-1.0
  $ cvs update -Pd

  $ cd /var/cvs/camas-1.1
  $ cvs update -Pd
  
  Note that this can be done using anonymous CVS :)

 2b- Go to your autodoc directory and create the autodocs 

  $ cd /var/www/autodocs/stable
  $ /usr/local/caudium/cvs/caudium/tools/docparser/docparse -t docs/ \
    /var/cvs/camas-1.0/server
   
   (lots of verbose things)

   Please beware of the errors and line number this can because of incorrect
   formating of the autodocs in the sources.

  
  Same for 1.1 branch

  $ cd /var/www/autodocs/devel
  $ /usr/local/caudium/cvs/caudium/tools/docparser/docparse -t docs/ \
    /var/cvs/camas-1.1/server

3- Enjoy !

 Now autodocs are now generated and ready to be consulted.


@


1.2
log
@Current 1.3 is removed.
@
text
@@


1.1
log
@Adding Autodocs docs.
@
text
@@

