DokuWiki

It's better when it's simple

User Tools

Site Tools


plugin:ryubin

ryubin Plugin

Compatible with DokuWiki

Rincewind,Angua,Adora Belle,Ponder Stibbons

plugin A Flash-based panorama viewer by Ryubin's Panorama Laboratory

Last updated on
2011-11-26
Provides
Syntax

This extension has not been updated in over 2 years. It may no longer be maintained or supported and may have compatibility issues.

Similar to panorama

Tagged with flash, images, javascript, media, panorama

:!: Please be aware that this plugin is in ALPHA state. Some hickups might be possible.

Installation

The plugin also installs the Flash based software, which does the actual work. However, to keep its file size reasonably, the media files of Ryubin's Panorama Player were removed. These can be separately downloaded from the author's page or from Ryubin's Panorama Laboratory.

Install the plugin using the Plugin Manager and the download URL above, which points to latest version of the plugin. Refer to Plugins on how to install plugins manually.

Examples/Usage

See the plugin in action here. Please be aware that the interface is currently restricted to still images, however, the XML interface of the player should allow to use the motion picture capabilities of the panorama player right now.

Panoramas tend to be quite big in file size. If the maximum file size is exceeded for an upload within the media manager, the FAQ provides some hints.

XML files are not allowed for upload in a standard DokuWiki installation. Help on how to change this can be found here. :!: Please be aware of potential security issues in this case.

Syntax

{{ryubin>namespace:panorama.jpg[&parameter=value&…]}}

namespace:panorama.jpg is required, and points to the panorama file, which has to be placed in the media directory of DokuWiki. In Admin Mode (see below), namespace:panorama.jpg can be replaced by namespace:panorama.xml, which provides then the primary XML to operate the panorama player (see the User's Guide).

Configuration and Settings

The two parameters primary_xml and adminMode (printed in bold within the Admin page) define the overall operation of the plugin. The first points to the primary XML (see the User's Guide) within the plugin's home (standard is ryubin.xml).

The optional parameters parameter=value should be given exactly as specified in the User's Guide (p 60, FlashVars) of the player with the exception of internal_ctrl (player is never operated using the built-in controller), video_path, seg_lock, quality_lock (still images mode only), and cursor_path (more complex task, which might be restricted to the primary XML).

With Admin Mode adminMode switched on, some additional configurations and parameters (printed in italics within the Admin page) are reachable from the markup:

  • An alternative primary XML can be given as mentioned above.
  • smooth: Additional smoothing of the viewport
  • width, height: The dimension of the viewport in pixels
  • allowFullScreen: Full screen mode of the player
  • allowScriptAccess: Allowed values are sameDomain and always
  • bgcolor: Background color of the viewport

If not explicitly changed, the parameter follows the standard values of the player. These standard values are also provided in brackets within the Admin page.

Development

  • There is no check of the parameters on consistency yet, which might be adjusted via Admin page or markup.
  • The plugin and the primary XML assume a standard DokuWiki directory tree.

Change Log

  • 2011-11-26
    • Initial release

Known Bugs and Issues

  • bgcolor: PHP warnings when used via markup
  • id of div ryubin might start with a number, which breaks XHTML standard

ToDo/Wish List

Let's see…

FAQ

None yet.

Discussion

Any help from DokuWiki specialists, especially with the PHP code, is highly welcome.

plugin/ryubin.txt · Last modified: 2014-05-29 16:41 by 79.216.229.3