Chapter 3. The annotate.conf configuration file

Table of Contents

Introduction
The right place for the configuration file
The XSL part
The CGI part

Introduction

The annotate.conf configuration file controls nearly every aspect of Annotate. Features you can control from the configuration file include

  • which elements of you DocBook document should be annotated.

  • where the annotations should be displayed.

  • where the annotations should be stored.

The configuration file is a valid XML document which conforms to the XSL DTD. It imports the original DocBook XSL stylesheet, making a few changes. For convenience, the run-time configuration for the Annotate CGI scripts is also made in this file. Because it serves two purposes, the configuration file consists of two parts:

  1. The first part (The XSL part) deals with the XSLT processing, defines templates for annotation and says which parts of your document should be annotated.

  2. The second part (The CGI part) controls how the Annotate CGI scripts work.