Difference between revisions of "Inline SVG extension"

Latest revision as of 19:11, 2 October 2009

Following is a very simple piece of work. Feel free to comment, particularly about alternative approaches and so on.

Purpose & Quick Howto

To enable including in-line svg code in a wiki document, using client browser's capability (native as in mozilla firefox or with a plug-in as in internet explorer and Adobe's SVG plugin).

Do I need this extension

Probably not! You can achieve the same results using standard mediawiki tools

Upload the svg file as an image
Then use it in an [[Image:foobar]] tag. It works for many browsers.

And if you want to play it safe (remember many old browsers might not support svg format!)

Use SVG Extension by metawikipedia:User:Coffman. It renders gif or png directly, which works in every browser.

Howto

Follow the steps below:

Cut and paste the source code below in to a file named SVGtag.php in your extensions directory
Call SVGtag.php by adding following line to the end of LocalSettings.php

include("extensions/SVGtag.php");

Include svg code as follows:

<svgcode calling_arguments>
<svg  various arguments come here>
svg code here
</svg>
</svgcode>

- For example

<svgcode width="300" height="200" version="1.1">
<svg  version="1.1" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="300" height="200"
     viewBox="0 0 300 350" >
<rect x="0.5" y="0.5" fill="#FFFFFF" stroke="#000000" width="250" height="175"/>
</svg>
</svgcode>

See the bottom of this article to see whether your browser support svg.

Background

How it works

(see metawikipedia:Write_your_own_MediaWiki_extension first.)

The extension registers a hook to Mediawiki wgParser requesting it to run returnSVGtagged function whenever

<svgtag> blah blah </svgtag>

