Inkscape Wiki - User contributions [en]

User:Blackhex

2007-05-18T23:20:07Z

Blackhex: Creating personal page.

Name: Radek Bartoň<br/>
Nationality: Czech<br/>
Timezone: +1 GMT<br/>
Home Page: http://blackhex.no-ip.org<br/>
E-Mail: blackhex@post.cz<br/>
Jabber: blackhex@jabber.cz<br/>
Occupation: Master degree student at Brno University of Technology<br/>
Wiki Contribution:<br/>
* [[PythonEffectTutorial]]
Inkscape Contribution:<br/>
* not yet

Script extensions

2007-05-18T23:07:31Z

Blackhex: Added reference to PythonEffecttutorial

[Note: This page concerns using scripting languages to create new Inkscape functionality. To access Inkscape functionality from scripting languages (i.e. to script Inkscape), see the Inkscape man page (especially in the development version or v0.46 or later, which provide --select and --verb options), or see the work in the src/extension/script directory of Inkscape source.]

=== Introduction ===

Inkscape provides the ability for its functionality to be extended using traditional unix scripts. By this, we mean a program that takes in a stream of data through standard in, and then outputs that data on standard out. This is a very easy way to expand Inkscape, and provide custom functionality, without learning the internals of Inkscape. Plus, there are SVG read and writing libraries out there for almost any language, and the rest of them all have XML support (which is really what you probably want to use anyway). This HOWTO discusses the ends and outs of writing one of these scripts and getting it to work with the Inkscape core functionality.

=== Types of scripts ===

There are three functions that added with a script:

* Input, providing translation from a file format to SVG
* Output, providing translation from SVG to a format
* Effect, taking in SVG, changing it, and then outputing SVG

While all of these are very similar in the scripting interface, there are slight differences between them.

=== Interaction ===

It is important for a script author to understand how Inkscape and scripts communicate.

(interpreter)? your_script (--param=value)* /path/to/input[[/SVGfile]] | inkscape

Inkscape runs your script (optionally with an interpreter) passing it any number of parameters in long gnu style. The final argument is the name of the temporary svg file your script should read. After processing, the script should return the modified svg file to inkscape on STDOUT.

=== Important Tips ===

* Receive the inkscape arguments.
* Clear temp files if it creates one.
* Write full changed SVG to the default output.
* Don't break an xml:space="preserve" area.
* Send error text to the error output and help the user.

=== Description ===

In order for Inkscape to make use of an external script or program, you must describe that script to inkscape using an INX file. See the inkscape share directory for examples. The INX file allows the author to:
* label strings for translation
* define parameters
* chain extensions
Please see [[MakingAnINX]] for help creating an INX file for your script.

==== Parameters ====
The INX file describes which parameters the extension needs. Inkscape will prompt the user with a UI to fill out these parameters before the extension is called. Each parameter will be passed through the commandline as "--paramname=paramvalue". Eg. if you have described a string parameter with name 'string1' in the INX file, Inkscape will present a textbox to the user. When the user fills in "text" and presses OK, it will pass '--string1="text"' to the program specified by the <command> tag.

There are several types of parameters that can be requested by the INX description:

* Boolean
* Int
* Float
* String
* Description
* Enum
* Notebook
* Option group (radio buttons)

=== Installing ===

Installing is as simple as copying the script (unless it resides in your path) and its INX file to the inkscape/share/extensions (home/.inkscape/extensions) directory. (If you install a script in your home directory be sure to copy the dependencies.)

If you are looking to use scripts that have already been written, the most difficult part will likely be the installation. Since scripts are seperate programs they may have any number of dependencies that are not included with inkscape. Currently, the best way to find missing dependencies is by reading the error messages produced by running the script from the command line.

=== See Also ===

