Bookmarks

The bookmarks plugin allows adding bookmarks (or tabs) to your book, which will be placed according to where their corresponding page is in the book's edge. When clicked, the book will go to the page the bookmark belongs to.

= Settings =

= Tags =

This plugin uses an extra child node of the  node to define the bookmarks available per default. The main node name is. This node can contain any number of child nodes named. Each  must have the two following attributes: Mandatory attributes   This is the displayed title of the bookmark   This is the page to jump to when the bookmark is clicked. Note that the page may also be an anchor, as long as the Anchors plugin is loaded. Then the name of an anchor has to be provided as page number like: This will open the last page, when that bookmark is clicked (first, next, prev and last are predefined anchors)   Optional attributes   This is an integer value defining the color in which to tint the bookmark. Example: color='#eeeeee' for a light grey   Additional information can be provided that will pop up when hovering with the mouse over the bookmark (like a tool tip).   Restrictions The  nodes must contain no more nodes themselves.

= Localization = Bookmarks may also be localized. To do this:
 * create localization files
 * set  attribute
 * set bookmarks' titles accordingly

Localization files
Localized titles for bookmarks are stored inside XML files alike to those used for localizing the GUI. They basically have this format: Where there can be any number of  entries. The points to look out for here are to
 * make sure the  is correct. This must be the same shortcut as used for the language in the   attribute.
 * use unique values in the  attributes.

Write the titles of all bookmarks to be used in this file.

The attribute
This attribute can be used to tell the engine where to find the localization files for the bookmarks. What this attribute basically must contain is a path to the localization files created in the previous step. Because you'll obviously have more than on file (one for each language) there is a "variable" available, that will be replaced with the id of the language that the engine tries to load:.

So the value might look like this:

If the languages English (en), German (de) and French (fr) are set, the engine would try to load the files,   and.

Using the localized strings as titles
Finally, you'll still need to tell your bookmark entries to use the localized strings. This is done the same way ASUL localization works: setting the title to, where   corresponds to one of the   attributes' values.

= Example =

= Example (Localization) =

Langfiles
In a file named :

In a file named :

Book definition
In the  file: