r2 - 20 Sep 2021 - 18:24:14 - MarkusKolb?You are here: TWiki >  TWiki Web > PhotoarchivePlugin
ANNUNCIO: L'aggiornamento dei pacchetti ISI produce importanti cambiamenti, leggete questa nota


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:

... 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


  • This is a sample entry for <TOPICNAME>Photoarchive

My first image in Photoarchive
This is my first image which is shown by PhotoarchivePlugin.
It has no special purpose but you can see how it works.

Plugin Settings

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

  • 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 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.

  • The pixel space around the header and images descripted view.

  • The number of images per page in descripted view.

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

  • The pixel space around the header, image and description in detailed view.

  • The default width and height for random images. If you specify both values the image has a new side ratio.
    • 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 =

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
  • Test if the installation was successful:
    • You see here a sample image included with %PHOTOARCHIVEPLUGINRANDOM%

Plugin Info

Plugin Author: TWiki:Main/MarkusKolb
Plugin Version: 31 Oct 2021 (V1.004)
Plugin Id: $Id: PhotoarchivePlugin.txt 460 2021-10-31 18:11:46Z makolb $
Change History:  
31 Oct 2006: V1.004 updated this plugin info for new version
31 Oct 2006: V1.003 fix quote image filename bug (Thanks to Michael Okincha for bug report)
30 Sep 2004: V1.002 overwriting of plugin preferences in topic now possible
29 Sep 2004: V1.001 patch against Internet Explorer <img>-tag incompatibility
29 Sep 2004: Initial version
TWiki Dependency: $TWiki::Plugins::VERSION 1.024
CPAN Dependencies: none
Other Dependencies: netpbm
Perl Version: 5.005
TWiki:Plugins/Benchmark: GoodStyle 98%, FormattedSearch 96%, PhotoarchivePlugin 96%
Plugin Home: http://TWiki.org/cgi-bin/view/Plugins/PhotoarchivePlugin
Feedback: mailto:twiki-photoarchive@tower-netREMOVE_BEFORE_SEND.de

Related Topics: TWikiPreferences, TWikiPlugins

-- MarkusKolb? - 31 Oct 2021


This site is powered by the TWiki collaboration platformCopyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.PhotoarchivePlugin