====== ryubin Plugin ======

---- plugin ----
description: A Flash-based panorama viewer by Ryubin's Panorama Laboratory
author     : Robert Kormann
email      : ryubin@kormann.info
type       : Syntax
lastupdate : 2011-11-26
compatible : Rincewind, Angua, Adora Belle, Ponder Stibbons
depends    : 
conflicts  : 
similar    : panorama
tags       : !obsolete flash javascript images media panorama 

downloadurl: https://trello.com/1/cards/5d51ad07838e1d86d46e02e9/attachments/5d51afd39a972e3892980ba5/download/dokuwiki-plugin-ryubin.tgz
bugtracker : 
sourcerepo : 
donationurl: 

----

Flash is not available anymore in browsers.

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

:!: According to massive error log, the ''handle'' and ''render'' functions in ''syntax/ryubin.php'' need to be brought up to modern DW requirements by replacing "&" sign with words marked in bold:\\ 35 string - ''public function handle($match, $state, $pos, **Doku_Handler** $handler){''\\ 131 string - ''public function render($mode, **Doku_Renderer** $renderer, $data) {''

===== 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 [[http://www.ryubin.com/panolab/panoflash/|Ryubin's Panorama Player]] were removed. These can be separately downloaded from the author's page or from [[http://www.ryubin.com/panolab/panoflash/download.html|Ryubin's Panorama Laboratory]].

{{https://trello.com/1/cards/5d51ad07838e1d86d46e02e9/attachments/5d51b03e5b31942f0225d2a3/download/User_sGuide_V50R10.pdf|User's Guide}} (1.5 MiB) of Ryubin's Panorama Player

{{https://trello.com/1/cards/5d51ad07838e1d86d46e02e9/attachments/5d51b0b5186c3305e56b37ce/download/sphere.jpg?linkonly|Demo image}} (5.6 MiB)

{{https://trello.com/1/cards/5d51ad07838e1d86d46e02e9/attachments/5d51b1477496d64924a4713a/download/my_sound01.mp3|Demo sound}} (1.6 MiB)

{{https://trello.com/1/cards/5d51ad07838e1d86d46e02e9/attachments/5d51b1a95454cb33fd95851a/download/my_sound02.mp3|Another demo sound}} (1.6 MiB)

Search and install the plugin using the [[plugin:extension|Extension Manager]]. Refer to [[:Plugins]] on how to install plugins manually.


===== Examples/Usage =====

See the plugin in action [[http://pano.kormann.info/|here]] FIXME. 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:uploadsize|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 [[:mime|here]]. :!: Please be aware of potential security issues in this case.


===== Syntax =====

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

''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 {{https://trello.com/1/cards/5d51ad07838e1d86d46e02e9/attachments/5d51b03e5b31942f0225d2a3/download/User_sGuide_V50R10.pdf|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 {{https://trello.com/1/cards/5d51ad07838e1d86d46e02e9/attachments/5d51b03e5b31942f0225d2a3/download/User_sGuide_V50R10.pdf|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.