Chapter 2. How Annotate works

Table of Contents

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

Introduction

Annotate gives your readers the possibility to add online annotations (annotations) to paragraphs, chapters, and other parts of your documents published on the web. In order to achieve this, Annotate's work consists of two steps:

  1. Annotate extends the DocBook XSL style sheets so that the exported HTML document contains anchors at every point where an annotation should be possible.

  2. When a document is requested by a visitor, the extended HTML file is processed by a CGI script. The anchors are replaced with the respective annotations already made and with links that allow the visitor to add further annotations.