*[http://www.ekips.org/comp/inkscape/extending.php#ignorance| Aarons website] describing his path to learning how scripting extensions work. '''VERY OUT-OF-DATE'''

*[[MakingAnINX]]

*[[PythonEffectTutorial]]

[[Category:Extensions]]

INX extension descriptor format

2007-05-03T19:30:28Z

Blackhex: Added missing item element

== Introduction ==

In order for Inkscape to make use of an external script or program, you must describe that script to inkscape using an INX file. See the inkscape share directory for examples. The INX file allows the author to:
* label strings for translation
* define parameters
* chain extensions
* etc
Be sure to read through the INX files that come with Inkscape. Nothing beats a working example.

== Localisation of extensions ==

To allow localisation of strings in extension for Inkscape, some xml tags have to be adapted to variant readable by intltool. It means that tags or parametres has to have "_" prepended to their name, e.g. <_name>name of extension</_name>

Also the path to the extension has to be included in POTFILES.in file to tell intltool where to look for translatable content.

Usefull information, before this section gets fully updated, can be found at [http://gould.cx/ted/blog/Translating_Custom_XML Ted's blog].

== Example ==
More example INX files are available in the Inkscape distribution or in the Inkscape [http://inkscape.svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/share/extensions/|SVN repository].

<pre>
<inkscape-extension>
<_name>{Friendly Extension Name}</_name>
<id>{org.domain.sub-domain.extension-name}</id>
<dependency type="executable" location="[extensions|path|plugins|{location}]">program.ext</dependency>
<param name="tab" type="notebook">
<page name="controls" _gui-text="Controls">
<param name="{argumentName}" type="[int|float|string|boolean|description]" min="{number}" max="{number}"
_gui-text="{Friendly Argument Name}">{default value}</param>
</page>
<page name="help" _gui-text="Help">
<param name="help_text" type="description">{Friendly Extension Help}</param>
</page>
</param>
<effect>
<object-type>[all|{element type}]</object-type>
<effects-menu>
<submenu _name="{Extension Group Name}"/>
</effects-menu>
</effect>
<script>
<command reldir="extensions" interpreter="[python|perl|ruby|bash|{some other}]">program.ext</command>
</script>
</inkscape-extension>
</pre>

== DTD ==

<!ELEMENT inkscape-extension (name, id, dependency*, param*,(input|output|effect),(script|plugin))>
<!ELEMENT input (extension, mimetype, filetype, filetypetooltip, output_extension?)>
<!ELEMENT output (extension, mimetype, filetype, filetypetooltip, dataloss?)>
<!ELEMENT effect (object-type)>
<!ELEMENT script (command, helper_extension*, check*)>
<!ELEMENT plugin (name)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT id (#PCDATA)>
<!ELEMENT item (#PCDATA)>
<!ELEMENT dependency (#PCDATA)>
<!ELEMENT param (#PCDATA, page*, item*)>
<!ELEMENT page (#PCDATA, param*)>
<!ELEMENT extension (#PCDATA)>
<!ELEMENT mimetype (#PCDATA)>
<!ELEMENT filetype (#PCDATA)>
<!ELEMENT filetooltip (#PCDATA)>
<!ELEMENT object-type (#PCDATA)>
<!ELEMENT command (#PCDATA)>
<!ELEMENT check (#PCDATA)>
<!ELEMENT dataloss (#PCDATA)>
<!ELEMENT helper_extension (#PCDATA)>
<!ELEMENT output_extension (#PCDATA)>

<!ATTLIST check reldir (absolute|path|extensions|plugins) #REQUIRED>
<!ATTLIST command reldir (absolute|path|extensions|plugins) #REQUIRED>
<!ATTLIST command interpreter CDATA #REQUIRED>
<!ATTLIST dependency type (executable|extension) #REQUIRED>
<!ATTLIST dependency location (absolute|path|extensions|plugins) #IMPLIED>
<!ATTLIST dependency description CDATA #IMPLIED>
<!ATTLIST page name CDATA #REQUIRED>
<!ATTLIST page gui-text CDATA #IMPLIED>
<!ATTLIST param name CDATA #REQUIRED>
<!ATTLIST param type (int|float|string|boolean|enum|notebook|description) #REQUIRED>
<!ATTLIST param min CDATA #IMPLIED>
<!ATTLIST param max CDATA #IMPLIED>
<!ATTLIST param gui-text CDATA #IMPLIED>
<!ATTLIST submenu name CDATA #REQUIRED>

== See Also ==
*[[ScriptingHOWTO]]
*[http://sourceforge.net/mailarchive/message.php?msg_id=11420660|Aaron's message] from the developer list with an initial DTD.

[[Category:Developer Documentation]]
[[Category:Help Wanted]]
[[Category:Extensions]]

INX extension descriptor format

2007-04-26T16:48:02Z

Blackhex: Added page, notebook and enum.

== Introduction ==

In order for Inkscape to make use of an external script or program, you must describe that script to inkscape using an INX file. See the inkscape share directory for examples. The INX file allows the author to:
* label strings for translation
* define parameters
* chain extensions
* etc
Be sure to read through the INX files that come with Inkscape. Nothing beats a working example.

== Localisation of extensions ==

To allow localisation of strings in extension for Inkscape, some xml tags have to be adapted to variant readable by intltool. It means that tags or parametres has to have "_" prepended to their name, e.g. <_name>name of extension</_name>

Also the path to the extension has to be included in POTFILES.in file to tell intltool where to look for translatable content.

Usefull information, before this section gets fully updated, can be found at [http://gould.cx/ted/blog/Translating_Custom_XML Ted's blog].

== Example ==
More example INX files are available in the Inkscape distribution or in the Inkscape [http://inkscape.svn.sourceforge.net/viewvc/inkscape/inkscape/trunk/share/extensions/|SVN repository].

<pre>
<inkscape-extension>
<_name>{Friendly Extension Name}</_name>
<id>{org.domain.sub-domain.extension-name}</id>
<dependency type="executable" location="[extensions|path|plugins|{location}]">program.ext</dependency>
<param name="tab" type="notebook">
<page name="controls" _gui-text="Controls">
<param name="{argumentName}" type="[int|float|string|boolean|description]" min="{number}" max="{number}"
_gui-text="{Friendly Argument Name}">{default value}</param>
</page>
<page name="help" _gui-text="Help">
<param name="help_text" type="description">{Friendly Extension Help}</param>
</page>
</param>
<effect>
<object-type>[all|{element type}]</object-type>
<effects-menu>
<submenu _name="{Extension Group Name}"/>
</effects-menu>
</effect>
<script>
<command reldir="extensions" interpreter="[python|perl|ruby|bash|{some other}]">program.ext</command>
</script>
</inkscape-extension>
</pre>

== DTD ==

<!ELEMENT inkscape-extension (name, id, dependency*, param*,(input|output|effect),(script|plugin))>
<!ELEMENT input (extension, mimetype, filetype, filetypetooltip, output_extension?)>
<!ELEMENT output (extension, mimetype, filetype, filetypetooltip, dataloss?)>
<!ELEMENT effect (object-type)>
<!ELEMENT script (command, helper_extension*, check*)>
<!ELEMENT plugin (name)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT id (#PCDATA)>
<!ELEMENT dependency (#PCDATA)>
<!ELEMENT param (#PCDATA, page*)>
<!ELEMENT page (#PCDATA, param*)>
<!ELEMENT extension (#PCDATA)>
<!ELEMENT mimetype (#PCDATA)>
<!ELEMENT filetype (#PCDATA)>
<!ELEMENT filetooltip (#PCDATA)>
<!ELEMENT object-type (#PCDATA)>
<!ELEMENT command (#PCDATA)>
<!ELEMENT check (#PCDATA)>
<!ELEMENT dataloss (#PCDATA)>
<!ELEMENT helper_extension (#PCDATA)>
<!ELEMENT output_extension (#PCDATA)>

<!ATTLIST check reldir (absolute|path|extensions|plugins) #REQUIRED>
<!ATTLIST command reldir (absolute|path|extensions|plugins) #REQUIRED>
<!ATTLIST command interpreter CDATA #REQUIRED>
<!ATTLIST dependency type (executable|extension) #REQUIRED>
<!ATTLIST dependency location (absolute|path|extensions|plugins) #IMPLIED>
<!ATTLIST dependency description CDATA #IMPLIED>
<!ATTLIST page name CDATA #REQUIRED>
<!ATTLIST page gui-text CDATA #IMPLIED>
<!ATTLIST param name CDATA #REQUIRED>
<!ATTLIST param type (int|float|string|boolean|enum|notebook|description) #REQUIRED>
<!ATTLIST param min CDATA #IMPLIED>
<!ATTLIST param max CDATA #IMPLIED>
<!ATTLIST param gui-text CDATA #IMPLIED>
<!ATTLIST submenu name CDATA #REQUIRED>

== See Also ==
*[[ScriptingHOWTO]]
*[http://sourceforge.net/mailarchive/message.php?msg_id=11420660|Aaron's message] from the developer list with an initial DTD.

[[Category:Developer Documentation]]
[[Category:Help Wanted]]
[[Category:Extensions]]

PythonEffectTutorial

2007-04-26T12:32:06Z

Blackhex: parseLenght removed and complete source code added.

Effect extensions in Inkscape means a simple programs or scripts that reads input SVG file transforms it somehow and prints it to the standart output.

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

== Effect Extension Script ==

First of all create file ''hello_world.py'' and make them executable with Python interpreter with well-known directive:

<pre>
#!/usr/bin/env python
</pre>

Import ''inkex.py'' file with ''Effect'' base class that will do most of work for us and ''simplestyle.py'' module with support functions for working with CSS styles. We will use just ''formatStyle'' function from this module:

<pre>
import inkex
from simplestyle import *
</pre>

Declare ''HelloWordEffect'' class and write a constructor where base class is initialized and script option for opition parser is defined:

<pre>
class HelloWorldEffect(inkex.Effect):
def __init__(self):
inkex.Effect.__init__(self)
self.OptionParser.add_option('-w', '--what', action = 'store',
type = 'string', dest = 'what', default = 'World',
help = 'What would you like to greet?')
</pre>

Complete documentation for ''OptionParser'' class can be found at http://docs.python.org/lib/module-optparse.html. Here we just use ''add_option'' method which has as first argument short option name, as second argument 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.
* ''type'' - Type of option value. We use string here.
* ''dest'' - Destination of option action specified by ''action'' argument. Using ''what'' value we say that we want to store option value to self.options.what attribute.
* ''default'' - Defalut value for this option if it is not specified.
* ''help'' - A help string that will be displayed if script will be given no arguments or some option or argument will have wrong syntax.

Inkscape will create a GUI form with widgets for all specified options and prefill them with specified default values using ''.inx''. file for this extenstion which we will write later.

We need to override only one ''Effect'' class method to provide effect functionality:
<pre>
def effect(self):
what = self.options.what
</pre>

As you can mention we just stored ''--what'' option value to ''what'' variable.

Now we will finally start to do something. We will work with XML representation of SVG document via ''self.document'' attribute. It is of ''Document'' class type from ''xml.dom'' module. Complete documentation for this module can be found at http://docs.python.org/lib/module-xml.dom.html.

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

<pre>
svg = self.document.getElementsByTagName('svg')[0]
width = inkex.unittouu(svg.getAttribute('width'))
height = inkex.unittouu(svg.getAttribute('height'))
</pre>

Function ''getElementsByTagName'' returns list of all found elements of this name so we just use first of them.

Create SVG group element and "convert" it to layer using Inkscape SVG extenstions:

<pre>
layer = self.document.createElement('g')
layer.setAttribute('inkscape:label', 'Hello %s Layer' % (what))
layer.setAttribute('inkscape:groupmode', 'layer')
</pre>

Create SVG text element and its value containing "Hello World"" string:

<pre>
text = self.document.createElement('text')
value = self.document.createTextNode('Hello %s!' % (what))
</pre>

Set position of text to center of SVG document:

<pre>
text.setAttribute('x', str(width / 2))
text.setAttribute('y', str(height / 2))
</pre>

If we want center text on its position we will define CSS style of SVG ''text'' element. Actually use ''text-anchor'' SVG extension to CSS styles to do that work:

<pre>
style = {'text-align' : 'center', 'text-anchor' : 'middle'}
text.setAttribute('style', formatStyle(style))
</pre>

Finally connect all created elements together and put them in SVG document:

<pre>
text.appendChild(value)
layer.appendChild(text)
svg.appendChild(layer)
</pre>

We just defined a class of our effect extension so we have to create an instance of it and execute it in main control flow:

<pre>
effect = HelloWorldEffect()
effect.affect()
</pre>

== Extension Description File ==

To include script in Inkscape's main menu create ''hello_world.inx'' file describing script evokation.

<pre>
<inkscape-extension>
<_name>Hello World!</_name>
<id>org.ekips.filter.hello_world</id>
<dependency type="executable" location="extensions">hello_world.py</dependency>
<dependency type="executable" location="extensions">inkex.py</dependency>
<param name="what" type="string" _gui-text="What would you like to greet?">World</param>
<effect>
<object-type>all</object-type>
<effects-menu>
<submenu _name="Examples"/>
</effects-menu>
</effect>
<script>
<command reldir="extensions" interpreter="python">hello_world.py</command>
</script>
</inkscape-extension>
</pre>

Create ''<param>'' element for every option of a script and ''<dependency>'' for every included module which is not from Python standard library. Inkscape will search for this modules in directory with script. ''<effect>'' element and its descendants defines name of menu item evoking our new "Hello World!" extension.

If the inx file isn't well formed or if any of the dependencies wasn't met, the extension won't show up in the menu. If your extension doesn't show up, take a look at extension-errors.log, which may give you a hint why it wasn't loaded.

== Installation ==

To install a new extenstion just put ''hello_world.py'' and ''hello_world.inx'' files with all dependency modules to ''<path_to_inkscape>/extensions'' or ''~/.inkscape/extensions'' directory and start Inkscape. A new menu item ''Hello World!'' in ''Effects->Examples'' menu should appear.

== Complete Source Code ==

Here is a complete commented source pre of ''hello_world.py'' script file:

<pre>
#!/usr/bin/env python

# We will use inex module with predefined effect base class.
import inkex
# simplestyle module provides functions for style parsing.
from simplestyle import *

""" Example Inkscape effect extension.
Creates a new layer with "Hello World!" text centered in middle of document."""
class HelloWorldEffect(inkex.Effect):
""" Constructor.
Defines "--what" option of a script."""
def __init__(self):
# Call base class construtor.
inkex.Effect.__init__(self)

# Define string option "--what" with "-w" shortcut and default value "World".
self.OptionParser.add_option('-w', '--what', action = 'store',
type = 'string', dest = 'what', default = 'World',
help = 'What would you like to greet?')

""" Effect behaviour.
Overrides base class' method and insert "Hello World" text in SVG document. """
def effect(self):
# Get script "--what" option value.
what = self.options.what

# Get access to main SVG document element and get its dimensions.
svg = self.document.getElementsByTagName('svg')[0]
width = inkex.unittouu(svg.getAttribute('width'))
height = inkex.unittouu(svg.getAttribute('height'))

# Create a new layer.
layer = self.document.createElement('g')
layer.setAttribute('inkscape:label', 'Hello %s Layer' % (what))
layer.setAttribute('inkscape:groupmode', 'layer')

# Create text element
text = self.document.createElement('text')
value = self.document.createTextNode('Hello %s!' % (what))

# Set text position to center of document.
text.setAttribute('x', str(width / 2))
text.setAttribute('y', str(height / 2))

# Center text horizontally with CSS style.
style = {'text-align' : 'center', 'text-anchor': 'middle'}
text.setAttribute('style', formatStyle(style))

# Connect elements together.
text.appendChild(value)
layer.appendChild(text)
svg.appendChild(layer)

# Create effect instance and apply it.
effect = HelloWorldEffect()
effect.affect()
</pre>

[[User:Blackhex|Blackhex]] 11:59, 26 April 2007 (UTC)

PythonEffectTutorial

2007-04-26T11:59:40Z

Blackhex: Initial page content.

Effect extensions in Inkscape means a simple programs or scripts that reads input SVG file transforms it somehow and prints it to the standart output.

We will write simple effect extension script in Python that will put "Hello World!" or "Hello <value of option>!" string in the center of document and inside a new layer.

== Effect Extension Script ==

First of all create file ''hello_world.py'' and make them executable with Python interpreter with well-known directive:

<pre>
#!/usr/bin/env python
</pre>

Import ''inkex.py'' file with ''Effect'' base class that will do most of work for us and ''simplestyle.py'' module with support functions for working with CSS styles. We will use just ''formatStyle'' function from this module:

<pre>
import inkex
from simplestyle import *
</pre>

Declare ''HelloWordEffect'' class and write a constructor where base class is initialized and script option for opition parser is defined:

<pre>
class HelloWorldEffect(inkex.Effect):
def __init__(self):
inkex.Effect.__init__(self)
self.OptionParser.add_option('-w', '--what', action = 'store',
type = 'string', dest = 'what', default = 'World',
help = 'What would you like to greet?')
</pre>

Complete documentation for ''OptionParser'' class can be found at http://docs.python.org/lib/module-optparse.html. Here we just use ''add_option'' method which has as first argument short option name, as second argument 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.
* ''type'' - Type of option value. We use string here.
* ''dest'' - Destination of option action specified by ''action'' argument. Using ''what'' value we say that we want to store option value to self.options.what attribute.
* ''default'' - Defalut value for this option if it is not specified.
* ''help'' - A help string that will be displayed if script will be given no arguments or some option or argument will have wrong syntax.

Inkscape will create a GUI form with widgets for all specified options and prefill them with specified default values using ''.inx''. file for this extenstion which we will write later.

We need to override only one ''Effect'' class method to provide effect functionality:
<pre>
def effect(self):
what = self.options.what
</pre>

As you can mention we just stored ''--what'' option value to ''what'' variable.

Now we will finally start to do something. We will work with XML representation of SVG document via ''self.document'' attribute. It is of ''Document'' class type from ''xml.dom'' module. Complete documentation for this module can be found at http://docs.python.org/lib/module-xml.dom.html.

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

<pre>
svg = self.document.getElementsByTagName('svg')[0]
width = parseLength(svg.getAttribute('width'))[0]
height = parseLength(svg.getAttribute('height'))[0]
</pre>

Function ''getElementsByTagName'' returns list of all found elements of this name so we just use first of them.

We used ''parseLength'' function which returns tuple with float value and string with unit from its parameter containg CSS lenght type value (for example: 10px, 10pt, 10, 10cm, ...). Function will be defined later.

Create SVG group element and "convert" it to layer using Inkscape SVG extenstions:

<pre>
layer = self.document.createElement('g')
layer.setAttribute('inkscape:label', 'Hello %s Layer' % (what))
layer.setAttribute('inkscape:groupmode', 'layer')
</pre>

Create SVG text element and its value containing "Hello World"" string:

<pre>
text = self.document.createElement('text')
value = self.document.createTextNode('Hello %s!' % (what))
</pre>

Set position of text to center of SVG document:

<pre>
text.setAttribute('x', str(width / 2))
text.setAttribute('y', str(height / 2))
</pre>

If we want center text on its position we will define CSS style of SVG ''text'' element. Actually use ''text-anchor'' SVG extension to CSS styles to do that work:

<pre>
style = {'text-align' : 'center', 'text-anchor' : 'middle'}
text.setAttribute('style', formatStyle(style))
</pre>

Finally connect all created elements together and put them in SVG document:

<pre>
text.appendChild(value)
layer.appendChild(text)
svg.appendChild(layer)
</pre>

We just defined a class of our effect extension so we have to create an instance of it and execute it in main control flow:

<pre>
effect = HelloWorldEffect()
effect.affect()
</pre>

As mentioned before we need to define ''parseLength'' function. Probably this kind of function and other similar should be a part of a new support module for extensions creating:

<pre>
def parseLength(length):
if len(length) >= 1:
if length[-1:] == '%':
return (float(length[:-1]), length[-1:])
if len(length) >= 2:
if length[-2:] in ('px', 'pt', 'em', 'cm', 'mm'):
return (float(length[:-2]), length[-2:])
return (float(length), '')
</pre>

== Extension Description File ==

To include script in Inkscape's main menu create ''hello_world.inx'' file describing script evokation.

<pre>
<inkscape-extension>
<_name>Hello World!</_name>
<id>org.ekips.filter.hello_world</id>
<dependency type="executable" location="extensions">hello_world.py</dependency>
<dependency type="executable" location="extensions">inkex.py</dependency>
<param name="what" type="string" _gui-text="What would you like to greet?">World</param>
<effect>
<object-type>all</object-type>
<effects-menu>
<submenu _name="Examples"/>
</effects-menu>
</effect>
<script>
<command reldir="extensions" interpreter="python">hello_world.py</command>
</script>
</inkscape-extension>
</pre>

Create ''<param>'' element for every option of a script and ''<dependency>'' for every included module which is not from Python standard library. Inkscape will search for this modules in directory with script. ''<effect>'' element and its descendants defines name of menu item evoking our new "Hello World!" extension.

== Installation ==

To install a new extenstion just put ''hello_world.py'' and ''hello_world.inx'' files with all dependency modules to ''<path_to_inkscape>/extensions'' or ''~/.inkscape/extensions'' directory and start Inkscape. A new menu item ''Hello World!'' in ''Effects->Examples'' menu should appear.

[[User:Blackhex|Blackhex]] 11:59, 26 April 2007 (UTC)

PythonEffectTutorial

2007-04-25T21:34:53Z

Blackhex: Just creating a page.

Here will be tutorial about making a new Inkscape effects in Python.