The third section of the configuration file configures Annotate's CGI script. This part of the configuraton decides where your document and its comments are stored and what the comments should look like. The following is a list of all directives:
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. |
| TemplateRoot | This should point to the directory containing the templates. |
| NavigationTemplate | Points to the template describing the navigation bar which is displayed at bottom and top of each delivered page. |
| LinkTemplate | Points to the template describing the links which are displayed at the comment anchors. They contain links to the "View comment" and "Write new comment" pages. |
| AnnotateTemplate | Points to the template containing the entry form for a new comment. |
| ViewTemplate | Points to the template which displays one or more comments. |
| MailTemplate | Points to the template which containts the body of a notification about a new comment. |
| Database | This is the data source string for DBI. The database is
used to store the comments 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 comments are displayed by
default. Valid modes are:
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 there is no cookie. |
| eMailAddress | This can be set to one (or more, separated by comma)
eMail address. A notification will be sent to this address if a
new comment is made to any part of the document. If left empty, no mail is sent. |
| eMailSubject | The subject of the notification eMail. |