ImgPlugin

Introduction

This is a fairly winky-dink plugin that allows people to use %IMG{"foo.gif"}% instead of using HTML syntax. It allows specification of the standard attributes as well as an optional web=<web> and/or topic=<topic>.

Syntax Rules

• image name is mandatory, web and/or topic optional (defaulting to the current web and topic respectively
• Supports the img attributes 'align', 'border', 'height', 'width', 'id', and 'class
• Always puts in an alt tag with a value of '' if not specified. This is per XHTML spec.

One good addition would be the auto-addition of the image size when possible, since I believe that pages load faster that way. This may require imagemagick, however.

Examples

• %IMG{"foo.gif"}%
• %IMG{"foo.gif" topic="ADifferentTopic"}%
• %IMG{"foo.gif" align="right"}%

Plugin Settings

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

• One line description, is shown in the TextFormattingRules topic:
  • Set SHORTDESCRIPTION = Allows TWiki variable-style insertion of images in topics

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

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

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

  File:	Description:
  data/TWiki/ImgPlugin.txt	Plugin topic
  lib/TWiki/Plugins/ImgPlugin.pm	Plugin Perl module

• Configure the Plugin:
  • Run the configure script to enable the plugin
  • Change the plugin settings as needed
• Test if the installation was successful:
  • %IMG{ "Smile.gif" web="TWiki05x01" topic="FileAttachment" }% renders as %IMG{ "Smile.gif" web="TWiki05x01" topic="FileAttachment" }%

Plugin Info

Related Topics: TWikiPlugins, DeveloperDocumentationCategory, AdminDocumentationCategory, TWikiPreferences