is found in the code, using 'blah blah' (code between <svgtag> and </svgtag> as the argument.

returnSVGtagged function does the following
1. Creates a unique file name based on MD5 checksum of the svg code in the argument.
2. Checks whether a file by that name exists
3. if no
  1. create a new file under that name with svg code as argument
4. end if
5. return a iframe tag calling the unique file name.

Source Code

<?php
#----------------------------------------------------------------------------
#Copyright 2006 Assela Pathirana
#----------------------------------------------------------------------------
#    This program is free software; you can redistribute it and/or modify
#    it under the terms of the GNU General Public License as published by
#    the Free Software Foundation; either version 2 of the License, or
#    (at your option) any later version.
#
#    This program is distributed in the hope that it will be useful,
#    but WITHOUT ANY WARRANTY; without even the implied warranty of
#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#    GNU General Public License for more details.
#
#    You should have received a copy of the GNU General Public License
#    along with this program; if not, write to the Free Software
#    Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
#-------------------------------------------------------------------------------
#    Inspired by svgextension.
#-------------------------------------------------------------------------------
$wgExtensionFunctions[] = "wfSVGtag";

function wfSVGtag() {
	global $wgParser;
	$wgParser->setHook( "svgcode", "returnSVGtagged" );
}

function returnSVGtagged( $code, $argv)
{
	global $wgUploadDirectory, $wgUploadPath, $IP, $wgArticlePath, $wgTmpDirectory;
	$hash = md5( $code );
  $tmploc="/svgcode/";
  $extension=".svg";
  $svgversion=$argv["version"];
  $boxwidth=$argv["width"];
  $boxheight=$argv["height"];
  if (!is_numeric($boxwidth)){
    $boxwidth="500";
  }
  if (!is_numeric($boxheight)){
    $boxheight="500";
  }
  if ($svgversion==""){
    $svgversion='1.1';
  }
  $svgversion2=str_replace(".","",$svgversion);
  $dest = $wgUploadDirectory.$tmploc;
  $path= $wgUploadPath.$tmploc;
	if ( ! is_dir( $dest ) ) { mkdir( $dest, 0777 ); }
	if ( ! is_dir( $wgTmpDirectory ) ) { mkdir( $wgTmpDirectory, 0777 ); }

	$outfile = $dest . $hash.$extension;
  $pname = $path . $hash.$extension;
	if ( !  file_exists( $outfile ) ) {
		$ptr = fopen($outfile, "w");
    $header=
    '<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG '.$svgversion.'//EN" "http://www.w3.org/Graphics/SVG/'.$svgversion.
    '/DTD/svg'.$svgversion2.'.dtd" [ <!ENTITY ns_svg "http://www.w3.org/2000/svg">'.
    '<!ENTITY ns_xlink "http://www.w3.org/1999/xlink"> ]>';
		fwrite($ptr, $header);
		fwrite($ptr, $code);
		fclose($ptr);
  } 
 		$txt  = "<a href=$pname><iframe src=$pname width='".$boxwidth."' height='".$boxheight."' ></iframe></a>";
    return $txt;
}

?>

SVG Browser Test

You can see the images here even if your browser does not support SVG. (They are in fact png images)

Then, if you see the same images below, then your browser supports SVG.

Server configuration

If your web server does not support the content type svg, you have to add it for svg files that are hosted there to work properly. Add the following to either the httpd.conf (if you have rootly powers in the server, which may not be the case if you are using a economical hosting plan) or to a .htaccess file otherwise.

AddType image/svg+xml .svg

If you want to support the svgz file format as well (compressed svg) then the following is also needed.

AddType image/svg+xml .svgz
AddEncoding gzip .svgz
<FilesMatch \.svgz$>
  <IfModule mod_gzip.c>
    mod_gzip_on No
  </IfModule>
</FilesMatch>

What is the advantage of having SVG instead of an image format

There are several web friendly image formats (e.g. PNG, GIF) that are traditionally used to show vector-like data. Why should one complicate his life and other's by using SVG? To know the answer first try clicking on the boarder of one of the frames above. They should open a svg image filling the whole area of your browser, not losing the image quality at all. That is the advantage of a vector format! Still the file sizes are quite small.

@@ Line 7: / Line 7: @@
 * Then use it in an <nowiki>[[Image:foobar]]</nowiki> tag. It works for many browsers.
 And if you want to play it safe (remember many old browsers might not support svg format!)
-* Use [[User:Coffman/SVG Extension| SVG Extension]] by [[User:Coffman]]. It renders gif or png directly, which works in every browser.
+* Use [[metawikipedia:User:Coffman/SVG Extension| SVG Extension]] by [[metawikipedia:User:Coffman]]. It renders gif or png directly, which works in every browser.
 ===Howto===
@@ Line 14: / Line 14: @@
 * Cut and paste the [[#Source Code|source code]] below in to a file named SVGtag.php in your extensions directory
 * Call SVGtag.php by adding following line to the end of LocalSettings.php <nowiki>
-</nowiki><pre><nowiki>include("extensions/SVGtag.php");</nowiki></pre>
+</nowiki>
+<pre><nowiki>include("extensions/SVGtag.php");</nowiki></pre>
 * Include svg code as follows: <nowiki>
-</nowiki><pre><nowiki><svgcode calling_arguments>
+</nowiki>
+<pre><nowiki><svgcode calling_arguments>
 <svg  various arguments come here>
 svg code here
@@ Line 22: / Line 24: @@
 </svgcode></nowiki></pre>
 ** For example <nowiki>
-</nowiki><pre><nowiki><svgcode width="300" height="200" version="1.1">
+</nowiki>
+<pre><nowiki><svgcode width="300" height="200" version="1.1">
 <svg  version="1.1" id="Layer_1" xmlns="&ns_svg;" xmlns:xlink="&ns_xlink;" width="300" height="200"
       viewBox="0 0 300 350" >
@@ Line 42: / Line 45: @@
 (see [[metawikipedia:Write_your_own_MediaWiki_extension]] first.)
 * The extension registers a hook to Mediawiki wgParser requesting it to  run returnSVGtagged function whenever <nowiki>
-</nowiki><pre><nowiki><svgtag> blah blah </svgtag></nowiki></pre> is found in the code, using 'blah blah' (code between <svgtag> and </svgtag> as the argument.
+</nowiki>
+<pre><nowiki><svgtag> blah blah </svgtag></nowiki></pre> is found in the code, using 'blah blah' (code between <svgtag> and </svgtag> as the argument.
 * returnSVGtagged function does the following
 *# Creates a unique file name based on MD5 checksum of the svg code in the argument.
@@ Line 51: / Line 55: @@
 *# return a '''iframe''' tag calling the unique file name.
 ==Source Code==
 <pre>
 <?php
@@ Line 256: / Line 261: @@
 ==Server configuration==
 If your web server does not support the content type svg, you have to add it for svg files that are hosted there to work properly. Add the following to either the httpd.conf (if you have rootly powers in the server, which may not be the case if you are using a economical hosting plan) or to a .htaccess file otherwise.
 <pre>
 AddType image/svg+xml .svg
 </pre>
 If you want to support the svgz file format as well (compressed svg) then the following is also needed.
 <pre>
 AddType image/svg+xml .svgz
@@ Line 274: / Line 281: @@
 ----
 See also: [http://wiki.svg.org]
-[[Category:Mediawiki_Extensions]]
+[[Category:Mediawiki Extensions]]

Difference between revisions of "Inline SVG extension"

Latest revision as of 19:11, 2 October 2009

Contents

Purpose & Quick Howto

Do I need this extension

Howto

Background

How it works

Source Code

SVG Browser Test

Server configuration

What is the advantage of having SVG instead of an image format

Navigation menu

Page actions

Page actions

Personal tools

Search

Tools