SimpleViewer Plugin

Compatible with DokuWiki

  • 2012-01-25 "Angua" unknown
  • 2011-05-25 "Rincewind" unknown
  • 2010-11-07 "Anteater" yes

plugin Display Airtight Simpleviewer

Last updated on
2011-04-15
Provides
Syntax
Repository
Source
Requires
cache

Installation

:!: External requirements: This plugin requires the following additional components that must be installed separately:

  • cache (Used for xml generation for simpleviewer)

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.

This plugin takes input images from a given namespace or a list of given images. It then generates a XML file which the simpleviewer SWF uses to show the gallery.

Almost all simpleviewer attributes can be defined for a gallery. If you do not specify these, then default values are taken from the Configuration Page.

The plugin in its most simplest form (use root namespace):

<sviewer>
{{:}}
</sviewer>

Custom simpleviewer attributes:

<sviewer 900 700 left modern A165FF 000000 30 bottom 2 1 true false 800 600 1 "Test Gallery">
{{:image1.jpg}}
{{:image2.jpg}}
</sviewer>

Syntax

<sviewer width height align galleryStyle textColor frameColor frameWidth thumbPosition thumbColumns thumbRows showOpenButton showFullscreenButton maxImageWidth maxImageHeight captionMode "Title">
{{namespace or images}}
</sviewer>

Attributes explained (also written in the configuration page):

Attribute Explaination
width SimpleViewer width
height SimpleViewer height
align SimpleViewer alignment (LEFT/RIGHT/NOALIGN)
galleryStyle Gallery Style (MODERN/COMPACT/CLASSIC)
textColor Color of title and caption text
frameColor Color of image frame, thumbnail frame, image navigation arrows and thumb navigation arrows
frameWidth Width of image frame
thumbPosition Position of thumbnails relative to main image (TOP/BOTTOM/RIGHT/LEFT/NONE)
thumbColumns Number of thumbnail columns
thumbRows Number of thumbnail rows
showOpenButton Whether to show “Open Image in New Window” button and right-click menu option (TRUE/FALSE)
showFullscreenButton Whether to show “Go Fullscreen” button and right-click menu option (TRUE/FALSE)
maxImageWidth Width of the widest image in the gallery. Used to determine the best layout for your gallery
maxImageHeight Height of tallest image in the gallery. Used to determine the best layout for your gallery
captionMode Captionmode, 0=No caption, 1=Filename as caption, 2=Filename as caption without extension
title SimpleViewer title

Development

The original plugin was made by Ikuo Obataya (see his AutoViewer plugin here). Thanks for your effort Ikuo!

I modified his plugin to work with SimpleViewer.

Syntax.php modifications

  • SWFobject javascript removed, used <object> and <embed> tags instead.
  • Modified RegEx to take additional attributes.
  • Modified $xml render to work with simpleviewer.
  • Modified default.php, metadata.php and settings.php accordingly.
  • Thumbnails are not generated, the original images are used instead.

Change Log

  • 2011-04-15
    • Initial release
  • 2011-04-18
    • RegEx fix for lowercase and uppercase attributes
    • Added feature for caption mode

Known Bugs and Issues

  • If you have issues regarding caching for the xml, add this to the top of your dokuwiki page:
    ~~NOCACHE~~
  • :!: Installation: please install the cache plugin first, otherwise you constantly get the message “sviewer plugin requires cache plugin.”. I will fix this soon.
  • Attributes within the sviewer tags have to be lowercase otherwise the default attributes are taken. I will fix this soon. Fixed.

ToDo/Wish List

  • Option to configure image captions via syntax (now the caption is always set to the namespace the image is located in). Added feature.
  • Add functionality to omit certain parameters (and thus taking default values)

FAQ

  • It is recommended to add an option to let show/hide “simple viewer” logo (link) at the bottom of page! I think the support link is enough to be displayed on local menu (right click ) — atronoushatronoush

    USA
    2011/06/18 08:37
    • Hi atronoush, unfortunately this is not possible for the free version of simpleviewer, you have to purchase simpleviewer pro. Or do you mean to add this option for a simpleviewer pro installation?

Discussion

If you encounter any problems post them here in the Discussion heading please, or contact me, i will respond as soon as possible :)

plugin/sviewer.txt · Last modified: 2011/07/04 18:39 by 62.131.128.18
 
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 3.0 Unported
Imprint Recent changes RSS feed Donate Powered by PHP Valid XHTML 1.0 Valid CSS Driven by DokuWiki
WikiForumIRCBugsGitXRefTranslate