Slideshow
From MegaZine3
| Name | Slideshow |
|---|---|
| Files |
|
| Related plugins |
The slideshow plugin adds a slideshow functionality to the engine. Basically this allows an automatic, time based page turning.
Contents |
[edit] Plugin interactions
If loaded, registers with the JavaScript plugin to allow JavaScript interaction (events for slideshow start and stop, starting and stopping slideshow).
If the navigationbar plugin is loaded, a button to start and pause the slideshow will be added to it. To remove the button, remove it from the ASUL definition of the plugin (slideshow.asul).
[edit] Settings
This plugin uses or defines the following settings.
slidedelay
- Type: Number
- Default:
3
The default delay in seconds, i.e. how long to wait before turning pages. This can be overridden in chapters and pages (see below). Can be a decimal fraction (i.e. you can say it should take 2.5 seconds).
sliderepeat
- Type: Boolean
- Default:
false
Determines whether the slideshow should "rewind" the book (jump back to the first page) after reaching the end or not. If set to true the slideshow will continue until manually stopped.
slidestart
- Type: Boolean
- Default:
false
Determines whether to automatically start the slideshow after the engine has initialized.
[edit] Attributes
[edit] Chapter
slidedelay
- Type: Number
- Overrides:
book@slidedelay
The default delay for pages in this chapter, i.e. how long to wait before turning pages. This can be overridden in pages (see below).
[edit] Page
slidedelay
- Type: Number
- Overrides:
chapter@slidedelay
The delay for this page, i.e. how long to wait before turning to the next page.
[edit] Examples
<book plugins="slideshow" slidedelay="5" sliderepeat="true" slidestart="true"> <chapter slidedelay="10"> <!-- ... --> </chapter> <chapter> <page slidedelay="2"> <img src="blank.jpg"/> </page> <!-- ... --> </chapter> </book>
| 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 |
