Book Attributes / Parameters

The behavior of a book can be confiured by a couple of book specific attributes. The following list (please unfold) is only a small collection out to the ~80 attributes available to configure the book!

Several book attributes can be modified for selected pages by page attributes, like the width and height of a page od the page background color.

One of the most useful attributes is the plugins one. As value this attribute accepts a comma separated list of plugins that will be used in the actual title. Like search, zoom, navigationbar, print and many more. More details about plugins are available on the dedicated plugins page.

A complete list of all attributes is available in the Wiki.

Selection of Book specific Paramaters
  • centercovers determines, whether to center the book, if a cover page is displayed (i.e. the first or last page).
  • errorlevel defines the error levels, which are printed in the console (opened by pressing # on the keyboard). Levels are: ERROR, WARNING and NOTICE. Can be combined by using the binary-or operator (|).
    E.g <book errorlevel="ERROR"> would print out all fatal errors in the console, but suppresses notices and warnings. ALL is a shortcut for ERROR|WARNING|NOTICE and the default value.
    The console plugin must be included in the plugins list.
  • foldfx Defines the level of the folding effect, i.e. the shadow inbetween two pages, simulating a curvature of the pages.
  • lang defines the language ids of the localizations available to use for the GUI tool tips and texts, as well as book elements. This can be a list of ids separated by commas (e.g. en,de,it). The first entry in the list will be used as the default language. If the system language (i.e. the language set in the operating system of the user) is in the list it will be used as the default language (unless suppressed using the ignoresyslang attribute).
  • maxloaded defines the maximum number of pages that may be present in memory at a time. I.e. only this number of pages will be loaded, and after that new pages will only be loaded after changing the current page. Then the pages left and right to the current one will be loaded until this many pages are present in memory again - pages "further away" than half of this number will be unloaded (removed from memory).
  • pageheight, pagewidth define the height and width of a page in pixels, respectively.
    Content overflowing a page is cut off and not rendered. This is the height a page would have at 100%.
  • plugins allows to define which plugins to load. The given list must be a comma separated list of the names of the plugins to load, e.g. anchors, links, gallery. One of the most important book attributes...
  • thumbloadtext offers the option to define the text to display in thumbnails before they have been generated for the first time. With this the question mark, which is the default text, can be modified.
  • zoomminscale, zoommaxscale determines the smallest and biggest size to which to down-/upscale the pages, as a percentage value. If set to different values, i.e. if zoomminscale != zoommaxscale, then Liquid Scaling is enabled.
WIKI: Book Attributes