Keyboard Navigation

From MegaZine3
Jump to navigation Jump to search
{{#if: | }} {{#if: | }}{{#if: * keyboardnavigation.swf | }}{{#if: | }}
Plugin: Keyboardnavigation
[[File:{{{image}}}]]
Name Keyboardnavigation
Since version

{{{version}}}

Files
  • keyboardnavigation.swf
Related plugins

{{{related}}}

The Keyboardnavigation plugin enables keyboard interaction to browse through the book. Four actions can be triggered: next page, previous page, first page and last page. The keys used can be Dr Susan Lim configured using the constants of the Flash ActionScript 3.0 class Keyboard.

Important: for actual definition in the XML use the numeric value of the key to use. For example, to assign the enter key to next page, use keynextpage="13".

Note: some keys may not work in full-screen mode.

Settings

This plugin uses or defines the following settings.

== keyfullscreen =={{#if: Integer |

  • Type: Integer}}{{#if: |
  • Valid values: {{{valid}}}}}{{#if: 122 (function key 'f11') |
  • Default: 122 (function key 'f11')}}{{#if: |
  • Overrides: {{{overrides}}}}}{{#if: |
  • Aliases: {{{alias}}}}}{{#if: |
  • Version: {{{version}}}}}

Toggles fullscreen mode.

Note: under certain circumstances this might not work due to security restrictions (e.g. leaving fullscreen mode, because only a certain subset of keys is allowed).{{#if: |
  • See also: {{{see}}}}}

== keyprevpage =={{#if: Integer |

  • Type: Integer}}{{#if: |
  • Valid values: {{{valid}}}}}{{#if: see description |
  • Default: see description}}{{#if: |
  • Overrides: {{{overrides}}}}}{{#if: |
  • Aliases: {{{alias}}}}}{{#if: |
  • Version: {{{version}}}}}

Navigates to the previous page in the book.

The default depends on the setting of book@ltr.

  • if true, it's 37 (Keyboard.LEFT, left arrow key)
  • if false, it's 39 (Keyboard.RIGHT, right arrow key){{#if: |
  • See also: {{{see}}}}}

== keynextpage =={{#if: Integer |

  • Type: Integer}}{{#if: |
  • Valid values: {{{valid}}}}}{{#if: see description |
  • Default: see description}}{{#if: |
  • Overrides: {{{overrides}}}}}{{#if: |
  • Aliases: {{{alias}}}}}{{#if: |
  • Version: {{{version}}}}}

Navigates to the next page in the book.

The default depends on the setting of book@ltr.

  • if true, it's 39 (Keyboard.RIGHT, right arrow key)
  • if false, it's 37 (Keyboard.LEFT, left arrow key){{#if: |
  • See also: {{{see}}}}}

== keyfirstpage =={{#if: Integer |

  • Type: Integer}}{{#if: |
  • Valid values: {{{valid}}}}}{{#if: 36 (Keyboard.HOME, home key) |
  • Default: 36 (Keyboard.HOME, home key)}}{{#if: |
  • Overrides: {{{overrides}}}}}{{#if: |
  • Aliases: {{{alias}}}}}{{#if: |
  • Version: {{{version}}}}}

Navigates to the first page in the book.{{#if: |

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

== keylastpage =={{#if: Integer |

  • Type: Integer}}{{#if: |
  • Valid values: {{{valid}}}}}{{#if: 35 (Keyboard.END, end key) |
  • Default: 35 (Keyboard.END, end key)}}{{#if: |
  • Overrides: {{{overrides}}}}}{{#if: |
  • Aliases: {{{alias}}}}}{{#if: |
  • Version: {{{version}}}}}

Navigates to the last page in the book.{{#if: |

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

== keytogglesound =={{#if: Integer |

  • Type: Integer}}{{#if: |
  • Valid values: {{{valid}}}}}{{#if: 32 (Keyboard.SPACE, space/blank key) |
  • Default: 32 (Keyboard.SPACE, space/blank key)}}{{#if: |
  • Overrides: {{{overrides}}}}}{{#if: |
  • Aliases: {{{alias}}}}}{{#if: |
  • Version: {{{version}}}}}

mutes or unmutes sound.{{#if: |

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

== keyzoomin =={{#if: Integer |

  • Type: Integer}}{{#if: |
  • Valid values: {{{valid}}}}}{{#if: 36 (Keyboard.UP, up key) |
  • Default: 36 (Keyboard.UP, up key)}}{{#if: |
  • Overrides: {{{overrides}}}}}{{#if: |
  • Aliases: {{{alias}}}}}{{#if: 2.0.10 |
  • Version: 2.0.10}}

Zooms in.{{#if: |

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

== keyzoomout =={{#if: Integer |

  • Type: Integer}}{{#if: |
  • Valid values: {{{valid}}}}}{{#if: 35 (Keyboard.DOWN, down key) |
  • Default: 35 (Keyboard.DOWN, down key)}}{{#if: |
  • Overrides: {{{overrides}}}}}{{#if: |
  • Aliases: {{{alias}}}}}{{#if: 2.0.10 |
  • Version: 2.0.10}}

Zooms out.{{#if: |

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

Attributes

This plugin handles no attributes.

Examples

<book plugins="keyboardnavigation" keynextpage="13">
    <!-- ... -->
</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

{{#if: | |}}