Annotate

Dominik Brettnacher

Version 0.1.6

March 10, 2006


Table of Contents

What is Annotate?
Features
Acknowledgements
1. How to install Annotate
Prerequisites
Requirements on the authoring station
Requirements on the web server
Getting the software
Configuring Annotate
Converting your document
Configuring the CGI part
Check the result
If it does not work
2. How Annotate works
Introduction
What Annotate does with your document
XSL processing
Preserving Node-IDs
Managing annotations: the administration mode
Changing Annotate's look and feel
Output modes
Templates
eMail notification
3. The annotate.conf configuration file
Introduction
The right place for the configuration file
The XSL part
The CGI part
A. Frequently asked questions
B. Example configuration file
C. Further reading
DocBook
XML, XSL and XSLT
Perl
Related projects

List of Figures

1. How Annotate Works

List of Tables

1.1. Comment table structure
2.1. Annotate HTML templates
2.2. Annotate template placeholders
3.1. CGI part configuration parameters

List of Examples

1.1. Installing the DBI module with CPAN
1.2. Converting a document with xsltproc
1.3. Converting a document with Saxon
3.1. Style sheet configuration
3.2. Style sheet configuration for chunked output
3.3. Configuration of the annotatable elements
3.4. Making only chapters annotatable
3.5. DBI configuration using MySQL
3.6. DBI configuration using CSV files