Navigationbar
From MegaZine3
 |
|
|---|---|
| Name | Navigationbar |
| Files |
|
| Related plugins | |
The NavigationBar plugin allows the simple generation of a control bar, which allows navigating to the different pages in the book and trigger some actions, such as "goto next page", "enter fullscreen" and so on.
Contents |
[edit] Plugin interactions
Some plugins, such as the options and slideshow plugins add buttons to the bar (any plugin can, see the NavigationBar's API). This plugin itself does not depend on other plugins.
[edit] Settings
This plugin uses or defines the following settings.
navbarbuttoncolors
- Type: Definition
- Default:
N/A - Aliases: buttoncolors
This attribute allow to define custom colors for page buttons, for buttons representing pages being the start of a chapter or having an anchor id.
Some examples:
-
chapter(0xFF0000), makes all chapter buttons red. -
anchor(0x00FF00), makes all anchor buttons green. -
chapter(0x0000FF); anchor(0x999999), makes all chapter buttons blue and all anchor buttons gray.
navbarcolorizefullchapter
- Type: Boolean
- Default:
false - Aliases: colorizefullchapter
Determines whether a chapter's color should be applied to all buttons representing pages it contains, or just the first one.
navbarflagpath
- Type: URL
- Default:
book@guipath/navigationbar/langs/ - Aliases: flagpath
Path relative to the engine to a folder containing flag files, i.e. flag.xx.gif files (analog to the language files in their respective xx/ folders the xx stand for the ISO 639-1 language code). Used for the language chooser.
[edit] Attributes
[edit] Chapter
buttoncolor
- Type: Number
- Overrides:
book@buttoncolor
Allows setting a button color for pages in this chapter (see setting buttoncolors).
[edit] Page
buttoncolor
- Type: Number
- Overrides:
chapter@buttoncolor
Allows setting a button color this page (see setting buttoncolors).
| MegaZine3 Plugin-related articles | |
|---|---|
| Plugins | Anchors · Background Sounds · Batchpages · Bookmarks · Console · ElementIDs · Gallery · Google Analytics · Help · JavaScript · Keyboard Navigation · Links · NavigationBar · Options · Overlays · Password · PDFLinks · Print · PrintPDF · SWFAddress· Search · Sidebar · Slideshow · Titles |
| Plugin Articles | Writing a plugin · Writing a plugin II · Plugin development |
