PhotoarchivePlugin

PhotoarchivePlugin is a nice plugin to show your photo archive or album in different views. You can add a description to each picture and define the picture size for individual views.

• Future releases will get something like templates to have full control over the layout.
• Now a multiplatform offline Photoarchive application is in work. It will become the user interface for simple storing, describing and uploading to your TWiki Photoarchive. But it needs time.
• I thought it is clear that only trusted users should be allowed to edit the Plugin settings. Warwick Allison sent me a mail that he thinks using the netpbm-tools variables is a security problem. So be sure that untrusted users can not change the variable values. You can change the code in lib/TWiki/Plugins/PhotoarchivePlugin.pm at lines 81 to 84. Remove the TWiki::Func::getPluginPreferencesValue( "ANYTOPNM" ) function calls and set constants.

Syntax Rules

These are the rules to add a Photoarchive to your twiki web.

• Add %PHOTOARCHIVEPLUGIN% to a twiki topic or
• ... add %PHOTOARCHIVEPLUGINRANDOM% for single random image including.
• Create a new topic with name <TOPICNAME>Photoarchive
• Attach your pictures to <TOPICNAME>Photoarchive
• Add your picture definitions in the following form to this topic:

<PA_IMAGE>
IMAGEFILENAME
</PA_IMAGE>
<PA_HEADER>
SHORT IMAGE DESCRIPTION
</PA_HEADER>
<PA_DESCRIPTION>
LONGER DESCRIPTION FOR THIS IMAGE
</PA_DESCRIPTION>
<PA_IMAGE>
NEXT IMAGEFILENAME
</PA_IMAGE>
... etc.

• Each tag must start at the beginning of the line (no spaces) and end with a newline!
• You can overwrite the preferences for images and layout in the topic where you add the %PHOTOARCHIVEPLUGIN% or %PHOTOARCHIVEPLUGINRANDOM% placeholder. To use overwriting from topics you have to add PhotoarchivePlugin_ in front of each settingname. E.g. instead RANDOMWIDTH you have to use PhotoarchivePlugin_RANDOMWIDTH

Examples

• This is a sample entry for <TOPICNAME>Photoarchive

<PA_IMAGE>
image_001.jpg
</PA_IMAGE>
<PA_HEADER>
My first image in Photoarchive
</PA_HEADER>
<PA_DESCRIPTION>
This is my first image which is shown by PhotoarchivePlugin.
It has no special purpose but you can see how it works.
</PA_DESCRIPTION>

• If you want to see a working example please visit
  my homepage at http://www.tower-net.de/cgi-bin/twiki/view/Main/NepalBilder

Plugin Settings

Plugin settings are stored as preferences variables. To reference a plugin setting write %<plugin>_<setting>%, i.e. %INTERWIKIPLUGIN_SHORTDESCRIPTION%

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = PhotoarchivePlugin creates nice image galleries

• Debug plugin: (See output in data/debug.txt)
  • Set DEBUG =

• The default view is the view which is shown without any parameters:
  There is a thumbs, detailed and descripted view.
  • Set DEFAULTVIEW = thumbs

• A few programs of netpbm software package are required to resize images.
  The default entries are /usr/bin/{anytopnm, pnmscale, pnmtopng, pnmtojpeg}.
  • Set ANYTOPNM = /usr/bin/anytopnm
  • Set PNMSCALE = /usr/bin/pnmscale
  • Set PNMTOPNG = /usr/bin/pnmtopng
  • Set PNMTOJPEG = /usr/bin/pnmtojpeg

• The number of images in row and column for thumbs view
  • Set THUMBSROW = 4
  • Set THUMBSCOL = 3

• The thumbnail image width and height. If you set both values the images will change their width-height-ratio.
  • Set THUMBSWIDTH =
  • Set THUMBSHEIGHT = 120

• The pixel space around thumbnail images.
  • Set THUMBSSPACE = 5

• The descripted images width and height. If you set both values the image will change its width-height-ratio.
  • Set DESCRIPTEDWIDTH = 250
  • Set DESCRIPTEDHEIGHT =

• The pixel space around the header and images descripted view.
  • Set DESCRIPTEDSPACE = 5

• The number of images per page in descripted view.
  • Set DESCRIPTEDIMAGES = 5

• The detailed image width and height. If you set both values the image will change its width-height-ratio.
  • Set DETAILEDWIDTH = 600
  • Set DETAILEDHEIGHT =

• The pixel space around the header, image and description in detailed view.
  • Set DETAILEDSPACE = 5

• The default width and height for random images. If you specify both values the image has a new side ratio.
  • Set RANDOMWIDTH =
  • Set RANDOMHEIGHT = 120

• For randomly choosed images you can specify the web and topic where the image archive can be found. The topic with the attached images must end with Photoarchive. You must remove "Photoarchive" at the RANDOMTOPIC setting.
  • Set RANDOMWEB =
  • Set RANDOMTOPIC =

Plugin Installation Instructions

Note: You do not need to install anything on the browser to use this plugin. The following instructions are for the administrator who installs the plugin on the server where TWiki is running.

• Download the ZIP file from the Plugin web (see below)
• Unzip PhotoarchivePlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/PhotoarchivePlugin.txt	Plugin topic
  data/TWiki/PhotoarchivePlugin.txt,v	Plugin topic repository
  data/TWiki/PhotoarchivePluginPhotoarchive.txt	Plugin test photoarchive topic
  data/TWiki/PhotoarchivePluginPhotoarchive.txt,v	Plugin test photoarchive topic repository
  data/TWiki/PhotoarchivePluginPhotoarchive/testimage.jpg	Attached test image
  data/TWiki/PhotoarchivePluginPhotoarchive/testimage.jpg,v	Attached test image repository
  pub/TWiki/PhotoarchivePlugin	Directory for future plugin internal data (empty)
  lib/TWiki/Plugins/PhotoarchivePlugin.pm	Plugin Perl module

• (Dakar) Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.
• Test if the installation was successful:
  • You see here a sample image included with %PHOTOARCHIVEPLUGINRANDOM%

• • %PHOTOARCHIVEPLUGINRANDOM%

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins

-- MarkusKolb? - 31 Oct 2006