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 your DocBook document are annotatable

  • where the annotations shall be displayed

  • where the annotations shall be stored.

The configuration file itself is a valid XSL style sheet. It imports the original DocBook XSL style sheet, 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 XSL processing, defines templates for annotation and says which parts of your document may be annotated.

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

You can find an example configuration file in Appendix B, Example configuration file.