Difference between revisions of "Options"

From MegaZine3
Jump to navigation Jump to search
(category replaced with template)
(optionsmodal)
 
(2 intermediate revisions by the same user not shown)
Line 1: Line 1:
This plugin adds an options dialog in which the user of the book may choose whether he wishes to see the book reflection and / or the page shadows and highlights. Basically, this allows user to change the settings which don't change actual behavior, but have the most impact on performance.
+
{{PluginInfo
 +
| name = Options
 +
| image = Options.jpg
 +
| files =
 +
* options.swf
 +
* options.asul
 +
| related =
 +
* [[Navigationbar]]
 +
}}
 +
 
 +
This plugin adds an options dialog in which the user of the book may choose whether he wishes to see the book reflection and / or the page shadows and highlights. Basically, this allows user to change the settings which don't change actual behavior, but have impact on performance.
  
 
= Plugin interactions =
 
= Plugin interactions =
 +
This plugin strongly depends on the [[NavigationBar]] plugin to be loaded, to add the button opening the options window to it. The plugin has no other effect, i.e. it doesn't define any settings or attributes.
 +
 +
= Attributes =
 +
 +
== [[Book]] ==
 +
 +
{{Attribute
 +
| h= ===
 +
| name = optionsmodal
 +
| type = Boolean
 +
| default = true
 +
| info =
 +
This controls whether the options window should behave like a modal window. In that case book interaction will be disabled while the window is opened, meaning it won't be possible to turn pages (neither by clicking, nor via [[keyboardnavigation|keypresses]]).
 +
 +
If you prefer the window to not block book interaction, set this to false and make sure to remove the blocker area in the options plugin's ASUL definition.
 +
}}
  
This plugin strongly depends on the [[NavigationBar]] plugin to be loaded, to add the button opening the options window to it. The plugin has no other effect, i.e. it doesn't define any settings or attributes.
 
  
 
{{Plugins}}
 
{{Plugins}}

Latest revision as of 17:03, 25 August 2010

{{#if: Options.jpg | }} {{#if: | }}{{#if: * options.swf
  • options.asul |
}}{{#if: * Navigationbar | }}
Plugin: Options
Options.jpg
Name Options
Since version

{{{version}}}

Files
  • options.swf
  • options.asul
Related plugins

This plugin adds an options dialog in which the user of the book may choose whether he wishes to see the book reflection and / or the page shadows and highlights. Basically, this allows user to change the settings which don't change actual behavior, but have impact on performance.

Plugin interactions

This plugin strongly depends on the NavigationBar plugin to be loaded, to add the button opening the options window to it. The plugin has no other effect, i.e. it doesn't define any settings or attributes.

Attributes

Book

=== optionsmodal ==={{#if: Boolean |

  • Type: Boolean}}{{#if: |
  • Valid values: {{{valid}}}}}{{#if: true |
  • Default: true}}{{#if: |
  • Overrides: {{{overrides}}}}}{{#if: |
  • Aliases: {{{alias}}}}}{{#if: |
  • Version: {{{version}}}}}

This controls whether the options window should behave like a modal window. In that case book interaction will be disabled while the window is opened, meaning it won't be possible to turn pages (neither by clicking, nor via keypresses).

If you prefer the window to not block book interaction, set this to false and make sure to remove the blocker area in the options plugin's ASUL definition.{{#if: |

  • See also: {{{see}}}}}


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

{{#if: | |}}