Help

From MegaZine3

Jump to: navigation, search
Plugin: Help
File:Help.jpg
Name Help
Files
  • help.swf
  • help.asul
Related plugins

This plugin provides a simple help window in which help messages on how to use the engine can be displayed to the actual user.

This plugin strongly depends on the navigationbar plugin, to display the button to open it.

Contents

[edit] Settings

openhelp

  • Type: {once, always, never}
  • Default: once

This determines whether to open the help window automatically when the engine starts up. The possible values are

  • once, meaning it will be loaded the first time a user visits a book on one domain, after that a "Flash cookie" will be created to remember it was displayed.
  • always, opens the help window whenever the user revisits a book on one domain.
  • never, never automatically opens the help window.

[edit] Attributes

This plugin handles no attributes.

[edit] Examples

<book plugins="help" openhelp="never">
    <!-- ... -->
</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
Personal tools