PythonEffectTutorial - Revision history

Doctormo: Replaced content with "[extensions under review]"

2020-02-02T04:07:11Z

Replaced content with "[extensions under review]"

Matyilona: /* Effect Extension Script */ provide link to documentation of inkex.py and simplestyle.py

2017-11-06T20:53:06Z

Effect Extension Script: provide link to documentation of inkex.py and simplestyle.py

← Older revision		Revision as of 20:53, 6 November 2017
Line 17:		Line 17:
	</pre>		</pre>

	Import the ''inkex.py'' file with the ''Effect'' base class that will do most of the work for us and the ''simplestyle.py'' module with support functions for working with CSS styles. We will use just the ''formatStyle'' function from this module:		Import the ''inkex.py'' file with the ''Effect'' base class that will do most of the work for us and the ''simplestyle.py'' module with support functions for working with CSS styles, for more information on these modules see [[Python modules for extensions]]. We will use just the ''formatStyle'' function from this module:
	<pre>		<pre>
	import inkex		import inkex

Raphael: Small style improvements + typo corrections

2016-03-13T10:33:46Z

Small style improvements + typo corrections

← Older revision		Revision as of 10:33, 13 March 2016
Line 1:		Line 1:
	Effect extensions in Inkscape means a simple programs or scripts that reads an SVG file from standard input, transforms it somehow and prints it to the ~~standart~~ output. Usually Inkscape sits on both ends, providing the file with some parameters as input first and finally reading the output, which is then used for further work.		Effect extensions in Inkscape means a simple programs or scripts that reads an SVG file from standard input, transforms it somehow and prints it to the standard output. Usually Inkscape sits on both ends, providing the file with some parameters as input first and finally reading the output, which is then used for further work.
	[[Image:Effect_flow.svg\|thumb\|right\|400px]]		[[Image:Effect_flow.svg\|thumb\|right\|400px]]

	We will write a simple effect extension script in [http://docs.python.org Python] that will ~~put~~ "Hello World!" or "Hello <value of --what option>!" string in the center of document and inside a new layer.		We will write a simple effect extension script in [http://docs.python.org Python] that will create a new "Hello World!" or "Hello <value of --what option>!" string in the center of document and inside a new layer.

	== Effect Extension Script ==		== Effect Extension Script ==
Line 11:		Line 11:
	</pre>		</pre>

	If you're going to put the file somewhere else than into ~~inkscape~~'s installation directory, we need to add a path so that python can find the necessary modules:		If you're going to put the file somewhere else than into Inkscape's installation directory, we need to add a path so that python can find the necessary modules:
	<pre>		<pre>
	import sys		import sys

~suv: update for 0.91

2015-01-31T02:02:38Z

update for 0.91

← Older revision		Revision as of 02:02, 31 January 2015
Line 3:		Line 3:

	We will write a simple effect extension script in [http://docs.python.org Python] that will put "Hello World!" or "Hello <value of --what option>!" string in the center of document and inside a new layer.		We will write a simple effect extension script in [http://docs.python.org Python] that will put "Hello World!" or "Hello <value of --what option>!" string in the center of document and inside a new layer.

	~~<!-- NOTE: the script from the tutorial does work with current stable Inkscape 0.48. -->~~
	~~<!-- It fails however with 0.48+devel (aka 0.91) due to: -->~~
	~~<!-- http://wiki.inkscape.org/wiki/index.php/Release_notes/0.91#Units:_Breaking_change -->~~
	~~<!-- TODO: update page/sample script once 0.91 is released -->~~
	~~<!--~~
	~~<blockquote>~~
	''This script won't work with the current version of inkscape, it might still help as a useful guide how to create your own scripts though. Especially the methods to access the xml structure have changed, please refer to the [http://codespeak.net/lxml/ lxml] documentation.''
	~~</blockquote>~~
	~~-->~~

	== Effect Extension Script ==		== Effect Extension Script ==
Line 70:		Line 60:

	# Again, there are two ways to get the attibutes:		# Again, there are two ways to get the attibutes:
	width = ~~inkex~~.unittouu(svg.get('width'))		width = self.unittouu(svg.get('width'))
	height = ~~inkex~~.unittouu(svg.attrib['height'])		height = self.unittouu(svg.attrib['height'])
	</pre>		</pre>
	The ''xpath'' function returns a list of all matching elements so we just use the first one of them.		The ''xpath'' function returns a list of all matching elements so we just use the first one of them.
Line 198:		Line 188:

	# Again, there are two ways to get the attibutes:		# Again, there are two ways to get the attibutes:
	width = ~~inkex~~.unittouu(svg.get('width'))		width = self.unittouu(svg.get('width'))
	height = ~~inkex~~.unittouu(svg.attrib['height'])		height = self.unittouu(svg.attrib['height'])

	# Create a new layer.		# Create a new layer.

~suv: /* Extension Description File */

2014-12-15T01:04:06Z

Extension Description File

← Older revision		Revision as of 01:04, 15 December 2014
Line 117:		Line 117:

	<pre>		<pre>
	<inkscape-extension>		<?xml version="1.0" encoding="UTF-8"?>
			<inkscape-extension xmlns="http://www.inkscape.org/namespace/inkscape/extension">
	<_name>Hello World!</_name>		<_name>Hello World!</_name>
	<id>org.ekips.filter.hello_world</id>		<id>org.ekips.filter.hello_world</id>

~suv: /* Effect Extension Script */ update external links

2014-12-15T00:57:40Z

Effect Extension Script: update external links

← Older revision		Revision as of 00:57, 15 December 2014
Line 43:		Line 43:
	</pre>		</pre>

	The complete documentation for the ''OptionParser'' class can be found at ~~http~~://docs.python.org/~~lib~~/~~module-~~optparse.html. Here we just use the ''add_option'' method which has as first argument a short option name, as second argument a long option name and then a few other arguments with this meaning:		The complete documentation for the ''OptionParser'' class can be found at [https://docs.python.org/2/library/optparse.html docs.python.org]. Here we just use the ''add_option'' method which has as first argument a short option name, as second argument a long option name and then a few other arguments with this meaning:

	* ''action'' - An action which should be done with option value. In this case we use action ''store'' which will store option value in ''self.options.<destination>'' attribute.		* ''action'' - An action which should be done with option value. In this case we use action ''store'' which will store option value in ''self.options.<destination>'' attribute.
Line 61:		Line 61:

	Now we will finally start to do something. We will have to work with the XML representation of the SVG document that we can access via ''Effect'''s ''self.document'' attribute.		Now we will finally start to do something. We will have to work with the XML representation of the SVG document that we can access via ''Effect'''s ''self.document'' attribute.
	It is of lxml's '' _ElementTree'' class type. Complete documentation for the lxml package ~~lxml~~ can be found at http://~~codespeak~~.~~net~~/lxml/.		It is of lxml's '' _ElementTree'' class type. Complete documentation for the lxml package can be found at [http://lxml.de/ lxml.de].

	First we get SVG document's ''svg'' element and its dimensions:		First we get SVG document's ''svg'' element and its dimensions:

~suv: hide outdated information (script was already migrated to lxml)

2014-04-03T21:04:06Z

hide outdated information (script was already migrated to lxml)

← Older revision		Revision as of 21:04, 3 April 2014
Line 4:		Line 4:
	We will write a simple effect extension script in [http://docs.python.org Python] that will put "Hello World!" or "Hello <value of --what option>!" string in the center of document and inside a new layer.		We will write a simple effect extension script in [http://docs.python.org Python] that will put "Hello World!" or "Hello <value of --what option>!" string in the center of document and inside a new layer.

			<!-- NOTE: the script from the tutorial does work with current stable Inkscape 0.48. -->
			<!-- It fails however with 0.48+devel (aka 0.91) due to: -->
			<!-- http://wiki.inkscape.org/wiki/index.php/Release_notes/0.91#Units:_Breaking_change -->
			<!-- TODO: update page/sample script once 0.91 is released -->
			<!--
	<blockquote>		<blockquote>
	''This script won't work with the current version of inkscape, it might still help as a useful guide how to create your own scripts though. Especially the methods to access the xml structure have changed, please refer to the [http://codespeak.net/lxml/ lxml] documentation.''		''This script won't work with the current version of inkscape, it might still help as a useful guide how to create your own scripts though. Especially the methods to access the xml structure have changed, please refer to the [http://codespeak.net/lxml/ lxml] documentation.''
	</blockquote>		</blockquote>
			-->

	== Effect Extension Script ==		== Effect Extension Script ==

~suv: adjust menu name ('Effects' was renamed to 'Extensions' in Inkscape 0.47)

2014-04-03T20:55:21Z

adjust menu name ('Effects' was renamed to 'Extensions' in Inkscape 0.47)

← Older revision		Revision as of 20:55, 3 April 2014
Line 140:		Line 140:
	</pre>		</pre>

	Now start Inkscape. A new menu item ''Hello World!'' in ''~~Effects~~->Examples'' menu should appear.		Now start Inkscape. A new menu item ''Hello World!'' in ''Extensions->Examples'' menu should appear.

	== Complete Source Code ==		== Complete Source Code ==

~suv: /* Installation */ update path to user extensions directory

2010-10-13T20:01:57Z

Installation: update path to user extensions directory

← Older revision		Revision as of 20:01, 13 October 2010
Line 135:		Line 135:
	== Installation ==		== Installation ==

	To install a new extenstion just put ''hello_world.py'' and ''hello_world.inx'' files with all dependency modules to the ''<path_to_inkscape>/extensions'' or ''~/.inkscape/extensions'' directory. On Linux you will probably have to make the python script executable first if you haven't done this yet. This is usually done by the usual command (or in your preferred file manager):		To install a new extenstion just put ''hello_world.py'' and ''hello_world.inx'' files with all dependency modules to the ''<path_to_inkscape>/extensions'' or ''~/.config/inkscape/extensions'' directory. On Linux you will probably have to make the python script executable first if you haven't done this yet. This is usually done by the usual command (or in your preferred file manager):
	<pre>		<pre>
	$ chmod a+x hello_world.py		$ chmod a+x hello_world.py

Acspike: add to Extensions category

2008-09-07T19:36:48Z

add to Extensions category

← Older revision		Revision as of 19:36, 7 September 2008
Line 221:		Line 221:
	Last edited by --[[User:Rubikcube\|Rubikcube]] 21:18, 7 August 2008 (UTC), based on a version by		Last edited by --[[User:Rubikcube\|Rubikcube]] 21:18, 7 August 2008 (UTC), based on a version by
	[[User:Blackhex\|Blackhex]] 11:59, 26 April 2007 (UTC)		[[User:Blackhex\|Blackhex]] 11:59, 26 April 2007 (UTC)
			[[Category:Developer Documentation]]
			[[Category:Extensions]]