Headers and Footers
The header and footer files follow the syntax of headerfooter.dtd
.
There are two main types of elements: servlets and variables.
Servlets are used for links that activate a servlet performing a certain
function. Variables are used to insert a certain number or string in
the header. A final element is the stopapplet which causes an
invisible applet to be inserted. That applet triggers the registration
of reading times.
The possible servlets are:
- logout: when activated the session is ended; the user can then
start a new session, for the same or another application.
- colorsettings: when activated a form is displayed through which
the user can change the colors of links.
- knowledgesettings: when activated a form is displayed through
which the user can change knowledge values for certain concepts (for which
the author has enabled this feature).
- passwordsettings: when activated a form is displayed through
which the user can change her password.
- done: this generates a list of pages already read.
- todo: this generates a list of pages still to be read; pages that
were read when considered undesirable still appear in this list.
Example:
<servlet>
<servletname>
<colorsettings/>
</servletname>
<linkdescription>
review and change color settings
</linkdescription>
</servlet>
The possible variables are:
- username: replaced by the full name the user entered then registering.
- loginid: replaced by the given user id.
- university: replaced by the user's university (if this is used
in the registration form).
- department: replaced by the user's department (if this is used
in the registration form).
- course: the (short) name of the application, which is also
the name of the top directory of the application.
- title: the title of the application, which is also used as the
title for each page as shown by the browser.
- numberdone: the number of pages already read.
- numbertodo: the number of pages still to be read.
Example:
<variable>
<username/>
</variable>
has read
<variable>
<numberdone/>
</variable>
pages.