SvgPlugin

SvgPlugin displays SVG drawings attached in TWiki as PNG images, inline in your topics.

SvgPlugin uses the Image::LibRSVG Perl module (which uses librsvg), to convert your SVG drawings into PNG pictures.

Syntax Rules

• %SVG{"drawing" parameters}%
  • where drawing is the filename of an attached SVG image.
• Parameters:

  Parameter	Description	Defaul value
  size	the maximum size of the picture. The picture will be generated do fit in this size. SvgPlugin will generate a picture the fits best in the given size, without distorting the image.	DEFAULTSIZE setting below
  topic	The topic to which the drawing is attached. Can be TheTopic or Web.TheTopic	current topic

Examples

You type:	You should get:	You get (if installed):
%SVG{"TWikiBrasil.svg"}%		%SVG{"TWikiBrasil.svg"}%
%SVG{"TWikiBrasil.svg" size="400x300"}%		%SVG{"TWikiBrasil.svg" size="400x300"}%
%SVG{}%	SvgPlugin: you must specify a drawing to display!	%SVG{}%
%SVG{"TWikiBrasil.svg" topic="Main.AntonioTerceiro"}%	SvgPlugin: can't find drawing TWikiBrasil.svg attched at Main/AntonioTerceiro.	%SVG{"TWikiBrasil.svg" topic="Main.AntonioTerceiro"}%

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 = Shows SVG drawings as PNG pictures embeded in topics

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

• My own setting:
  • Set DEFAULTSIZE = 320x200

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.

• Install the Image::LibRSVG Perl module.
• Download the ZIP file from the Plugin web (see below)
• Unzip SvgPlugin.zip in your twiki installation directory. Content:

  File:	Description:
  data/TWiki/SvgPlugin.txt	Plugin topic
  data/TWiki/SvgPlugin.txt,v	Plugin topic repository
  lib/TWiki/Plugins/SvgPlugin.pm	Plugin Perl module
  pub/TWiki/SvgPlugin/TWikiBrasil.svg	Sample drawing
  pub/TWiki/SvgPlugin/TWikiBrasil-320-200.png	Sample picture
  pub/TWiki/SvgPlugin/TWikiBrasil-400x300.png	Sample picture

• Test if the installation was successful:
  • see examples above.

Plugin Info

Related Topics: TWikiPreferences, TWikiPlugins

-- TWiki:Main/AntonioTerceiro - 06 Oct 2004