The third section of the configuration file configures Annotate's CGI script. This part of the configuration decides where your document and its annotations are stored and what the annotations should look like. The following is a table of all parameters:
Table 3.1. CGI part configuration parameters
Parameter | Description |
---|---|
DocumentRoot | Like the Apache directive, this specifies the directory where Annotate can find your DocBook document. This path can be given relative or absolute. |
DirectoryIndex | Similar to the Apache directive, Annotate looks for this file if the requested address is a directory. |
TemplateRoot | This should point to the directory containing the templates. |
These are the file names for various templates. For details, see the section called “Templates”. | |
Database | This is the data source string for DBI. The database is
used to store the annotations of your visitors. Any database which
is supported by Perl DBI can be used. Please refer to the Perl
documentation for more information. |
DatabaseUsername | Contains the user name (i.e., login) for the database. Can be left empty if not needed. |
DatabasePassword | Contains the password for the database. Can be left empty if not needed. |
DefaultOutputMode | Controls how annotations are displayed by
default. Each visitor can choose his favorite mode, which is automatically stored in a cookie by Annotate. The default value is therefore only used if the user visits the document for the first time or if there is no cookie. |
eMailAddress | This can be set to one (or more, separated by comma)
eMail addresses. A notification will be sent to this address if a
new annotation is made to any part of the document. |
eMailSubject | The subject of the notification eMail. |
AdminUsername | The user name for logging in to the administration mode. |
AdminPassword | The password for logging in to the administration mode. |
MimeTypes | The location of Apache's mime.types
database. |