Inkscape Wiki - User contributions [en]

INX extension descriptor format

2010-11-05T23:19:55Z

Flor: /* Translation of extensions */

== 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.

== Translation of extensions ==

Extension dialog windows, described in ING files, can be prepared for translation or localisation by adding an <code>_</code> (underscore) to the XML tags or attributes. Only add underscores when text need to be translated (not numeric values, for example!).

Example:
<code><pre>
<_name>Some translatable extension name</_name>
</pre></code>

Or:
<code><pre>
<param name="..." type="..." _gui-text="Some translatable label text">
</pre></code>

When extensions are included in the [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/share/extensions/ Inkscape BZR Repository], various scripts will scan each ING file for translatable text and prepare [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/po/ translation files] for others to translate.

See also: [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://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/share/extensions/ BZR repository].

<small><code><pre>
<?xml version="1.0" encoding="UTF-8"?>
<inkscape-extension xmlns="http://www.inkscape.org/namespace/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></code></small>

== DTD XML schema==
The following XML schema may not fully describe the current ING file structure. The actual XML schema used is described in the [[INX extension descriptor format#RELAX NG XML schema|next paragraph]].
<small><code><pre>
<!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|submenu?)>
<!ELEMENT script (command, helper_extension*, check*)>
<!ELEMENT plugin (name)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT id (#PCDATA)>
<!ELEMENT item (#PCDATA)>
<!ELEMENT option (#PCDATA)>
<!ELEMENT dependency (#PCDATA)>
<!ELEMENT param (#PCDATA|page|item|option)*>
<!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 effect needs-live-preview (true|false) #REQUIRED>
<!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|optiongroup|color) #REQUIRED>
<!ATTLIST param min CDATA #IMPLIED>
<!ATTLIST param max CDATA #IMPLIED>
<!ATTLIST param max_length CDATA #IMPLIED>
<!ATTLIST param precision CDATA #IMPLIED>
<!ATTLIST param gui-text CDATA #IMPLIED>
<!ATTLIST param gui-tip CDATA #IMPLIED>
<!ATTLIST param gui-description CDATA #IMPLIED>
<!ATTLIST param scope CDATA #IMPLIED>
<!ATTLIST param gui-hidden CDATA #IMPLIED>
<!ATTLIST param appearance (minimal|) "">
<!ATTLIST submenu name CDATA #REQUIRED>
</pre></code></small>

== RELAX NG XML schema ==
The XML schema for ING files is available in the [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head%3A/share/extensions/inkscape.extension.rng Inkscape BZR repository]. This is a [http://www.relaxng.org/ RELAX NG schema].

A compactly formatted version of the schema (created on 2 November 2010 using [http://www.thaiopensource.com/relaxng/trang.html Trang]):
<small><code><pre>
default namespace =
"http://www.inkscape.org/namespace/inkscape/extension"

start =
element inkscape-extension {
element _name { text },
element id { text },
element dependency {
attribute type { inx.dependency-type.values },
attribute location { inx.location.values }?,
attribute _description { text }?,
text
}*,
(inx.parameters
| element param {
attribute name { text },
attribute type { "notebook" },
element page {
attribute name { text },
attribute _gui-text { text },
inx.parameters+
}+
})*,
(element input {
inx.io.common,
element output_extension { text }?
}
| element output {
inx.io.common,
element dataloss { xsd:boolean }?
}
| element effect {
attribute needs-document { xsd:boolean }?,
attribute needs-live-preview { xsd:boolean }?,
element object-type {
xsd:token "all" | xsd:token "path" | xsd:token "rect"
},
element effects-menu {
attribute hidden { xsd:boolean "true" }
| element submenu {
attribute _name { text },
empty
}
}
}
| element path-effect { empty }
| element print { empty }),
(element script {
element command {
inx.reldir.attr,
attribute interpreter { "python" | "perl" }?,
text
},
element helper_extension { xsd:NMTOKEN }?,
element check { inx.reldir.attr, text }*
}
| element xslt {
element file { inx.reldir.attr, text }
}
| element plugin {
element name { text }
})
}
inx.reldir.attr = attribute reldir { inx.location.values }
inx.location.values = "extensions" | "path" | "plugins"
inx.dependency-type.values = "extension" | "executable" | "plugin"
inx.io.common =
element extension { text },
element mimetype { text },
element _filetypename { text }?,
element _filetypetooltip { text }?
inx.parameter =
attribute name { xsd:token },
attribute gui-hidden { xsd:boolean }?,
attribute _gui-text { text }?,
((attribute type { "int" },
attribute min { xsd:integer }?,
attribute max { xsd:integer }?,
(empty | xsd:integer))
| (attribute type { "float" },
attribute precision { xsd:integer }?,
attribute min { xsd:float }?,
attribute max { xsd:float }?,
xsd:float)
| (attribute type { "boolean" },
xsd:boolean)
| (attribute type { "string" },
attribute max_length { xsd:integer }?,
(empty | text))
| (attribute type { "description" },
text)
| (attribute type { "enum" },
(element _item { inx.parameter.enum.item }
| element item { inx.parameter.enum.item })+)
| (attribute type { "optiongroup" },
attribute appearance { "minimal" }?,
(element option { inx.parameter.optiongroup.option }
| element _option { inx.parameter.optiongroup.option })+))
inx.parameters =
element param { inx.parameter }
| element _param { inx.parameter }
inx.parameter.enum.item =
attribute value { text },
xsd:token
inx.parameter.optiongroup.option =
attribute value { text }?,
text
</pre></code></small>

== See Also ==
*[[INX Parameters]]
*[[ScriptingHOWTO]]

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

INX extension descriptor format

2010-11-05T22:34:45Z

Flor: /* DTD */

== 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 parameters has to have "_" prepended to their name, e.g. <tt><_name>name of extension</_name></tt>

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

Useful 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://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/share/extensions/ BZR repository].

<small><code><pre>
<?xml version="1.0" encoding="UTF-8"?>
<inkscape-extension xmlns="http://www.inkscape.org/namespace/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></code></small>

== DTD XML schema==
The following XML schema may not fully describe the current ING file structure. The actual XML schema used is described in the [[INX extension descriptor format#RELAX NG XML schema|next paragraph]].
<small><code><pre>
<!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|submenu?)>
<!ELEMENT script (command, helper_extension*, check*)>
<!ELEMENT plugin (name)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT id (#PCDATA)>
<!ELEMENT item (#PCDATA)>
<!ELEMENT option (#PCDATA)>
<!ELEMENT dependency (#PCDATA)>
<!ELEMENT param (#PCDATA|page|item|option)*>
<!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 effect needs-live-preview (true|false) #REQUIRED>
<!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|optiongroup|color) #REQUIRED>
<!ATTLIST param min CDATA #IMPLIED>
<!ATTLIST param max CDATA #IMPLIED>
<!ATTLIST param max_length CDATA #IMPLIED>
<!ATTLIST param precision CDATA #IMPLIED>
<!ATTLIST param gui-text CDATA #IMPLIED>
<!ATTLIST param gui-tip CDATA #IMPLIED>
<!ATTLIST param gui-description CDATA #IMPLIED>
<!ATTLIST param scope CDATA #IMPLIED>
<!ATTLIST param gui-hidden CDATA #IMPLIED>
<!ATTLIST param appearance (minimal|) "">
<!ATTLIST submenu name CDATA #REQUIRED>
</pre></code></small>

== RELAX NG XML schema ==
The XML schema for ING files is available in the [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head%3A/share/extensions/inkscape.extension.rng Inkscape BZR repository]. This is a [http://www.relaxng.org/ RELAX NG schema].

A compactly formatted version of the schema (created on 2 November 2010 using [http://www.thaiopensource.com/relaxng/trang.html Trang]):
<small><code><pre>
default namespace =
"http://www.inkscape.org/namespace/inkscape/extension"

start =
element inkscape-extension {
element _name { text },
element id { text },
element dependency {
attribute type { inx.dependency-type.values },
attribute location { inx.location.values }?,
attribute _description { text }?,
text
}*,
(inx.parameters
| element param {
attribute name { text },
attribute type { "notebook" },
element page {
attribute name { text },
attribute _gui-text { text },
inx.parameters+
}+
})*,
(element input {
inx.io.common,
element output_extension { text }?
}
| element output {
inx.io.common,
element dataloss { xsd:boolean }?
}
| element effect {
attribute needs-document { xsd:boolean }?,
attribute needs-live-preview { xsd:boolean }?,
element object-type {
xsd:token "all" | xsd:token "path" | xsd:token "rect"
},
element effects-menu {
attribute hidden { xsd:boolean "true" }
| element submenu {
attribute _name { text },
empty
}
}
}
| element path-effect { empty }
| element print { empty }),
(element script {
element command {
inx.reldir.attr,
attribute interpreter { "python" | "perl" }?,
text
},
element helper_extension { xsd:NMTOKEN }?,
element check { inx.reldir.attr, text }*
}
| element xslt {
element file { inx.reldir.attr, text }
}
| element plugin {
element name { text }
})
}
inx.reldir.attr = attribute reldir { inx.location.values }
inx.location.values = "extensions" | "path" | "plugins"
inx.dependency-type.values = "extension" | "executable" | "plugin"
inx.io.common =
element extension { text },
element mimetype { text },
element _filetypename { text }?,
element _filetypetooltip { text }?
inx.parameter =
attribute name { xsd:token },
attribute gui-hidden { xsd:boolean }?,
attribute _gui-text { text }?,
((attribute type { "int" },
attribute min { xsd:integer }?,
attribute max { xsd:integer }?,
(empty | xsd:integer))
| (attribute type { "float" },
attribute precision { xsd:integer }?,
attribute min { xsd:float }?,
attribute max { xsd:float }?,
xsd:float)
| (attribute type { "boolean" },
xsd:boolean)
| (attribute type { "string" },
attribute max_length { xsd:integer }?,
(empty | text))
| (attribute type { "description" },
text)
| (attribute type { "enum" },
(element _item { inx.parameter.enum.item }
| element item { inx.parameter.enum.item })+)
| (attribute type { "optiongroup" },
attribute appearance { "minimal" }?,
(element option { inx.parameter.optiongroup.option }
| element _option { inx.parameter.optiongroup.option })+))
inx.parameters =
element param { inx.parameter }
| element _param { inx.parameter }
inx.parameter.enum.item =
attribute value { text },
xsd:token
inx.parameter.optiongroup.option =
attribute value { text }?,
text
</pre></code></small>

== See Also ==
*[[INX Parameters]]
*[[ScriptingHOWTO]]

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

INX extension descriptor format

2010-11-05T22:26:12Z

Flor: /* RELAX NG XML schema */

== 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 parameters has to have "_" prepended to their name, e.g. <tt><_name>name of extension</_name></tt>

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

Useful 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://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/share/extensions/ BZR repository].

<small><code><pre>
<?xml version="1.0" encoding="UTF-8"?>
<inkscape-extension xmlns="http://www.inkscape.org/namespace/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></code></small>

== DTD ==
<small><code><pre>
<!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|submenu?)>
<!ELEMENT script (command, helper_extension*, check*)>
<!ELEMENT plugin (name)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT id (#PCDATA)>
<!ELEMENT item (#PCDATA)>
<!ELEMENT option (#PCDATA)>
<!ELEMENT dependency (#PCDATA)>
<!ELEMENT param (#PCDATA|page|item|option)*>
<!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 effect needs-live-preview (true|false) #REQUIRED>
<!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|optiongroup|color) #REQUIRED>
<!ATTLIST param min CDATA #IMPLIED>
<!ATTLIST param max CDATA #IMPLIED>
<!ATTLIST param max_length CDATA #IMPLIED>
<!ATTLIST param precision CDATA #IMPLIED>
<!ATTLIST param gui-text CDATA #IMPLIED>
<!ATTLIST param gui-tip CDATA #IMPLIED>
<!ATTLIST param gui-description CDATA #IMPLIED>
<!ATTLIST param scope CDATA #IMPLIED>
<!ATTLIST param gui-hidden CDATA #IMPLIED>
<!ATTLIST param appearance (minimal|) "">
<!ATTLIST submenu name CDATA #REQUIRED>
</pre></code></small>

== RELAX NG XML schema ==
The XML schema for ING files is available in the [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head%3A/share/extensions/inkscape.extension.rng Inkscape BZR repository]. This is a [http://www.relaxng.org/ RELAX NG schema].

A compactly formatted version of the schema (created on 2 November 2010 using [http://www.thaiopensource.com/relaxng/trang.html Trang]):
<small><code><pre>
default namespace =
"http://www.inkscape.org/namespace/inkscape/extension"

start =
element inkscape-extension {
element _name { text },
element id { text },
element dependency {
attribute type { inx.dependency-type.values },
attribute location { inx.location.values }?,
attribute _description { text }?,
text
}*,
(inx.parameters
| element param {
attribute name { text },
attribute type { "notebook" },
element page {
attribute name { text },
attribute _gui-text { text },
inx.parameters+
}+
})*,
(element input {
inx.io.common,
element output_extension { text }?
}
| element output {
inx.io.common,
element dataloss { xsd:boolean }?
}
| element effect {
attribute needs-document { xsd:boolean }?,
attribute needs-live-preview { xsd:boolean }?,
element object-type {
xsd:token "all" | xsd:token "path" | xsd:token "rect"
},
element effects-menu {
attribute hidden { xsd:boolean "true" }
| element submenu {
attribute _name { text },
empty
}
}
}
| element path-effect { empty }
| element print { empty }),
(element script {
element command {
inx.reldir.attr,
attribute interpreter { "python" | "perl" }?,
text
},
element helper_extension { xsd:NMTOKEN }?,
element check { inx.reldir.attr, text }*
}
| element xslt {
element file { inx.reldir.attr, text }
}
| element plugin {
element name { text }
})
}
inx.reldir.attr = attribute reldir { inx.location.values }
inx.location.values = "extensions" | "path" | "plugins"
inx.dependency-type.values = "extension" | "executable" | "plugin"
inx.io.common =
element extension { text },
element mimetype { text },
element _filetypename { text }?,
element _filetypetooltip { text }?
inx.parameter =
attribute name { xsd:token },
attribute gui-hidden { xsd:boolean }?,
attribute _gui-text { text }?,
((attribute type { "int" },
attribute min { xsd:integer }?,
attribute max { xsd:integer }?,
(empty | xsd:integer))
| (attribute type { "float" },
attribute precision { xsd:integer }?,
attribute min { xsd:float }?,
attribute max { xsd:float }?,
xsd:float)
| (attribute type { "boolean" },
xsd:boolean)
| (attribute type { "string" },
attribute max_length { xsd:integer }?,
(empty | text))
| (attribute type { "description" },
text)
| (attribute type { "enum" },
(element _item { inx.parameter.enum.item }
| element item { inx.parameter.enum.item })+)
| (attribute type { "optiongroup" },
attribute appearance { "minimal" }?,
(element option { inx.parameter.optiongroup.option }
| element _option { inx.parameter.optiongroup.option })+))
inx.parameters =
element param { inx.parameter }
| element _param { inx.parameter }
inx.parameter.enum.item =
attribute value { text },
xsd:token
inx.parameter.optiongroup.option =
attribute value { text }?,
text
</pre></code></small>

== See Also ==
*[[INX Parameters]]
*[[ScriptingHOWTO]]

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

INX extension descriptor format

2010-11-05T22:24:41Z

Flor: /* RELAX NG XML Schema */

== 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 parameters has to have "_" prepended to their name, e.g. <tt><_name>name of extension</_name></tt>

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

Useful 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://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/files/head%3A/share/extensions/ BZR repository].

<small><code><pre>
<?xml version="1.0" encoding="UTF-8"?>
<inkscape-extension xmlns="http://www.inkscape.org/namespace/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></code></small>

== DTD ==
<small><code><pre>
<!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|submenu?)>
<!ELEMENT script (command, helper_extension*, check*)>
<!ELEMENT plugin (name)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT id (#PCDATA)>
<!ELEMENT item (#PCDATA)>
<!ELEMENT option (#PCDATA)>
<!ELEMENT dependency (#PCDATA)>
<!ELEMENT param (#PCDATA|page|item|option)*>
<!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 effect needs-live-preview (true|false) #REQUIRED>
<!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|optiongroup|color) #REQUIRED>
<!ATTLIST param min CDATA #IMPLIED>
<!ATTLIST param max CDATA #IMPLIED>
<!ATTLIST param max_length CDATA #IMPLIED>
<!ATTLIST param precision CDATA #IMPLIED>
<!ATTLIST param gui-text CDATA #IMPLIED>
<!ATTLIST param gui-tip CDATA #IMPLIED>
<!ATTLIST param gui-description CDATA #IMPLIED>
<!ATTLIST param scope CDATA #IMPLIED>
<!ATTLIST param gui-hidden CDATA #IMPLIED>
<!ATTLIST param appearance (minimal|) "">
<!ATTLIST submenu name CDATA #REQUIRED>
</pre></code></small>

== RELAX NG XML schema ==
The XML schema for ING files is [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head%3A/share/extensions/inkscape.extension.rng available as part of the source code]. This is a [http://www.relaxng.org/ RELAX NG schema].

A compactly formatted version of the schema (created on 2 November 2010 using [http://www.thaiopensource.com/relaxng/trang.html Trang]):
<small><code><pre>
default namespace =
"http://www.inkscape.org/namespace/inkscape/extension"

start =
element inkscape-extension {
element _name { text },
element id { text },
element dependency {
attribute type { inx.dependency-type.values },
attribute location { inx.location.values }?,
attribute _description { text }?,
text
}*,
(inx.parameters
| element param {
attribute name { text },
attribute type { "notebook" },
element page {
attribute name { text },
attribute _gui-text { text },
inx.parameters+
}+
})*,
(element input {
inx.io.common,
element output_extension { text }?
}
| element output {
inx.io.common,
element dataloss { xsd:boolean }?
}
| element effect {
attribute needs-document { xsd:boolean }?,
attribute needs-live-preview { xsd:boolean }?,
element object-type {
xsd:token "all" | xsd:token "path" | xsd:token "rect"
},
element effects-menu {
attribute hidden { xsd:boolean "true" }
| element submenu {
attribute _name { text },
empty
}
}
}
| element path-effect { empty }
| element print { empty }),
(element script {
element command {
inx.reldir.attr,
attribute interpreter { "python" | "perl" }?,
text
},
element helper_extension { xsd:NMTOKEN }?,
element check { inx.reldir.attr, text }*
}
| element xslt {
element file { inx.reldir.attr, text }
}
| element plugin {
element name { text }
})
}
inx.reldir.attr = attribute reldir { inx.location.values }
inx.location.values = "extensions" | "path" | "plugins"
inx.dependency-type.values = "extension" | "executable" | "plugin"
inx.io.common =
element extension { text },
element mimetype { text },
element _filetypename { text }?,
element _filetypetooltip { text }?
inx.parameter =
attribute name { xsd:token },
attribute gui-hidden { xsd:boolean }?,
attribute _gui-text { text }?,
((attribute type { "int" },
attribute min { xsd:integer }?,
attribute max { xsd:integer }?,
(empty | xsd:integer))
| (attribute type { "float" },
attribute precision { xsd:integer }?,
attribute min { xsd:float }?,
attribute max { xsd:float }?,
xsd:float)
| (attribute type { "boolean" },
xsd:boolean)
| (attribute type { "string" },
attribute max_length { xsd:integer }?,
(empty | text))
| (attribute type { "description" },
text)
| (attribute type { "enum" },
(element _item { inx.parameter.enum.item }
| element item { inx.parameter.enum.item })+)
| (attribute type { "optiongroup" },
attribute appearance { "minimal" }?,
(element option { inx.parameter.optiongroup.option }
| element _option { inx.parameter.optiongroup.option })+))
inx.parameters =
element param { inx.parameter }
| element _param { inx.parameter }
inx.parameter.enum.item =
attribute value { text },
xsd:token
inx.parameter.optiongroup.option =
attribute value { text }?,
text
</pre></code></small>

== See Also ==
*[[INX Parameters]]
*[[ScriptingHOWTO]]

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

Script extensions

2010-11-02T12:28:44Z

Flor: /* Important Tips */

[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 ==

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

== Script functions ==

There are three kinds of functions that can be 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.

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

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 <code>xml:space="preserve"</code> area.
* Send error text to the error output and help the user.

== Extension description file ==

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 you to:
* Define the script file and other dependencies.
* List all parameters and their types (to generate an input dialog window).
* Mark dialog window text for translation.
* Define an Inkscape menu entry.
* Chain extensions.

See [[INX extension descriptor format]] for help creating an INX file.

=== 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 to the script as <code>--paramname=paramvalue</code>. Specify the script file to be run with the <code><command></code> tag.

For example, if you have described a string parameter with name <code>string1</code> in the INX file, Inkscape will present a textbox to the user. When the user fills in <code>text</code> and presses Apply, it will pass <code>--string1="text"</code> to the script.

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

* String (textbox)
* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* Enum (drop down selection list)
* Option group (radio buttons)
* Notebook (pages/tabs)
* Description (not a parameter, provides static text)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

== 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/.config/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 separate 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 ==

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

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

*[[PythonEffectTutorial]]

*[[Tips For Python Script Extensions]]

[[Category:Developer Documentation]]
[[Category:Extensions]]

Script extensions

2010-11-02T12:27:28Z

Flor: /* Interaction */

[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 ==

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

== Script functions ==

There are three kinds of functions that can be 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.

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

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.

== Extension description file ==

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 you to:
* Define the script file and other dependencies.
* List all parameters and their types (to generate an input dialog window).
* Mark dialog window text for translation.
* Define an Inkscape menu entry.
* Chain extensions.

See [[INX extension descriptor format]] for help creating an INX file.

=== 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 to the script as <code>--paramname=paramvalue</code>. Specify the script file to be run with the <code><command></code> tag.

For example, if you have described a string parameter with name <code>string1</code> in the INX file, Inkscape will present a textbox to the user. When the user fills in <code>text</code> and presses Apply, it will pass <code>--string1="text"</code> to the script.

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

* String (textbox)
* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* Enum (drop down selection list)
* Option group (radio buttons)
* Notebook (pages/tabs)
* Description (not a parameter, provides static text)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

== 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/.config/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 separate 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 ==

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

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

*[[PythonEffectTutorial]]

*[[Tips For Python Script Extensions]]

[[Category:Developer Documentation]]
[[Category:Extensions]]

Script extensions

2010-11-02T12:24:07Z

Flor:

[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 ==

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

== Script functions ==

There are three kinds of functions that can be 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.

== Extension description file ==

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 you to:
* Define the script file and other dependencies.
* List all parameters and their types (to generate an input dialog window).
* Mark dialog window text for translation.
* Define an Inkscape menu entry.
* Chain extensions.

See [[INX extension descriptor format]] for help creating an INX file.

=== 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 to the script as <code>--paramname=paramvalue</code>. Specify the script file to be run with the <code><command></code> tag.

For example, if you have described a string parameter with name <code>string1</code> in the INX file, Inkscape will present a textbox to the user. When the user fills in <code>text</code> and presses Apply, it will pass <code>--string1="text"</code> to the script.

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

* String (textbox)
* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* Enum (drop down selection list)
* Option group (radio buttons)
* Notebook (pages/tabs)
* Description (not a parameter, provides static text)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

== 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/.config/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 separate 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 ==

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

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

*[[PythonEffectTutorial]]

*[[Tips For Python Script Extensions]]

[[Category:Developer Documentation]]
[[Category:Extensions]]

Generating objects from extensions

2010-11-02T08:54:07Z

Flor: /* Line Segment */

If you need an extension to generate an object in Inkscape, there are many tools that already exist to help you. <tt>inkex.py</tt> is the most notable, as this provides the routines to insert the SVG element into the XML tree of the SVG document.

There is currently no universal set of tools to allow a single function to be called, because different extension have different attibutes for thir objects. For example, the barcode extension merely needs a black rectangle with no stroke, but another may need a way to set the stroke width, dashes and opacity. Thus, it is often best to write your own subroutine for generating your objects.

==A simple example==
Let's look at a simple Python function for drawing a black rectangle:
<pre>
#SVG element generation routine
def draw_SVG_square((w,h), (x,y), parent):

style = { 'stroke' : 'none',
'width' : '1',
'fill' : '#000000'
}

attribs = {
'style' : simplestyle.formatStyle(style),
'height' : str(h),
'width' : str(w),
'x' : str(x),
'y' : str(y)
}
circ = inkex.etree.SubElement(parent, inkex.addNS('rect','svg'), attribs )
</pre>

The first thing to notice is that all the attributes of the object are stored in a dictionary format, with everything being a string. This means you have to convert all your parameters to strings if appropriate (like the <tt>height</tt> and <tt>width</tt> attributes).

Next, all the style attributes (colours, widths, fonts, etc) are put together in SVG under <tt>style</tt>. To generate this string, there exists a helper function <tt>simplestyle.formatStyle()</tt>. You simply feed this function a dictionary of the styles you want, just like the attributes. You can then use this directly as the style attribute.

The next thing to see is how to add the element to the XML tree. <tt>inkex.py</tt> has the function to do this using the LXML parser. This needs to be given the "parent" of the object (we'll come back to this), the "type" of the object, and the attributes of the object.

The type of the object is in the <tt>svg</tt> namespace, which means it begins <tt>svg:</tt> (for a rectangle, it is <tt>svg:rect</tt>). LXML cannot parse colons, so we use the <tt>inkex.addNS</tt> to prepend the namespace.

The attributes of the object just needs to be passed the dictionary <tt>attribs</tt> we made earlier.

The "parent" of the object is the containing element. This is usually a group or a layer. This will be passed in by the calling function, and we will see it in action later.

When this function is run with the right parameters, the rectangle will be added to the SVG document.

==Getting the parent==

Finding the parent is easy: you can just pass in the current layer from the <tt>self</tt> object if you like:
<pre><nowiki>
parent = self.current_layer
draw_SVG_square((1,1), (0,0), parent)
</nowiki></pre>

This will just plonk the rectangle into the document, centred on the origin.

Alternatively, you can create a group much like any other object:
<pre><nowiki>
centre = self.view_center #Put in in the centre of the current view
grp_transform = 'translate' + str( centre )

grp_name = 'Group Name'
grp_attribs = {inkex.addNS('label','inkscape'):grp_name,
'transform':grp_transform }
grp = inkex.etree.SubElement(self.current_layer, 'g', grp_attribs)#the group to put everything in
</nowiki></pre>

By the way, any object can be assigned a name as we did there, which is often helpful when generating many objects:

<pre><nowiki>
inkex.addNS('label','inkscape') : name
</nowiki></pre>

By setting the transform as <tt>self.view_center</tt>, we made sure the origin of the group is in the centre of the current view of the document. We will come back to transforms later.

The <tt>grp</tt> object can now be used as a parent for the rectangle:
<pre><nowiki>
draw_SVG_square((1,1), (0,0), grp)
</nowiki></pre>
This will draw a 1×1 black square in the center of the view.

==Transforms==

It is easy to transform an object: just supply a string like the folllowing as the <tt>transform</tt> attribute of the element:
*<tt>trans = 'translate(10,10)'</tt>
*<tt>trans = 'translate(10,10) rotate(10)'</tt>
*<tt>trans = 'skewX(-1)'</tt>

Available commands: <tt>translate, scale, rotate, skewX, skewY, matrix</tt>. The transforms are composed in left-right order (i.e. the translate comes first in the second example).

==More Examples==

===Ellipses===

Ellipses are actually path elements, but Inkscape generates the nodes automatically if you feed it the correct attributes in the Sodipodi namespace. The vital ones are <tt>rx, ry, cx, cy</tt>.

Ellipses require some attributes in the <tt>sodipodi:</tt> namespace, so we also use the <tt>addNS()</tt> function in the attribute dictionary:

<pre><nowiki>
def draw_SVG_ellipse((rx, ry), (cx, cy), parent, start_end=0,2*pi),transform='' ):

style = { 'stroke' : '#000000',
'width' : '1',
'fill' : 'none' }
ell_attribs = {'style':simplestyle.formatStyle(style),
inkex.addNS('cx','sodipodi') :str(cx),
inkex.addNS('cy','sodipodi') :str(cy),
inkex.addNS('rx','sodipodi') :str(rx),
inkex.addNS('ry','sodipodi') :str(ry),
inkex.addNS('start','sodipodi') :str(start_end[0]),
inkex.addNS('end','sodipodi') :str(start_end[1]),
inkex.addNS('open','sodipodi') :'true', #all ellipse sectors we will draw are open
inkex.addNS('type','sodipodi') :'arc',
'transform' :transform

}
ell = inkex.etree.SubElement(parent, inkex.addNS('path','svg'), ell_attribs )
</nowiki></pre>

This will draw an open arc, with a black stroke of width 1 and no fill. The transform here can be passed in from outside.

If in doubt about the right attribute name and format, just check a similar object in the XML viewer in Inkscape.

===Line Segment===

Paths can be quite tricky to get the hang of if you don't know the meaning of the letters. Read the SVG specification for a full list.

Here, the style information has been passed in from outside the function.

<pre><nowiki>
#draw an SVG line segment between the given (raw) points
def draw_SVG_line( (x1, y1), (x2, y2), style, name, parent):
line_style = { 'stroke': style.l_col,
'stroke-width':str(style.l_th),
'fill': style.l_fill
}

line_attribs = {'style' : simplestyle.formatStyle(line_style),
inkex.addNS('label','inkscape') : name,
'd' : 'M '+str(x1)+','+str(y1)+' L '+str(x2)+','+str(y2)}

line = inkex.etree.SubElement(parent, inkex.addNS('path','svg'), line_attribs )
</nowiki></pre>

[[Category:Developer Documentation]]
[[Category:Extensions]]

Script extensions

2010-11-02T08:44:26Z

Flor:

[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 ===

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

=== Script functions ===

There are three kinds of functions that can be 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.

=== Extension description file ===

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 you to:
* Define the script file and other dependencies.
* List all parameters and their types (to generate an input dialog window).
* Mark dialog window text for translation.
* Define an Inkscape menu entry.
* Chain extensions.

See [[INX extension descriptor format]] for help creating an INX file.

==== 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 to the script as <code>--paramname=paramvalue</code>. Specify the script file to be run with the <code><command></code> tag.

For example, if you have described a string parameter with name <code>string1</code> in the INX file, Inkscape will present a textbox to the user. When the user fills in <code>text</code> and presses Apply, it will pass <code>--string1="text"</code> to the script.

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

* String (textbox)
* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* Enum (drop down selection list)
* Option group (radio buttons)
* Notebook (pages/tabs)
* Description (not a parameter, provides static text)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

=== 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/.config/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 separate 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 ===

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

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

*[[PythonEffectTutorial]]

*[[Tips For Python Script Extensions]]

[[Category:Developer Documentation]]
[[Category:Extensions]]

Extensions: INX widgets and parameters

2010-11-02T08:43:37Z

Flor: /* notebook */

Here you will find the different parameter elements you may use in your .inx files (Inkscape Extensions)

== Introduction ==
Use parameter elements to capture user input for further use by a script. The basic structure of the element is:

<code><pre>
<param name="some_name" type="some_type">default value</param>
</pre></code>

The default value is the value that is shown in the input control the first time the user opens the dialog window. Inkscape automatically displays the values used last time when the dialog window is opened again.

==string==
A textbox to capture a '''character string'''.

Example:
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
</pre></code>

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the <code>min</code> and <code>max</code> attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the <code>min</code> and <code>max</code> attributes. To set the number of decimal places, use the <code>precision</code> attribute.

Example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==boolean==
Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.

Example:
<code><pre>
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
</pre></code>

==enum==
Creates a list of choices where the user can only select '''one option''' using a drop down select list.

Create the different choices with <code><item></code> elements. The first item is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected item'''.

Example:
<code><pre>
<param name="some_name" type="enum" _gui-text="Some label text">
<_item value="1">First option</_item>
<_item value="2">Second option</_item>
</param>
</pre></code>

==optiongroup==
Creates a list of choices where the user can only select '''one option'''. By default this is displayed as radiobuttons. Set the attribute <code>appearance="minimal"</code> to display a drop down select list instead.

Create the different choices with <code><option></code> elements. The first option is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.

Example:
<code><pre>
<param name="some_name" type="optiongroup" appearance="minimal" _gui-text="Some label text">
<_option value="1">First option</_option>
<_option value="2">Second option</_option>
</param>
</pre></code>

==color==
Creates a control to select a '''color'''.

The returned value is a RGBA-value.

Example:
<code><pre>
<param name="some_name" type="color"></param>
</pre></code>

==description==
To show some text in the dialog window, for example as "help" text.

Example:
<code><pre>
<param name="some_name" type="description"">Some text here.</param>
</pre></code>

==notebook==
Creates a '''set of pages''' or tab-sheets. Create individual pages with the <code><page></code> element.

The '''returned value''' for the notebook parameter element is the name of the '''selected''' page/tab.

Example:
<code><pre>
<param name="some_name" type="notebook">
<page name="name_page_1" _gui-text="First page">
<param>...</param>
</page>
<page name="name_page_2" _gui-text="Second page">
<param>...</param>
</page>
</param>
</pre></code>

[[Category:Developer Documentation]]
[[Category:Extensions]]

Extensions: INX widgets and parameters

2010-11-02T08:42:24Z

Flor:

Script extensions

2010-11-02T08:40:25Z

Flor: /* See Also */

[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 ===

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

=== Script functions ===

There are three kinds of functions that can be 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.

=== Extension description file ===

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 you to:
* Define the script file and other dependencies.
* List all parameters and their types (to generate an input dialog window).
* Mark dialog window text for translation.
* Define an Inkscape menu entry.
* Chain extensions.

See [[INX extension descriptor format]] for help creating an INX file.

==== 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 to the script as <code>--paramname=paramvalue</code>. Specify the script file to be run with the <code><command></code> tag.

For example, if you have described a string parameter with name <code>string1</code> in the INX file, Inkscape will present a textbox to the user. When the user fills in <code>text</code> and presses Apply, it will pass <code>--string1="text"</code> to the script.

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

* String (textbox)
* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* Enum (drop down selection list)
* Option group (radio buttons)
* Notebook (pages/tabs)
* Description (not a parameter, provides static text)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

=== 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/.config/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 separate 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 ===

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

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

*[[PythonEffectTutorial]]

*[[Tips For Python Script Extensions]]

[[Category:Extensions]]

Script extensions

2010-11-02T08:39:24Z

Flor: /* Parameters */

[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 ===

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

=== Script functions ===

There are three kinds of functions that can be 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.

=== Extension description file ===

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 you to:
* Define the script file and other dependencies.
* List all parameters and their types (to generate an input dialog window).
* Mark dialog window text for translation.
* Define an Inkscape menu entry.
* Chain extensions.

See [[INX extension descriptor format]] for help creating an INX file.

==== 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 to the script as <code>--paramname=paramvalue</code>. Specify the script file to be run with the <code><command></code> tag.

For example, if you have described a string parameter with name <code>string1</code> in the INX file, Inkscape will present a textbox to the user. When the user fills in <code>text</code> and presses Apply, it will pass <code>--string1="text"</code> to the script.

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

* String (textbox)
* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* Enum (drop down selection list)
* Option group (radio buttons)
* Notebook (pages/tabs)
* Description (not a parameter, provides static text)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

=== 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/.config/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 separate 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 ===

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

*[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]]

*[[Tips For Python Script Extensions]]

[[Category:Extensions]]

Script extensions

2010-11-02T08:38:21Z

Flor: /* Parameters */

[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 ===

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

=== Script functions ===

There are three kinds of functions that can be 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.

=== Extension description file ===

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 you to:
* Define the script file and other dependencies.
* List all parameters and their types (to generate an input dialog window).
* Mark dialog window text for translation.
* Define an Inkscape menu entry.
* Chain extensions.

See [[INX extension descriptor format]] for help creating an INX file.

==== 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 <code>--paramname=paramvalue</code>.

For example, if you have described a string parameter with name <code>string1</code> in the INX file, Inkscape will present a textbox to the user. When the user fills in <code>text</code> and presses Apply, it will pass <code>--string1="text"</code> to the script. Specify the script file to be run with the <code><command></code> tag.

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

* String (textbox)
* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* Enum (drop down selection list)
* Option group (radio buttons)
* Notebook (pages/tabs)
* Description (not a parameter, provides static text)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

=== 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/.config/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 separate 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 ===

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

*[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]]

*[[Tips For Python Script Extensions]]

[[Category:Extensions]]

Script extensions

2010-11-02T08:18:03Z

Flor: /* Parameters */

[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 ===

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

=== Script functions ===

There are three kinds of functions that can be 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.

=== Extension description file ===

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 you to:
* Define the script file and other dependencies.
* List all parameters and their types (to generate an input dialog window).
* Mark dialog window text for translation.
* Define an Inkscape menu entry.
* Chain extensions.

See [[INX extension descriptor format]] for help creating an INX file.

==== 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 <code>--paramname=paramvalue</code>.

For example, if you have described a string parameter with name <code>string1</code> in the INX file, Inkscape will present a textbox to the user. When the user fills in <code>text</code> and presses Apply, it will pass <code>--string1="text"</code> to the program specified by the <code><command></code> tag.

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

* String (textbox)
* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* Enum (drop down selection list)
* Option group (radio buttons)
* Notebook (pages/tabs)
* Description (not a parameter, provides static text)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

=== 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/.config/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 separate 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 ===

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

*[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]]

*[[Tips For Python Script Extensions]]

[[Category:Extensions]]

Script extensions

2010-11-02T08:12:19Z

Flor: /* Extension description file */

[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 ===

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

=== Script functions ===

There are three kinds of functions that can be 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.

=== Extension description file ===

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 you to:
* Define the script file and other dependencies.
* List all parameters and their types (to generate an input dialog window).
* Mark dialog window text for translation.
* Define an Inkscape menu entry.
* Chain extensions.

See [[INX extension descriptor format]] for help creating an INX file.

==== 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 <code>--paramname=paramvalue</code>. 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 <code>--string1="text"</code> to the program specified by the <command> tag.

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

* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* String (textbox)
* Description (static text)
* Enum (drop down selection list)
* Notebook (pages/tabs)
* Option group (radio buttons)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

=== 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/.config/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 separate 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 ===

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

*[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]]

*[[Tips For Python Script Extensions]]

[[Category:Extensions]]

Script extensions

2010-11-02T08:11:17Z

Flor: /* Extension description file */

[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 ===

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

=== Script functions ===

There are three kinds of functions that can be 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.

=== Extension description file ===

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:
* Define the script file and other dependencies.
* List all parameters and their types (this will generate an input dialog window).
* Mark dialog window text for translation.
* Define an Inkscape menu entry.
* Chain extensions.

See [[INX extension descriptor format]] for help creating an INX file.

==== 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 <code>--paramname=paramvalue</code>. 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 <code>--string1="text"</code> to the program specified by the <command> tag.

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

* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* String (textbox)
* Description (static text)
* Enum (drop down selection list)
* Notebook (pages/tabs)
* Option group (radio buttons)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

=== 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/.config/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 separate 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 ===

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

*[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]]

*[[Tips For Python Script Extensions]]

[[Category:Extensions]]

Script extensions

2010-11-02T08:06:12Z

Flor: /* Extension description file */

[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 ===

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

=== Script functions ===

There are three kinds of functions that can be 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.

=== Extension description file ===

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 [[INX extension descriptor format]] 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 <code>--paramname=paramvalue</code>. 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 <code>--string1="text"</code> to the program specified by the <command> tag.

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

* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* String (textbox)
* Description (static text)
* Enum (drop down selection list)
* Notebook (pages/tabs)
* Option group (radio buttons)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

=== 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/.config/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 separate 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 ===

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

*[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]]

*[[Tips For Python Script Extensions]]

[[Category:Extensions]]

Script extensions

2010-11-02T08:04:46Z

Flor: /* Types of scripts */

[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 ===

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

=== Script functions ===

There are three kinds of functions that can be 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.

=== Extension description file ===

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 <code>--paramname=paramvalue</code>. 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 <code>--string1="text"</code> to the program specified by the <command> tag.

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

* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* String (textbox)
* Description (static text)
* Enum (drop down selection list)
* Notebook (pages/tabs)
* Option group (radio buttons)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

=== 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/.config/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 separate 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 ===

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

*[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]]

*[[Tips For Python Script Extensions]]

[[Category:Extensions]]

Script extensions

2010-11-02T07:58:33Z

Flor: /* Description */

[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 ===

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

=== Types of scripts ===

There are three kinds of functions that can be 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.

=== Extension description file ===

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 <code>--paramname=paramvalue</code>. 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 <code>--string1="text"</code> to the program specified by the <command> tag.

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

* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* String (textbox)
* Description (static text)
* Enum (drop down selection list)
* Notebook (pages/tabs)
* Option group (radio buttons)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

=== 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/.config/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 separate 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 ===

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

*[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]]

*[[Tips For Python Script Extensions]]

[[Category:Extensions]]

Talk:INX extension descriptor format

2010-11-01T18:30:03Z

Flor: /* Relax NG Compact */

===Questions related to the recent changes (Relax NG Compact (RNC)):===
* How does the created Relax NG Compact (RNC) example differ/compare to the [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head%3A/share/extensions/inkscape.extension.rng RELAX NG Schema] in trunk?
* <del>The Example INX file is outdated - the format was slightly changed in 0.47, see revisions [http://bazaar.launchpad.net/%7Einkscape.dev/inkscape/trunk/revision/5472 5472], [http://bazaar.launchpad.net/%7Einkscape.dev/inkscape/trunk/revision/5946 5946] and [http://bazaar.launchpad.net/%7Einkscape.dev/inkscape/trunk/revision/5947 5947]</del> I added the namespace etc. Does that cover all the changes? --[[User:Flor|Flor]] 18:06, 1 November 2010 (UTC)
:Additional information (as far as I could find it ;) ): [http://thread.gmane.org/gmane.comp.graphics.inkscape.devel/26105 Subject: Extensions (inx) files] (inkscape-devel mailing list)
--[[User:~suv|~suv]] 06:46, 28 August 2010 (UTC)

=== Relax NG Compact ===
This is what I get when I convert [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head%3A/share/extensions/inkscape.extension.rng RELAX NG Schema] to Relax NG Compact with Trang. Is this the right version for the current scheme? --[[User:Flor|Flor]] 18:29, 1 November 2010 (UTC)
<small><pre>
default namespace =
"http://www.inkscape.org/namespace/inkscape/extension"

start =
element inkscape-extension {
element _name { text },
element id { text },
element dependency {
attribute type { inx.dependency-type.values },
attribute location { inx.location.values }?,
attribute _description { text }?,
text
}*,
(inx.parameters
| element param {
attribute name { text },
attribute type { "notebook" },
element page {
attribute name { text },
attribute _gui-text { text },
inx.parameters+
}+
})*,
(element input {
inx.io.common,
element output_extension { text }?
}
| element output {
inx.io.common,
element dataloss { xsd:boolean }?
}
| element effect {
attribute needs-document { xsd:boolean }?,
attribute needs-live-preview { xsd:boolean }?,
element object-type {
xsd:token "all" | xsd:token "path" | xsd:token "rect"
},
element effects-menu {
attribute hidden { xsd:boolean "true" }
| element submenu {
attribute _name { text },
empty
}
}
}
| element path-effect { empty }
| element print { empty }),
(element script {
element command {
inx.reldir.attr,
attribute interpreter { "python" | "perl" }?,
text
},
element helper_extension { xsd:NMTOKEN }?,
element check { inx.reldir.attr, text }*
}
| element xslt {
element file { inx.reldir.attr, text }
}
| element plugin {
element name { text }
})
}
inx.reldir.attr = attribute reldir { inx.location.values }
inx.location.values = "extensions" | "path" | "plugins"
inx.dependency-type.values = "extension" | "executable" | "plugin"
inx.io.common =
element extension { text },
element mimetype { text },
element _filetypename { text }?,
element _filetypetooltip { text }?
inx.parameter =
attribute name { xsd:token },
attribute gui-hidden { xsd:boolean }?,
attribute _gui-text { text }?,
((attribute type { "int" },
attribute min { xsd:integer }?,
attribute max { xsd:integer }?,
(empty | xsd:integer))
| (attribute type { "float" },
attribute precision { xsd:integer }?,
attribute min { xsd:float }?,
attribute max { xsd:float }?,
xsd:float)
| (attribute type { "boolean" },
xsd:boolean)
| (attribute type { "string" },
attribute max_length { xsd:integer }?,
(empty | text))
| (attribute type { "description" },
text)
| (attribute type { "enum" },
(element _item { inx.parameter.enum.item }
| element item { inx.parameter.enum.item })+)
| (attribute type { "optiongroup" },
attribute appearance { "minimal" }?,
(element option { inx.parameter.optiongroup.option }
| element _option { inx.parameter.optiongroup.option })+))
inx.parameters =
element param { inx.parameter }
| element _param { inx.parameter }
inx.parameter.enum.item =
attribute value { text },
xsd:token
inx.parameter.optiongroup.option =
attribute value { text }?,
text
</pre></small>

Talk:INX extension descriptor format

2010-11-01T18:29:47Z

Flor:

===Questions related to the recent changes (Relax NG Compact (RNC)):===
* How does the created Relax NG Compact (RNC) example differ/compare to the [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head%3A/share/extensions/inkscape.extension.rng RELAX NG Schema] in trunk?
* <del>The Example INX file is outdated - the format was slightly changed in 0.47, see revisions [http://bazaar.launchpad.net/%7Einkscape.dev/inkscape/trunk/revision/5472 5472], [http://bazaar.launchpad.net/%7Einkscape.dev/inkscape/trunk/revision/5946 5946] and [http://bazaar.launchpad.net/%7Einkscape.dev/inkscape/trunk/revision/5947 5947]</del> I added the namespace etc. Does that cover all the changes? --[[User:Flor|Flor]] 18:06, 1 November 2010 (UTC)
:Additional information (as far as I could find it ;) ): [http://thread.gmane.org/gmane.comp.graphics.inkscape.devel/26105 Subject: Extensions (inx) files] (inkscape-devel mailing list)
--[[User:~suv|~suv]] 06:46, 28 August 2010 (UTC)

== Relax NG Compact ==
This is what I get when I convert [http://bazaar.launchpad.net/~inkscape.dev/inkscape/trunk/annotate/head%3A/share/extensions/inkscape.extension.rng RELAX NG Schema] to Relax NG Compact with Trang. Is this the right version for the current scheme? --[[User:Flor|Flor]] 18:29, 1 November 2010 (UTC)
<small><pre>
default namespace =
"http://www.inkscape.org/namespace/inkscape/extension"

start =
element inkscape-extension {
element _name { text },
element id { text },
element dependency {
attribute type { inx.dependency-type.values },
attribute location { inx.location.values }?,
attribute _description { text }?,
text
}*,
(inx.parameters
| element param {
attribute name { text },
attribute type { "notebook" },
element page {
attribute name { text },
attribute _gui-text { text },
inx.parameters+
}+
})*,
(element input {
inx.io.common,
element output_extension { text }?
}
| element output {
inx.io.common,
element dataloss { xsd:boolean }?
}
| element effect {
attribute needs-document { xsd:boolean }?,
attribute needs-live-preview { xsd:boolean }?,
element object-type {
xsd:token "all" | xsd:token "path" | xsd:token "rect"
},
element effects-menu {
attribute hidden { xsd:boolean "true" }
| element submenu {
attribute _name { text },
empty
}
}
}
| element path-effect { empty }
| element print { empty }),
(element script {
element command {
inx.reldir.attr,
attribute interpreter { "python" | "perl" }?,
text
},
element helper_extension { xsd:NMTOKEN }?,
element check { inx.reldir.attr, text }*
}
| element xslt {
element file { inx.reldir.attr, text }
}
| element plugin {
element name { text }
})
}
inx.reldir.attr = attribute reldir { inx.location.values }
inx.location.values = "extensions" | "path" | "plugins"
inx.dependency-type.values = "extension" | "executable" | "plugin"
inx.io.common =
element extension { text },
element mimetype { text },
element _filetypename { text }?,
element _filetypetooltip { text }?
inx.parameter =
attribute name { xsd:token },
attribute gui-hidden { xsd:boolean }?,
attribute _gui-text { text }?,
((attribute type { "int" },
attribute min { xsd:integer }?,
attribute max { xsd:integer }?,
(empty | xsd:integer))
| (attribute type { "float" },
attribute precision { xsd:integer }?,
attribute min { xsd:float }?,
attribute max { xsd:float }?,
xsd:float)
| (attribute type { "boolean" },
xsd:boolean)
| (attribute type { "string" },
attribute max_length { xsd:integer }?,
(empty | text))
| (attribute type { "description" },
text)
| (attribute type { "enum" },
(element _item { inx.parameter.enum.item }
| element item { inx.parameter.enum.item })+)
| (attribute type { "optiongroup" },
attribute appearance { "minimal" }?,
(element option { inx.parameter.optiongroup.option }
| element _option { inx.parameter.optiongroup.option })+))
inx.parameters =
element param { inx.parameter }
| element _param { inx.parameter }
inx.parameter.enum.item =
attribute value { text },
xsd:token
inx.parameter.optiongroup.option =
attribute value { text }?,
text
</pre></small>

Talk:INX extension descriptor format

2010-11-01T18:06:47Z

Flor: /* Questions related to the recent changes (Relax NG Compact (RNC)): */

INX extension descriptor format

2010-11-01T17:56:16Z

Flor: /* Relax NG Compact (RNC) */

== 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 parameters has to have "_" prepended to their name, e.g. <tt><_name>name of extension</_name></tt>

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

Useful 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].

<small><code><pre>
<?xml version="1.0" encoding="UTF-8"?>
<inkscape-extension xmlns="http://www.inkscape.org/namespace/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></code></small>

== DTD ==
<small><code><pre>
<!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|submenu?)>
<!ELEMENT script (command, helper_extension*, check*)>
<!ELEMENT plugin (name)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT id (#PCDATA)>
<!ELEMENT item (#PCDATA)>
<!ELEMENT option (#PCDATA)>
<!ELEMENT dependency (#PCDATA)>
<!ELEMENT param (#PCDATA|page|item|option)*>
<!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 effect needs-live-preview (true|false) #REQUIRED>
<!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|optiongroup|color) #REQUIRED>
<!ATTLIST param min CDATA #IMPLIED>
<!ATTLIST param max CDATA #IMPLIED>
<!ATTLIST param max_length CDATA #IMPLIED>
<!ATTLIST param precision CDATA #IMPLIED>
<!ATTLIST param gui-text CDATA #IMPLIED>
<!ATTLIST param gui-tip CDATA #IMPLIED>
<!ATTLIST param gui-description CDATA #IMPLIED>
<!ATTLIST param scope CDATA #IMPLIED>
<!ATTLIST param gui-hidden CDATA #IMPLIED>
<!ATTLIST param appearance (minimal|) "">
<!ATTLIST submenu name CDATA #REQUIRED>
</pre></code></small>

== Relax NG Compact (RNC) ==
<small><code><pre>
datatypes xs = 'http://www.w3.org/2001/XMLSchema-datatypes'
namespace inkscape = 'http://www.inkscape.org/namespaces/inkscape'
default namespace local = ''

# Initially created from a Trang conversion.
# Edited for readability.
#
# @author Zearin
# @date 2010-07-21T11:02:00

start = inkscape-extension

#-------------------------------------------------------------------------------
# ELEMENTS
#===============================================================================
inkscape-extension =
element inkscape-extension
{
name,
id,
dependency*,
param*,
(input | output | effect),
(script | plugin)
}

input =
element input
{
extension,
mimetype,
filetype,
filetypetooltip,
output_extension?
}

output =
element output
{
extension,
mimetype,
filetype,
filetypetooltip,
dataloss?
}

effect = element effect { attlist.effect, (object-type | submenu?) }
script = element script { command, helper_extension*, check* }
plugin = element plugin { name }
name = element name { text }
id = element id { text }
item = element item { text }
option = element option { text }
dependency = element dependency { attlist.dependency, text }
param = element param { attlist.param, (text | page | item | option)* }
page = element page {text, param*}
extension = element extension { text }
mimetype = element mimetype { text }
filetype = element filetype { text }
filetooltip = element filetooltip { text }
object-type = element object-type { text }
command = element command { attlist.command, text }
check = element check { attlist.check, text }
dataloss = element dataloss { text }
helper_extension= element helper_extension { text }
output_extension= element output_extension { text }

#-------------------------------------------------------------------------------
# ATTRIBUTE LISTS
#===============================================================================
attlist.check =
attribute reldir { "absolute" | "path" | "extensions" | "plugins" }

attlist.command =
(
attribute reldir { "absolute" | "path" | "extensions" | "plugins" },
attribute interpreter { text }
)

attlist.dependency =
(
attribute type { "executable" | "extension" },
attribute location { "absolute" | "path" | "extensions" | "plugins" }?,
attribute description { text }?
)

attlist.effect =
attribute needs-live-preview { "true" | "false" }

attlist.page =
(
attribute name { text },
attribute gui-text { text }?
)

attlist.param =
(
attribute name { text },
attribute type {
"int"
| "float"
| "string"
| "boolean"
| "enum"
| "notebook"
| "description"
| "optiongroup"
| "color"
},
attribute min { text }?,
attribute max { text }?,
attribute max_length { text }?,
attribute precision { text }?,
attribute gui-text { text }?,
attribute gui-tip { text }?,
attribute gui-description { text }?,
attribute scope { text }?,
attribute gui-hidden { text }?,
attribute appearance {'minimal'|''}
)

attlist.submenu = attribute name { text }

#-------------------------------------------------------------------------------
# MISC
#===============================================================================
filetypetooltip |= notAllowed
page |= notAllowed
submenu |= notAllowed
</pre></code></small>

== See Also ==
*[[INX Parameters]]
*[[ScriptingHOWTO]]

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

INX extension descriptor format

2010-11-01T17:55:17Z

Flor: /* Relax NG Compact (RNC) */

== 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 parameters has to have "_" prepended to their name, e.g. <tt><_name>name of extension</_name></tt>

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

Useful 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].

<small><code><pre>
<?xml version="1.0" encoding="UTF-8"?>
<inkscape-extension xmlns="http://www.inkscape.org/namespace/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></code></small>

== DTD ==
<small><code><pre>
<!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|submenu?)>
<!ELEMENT script (command, helper_extension*, check*)>
<!ELEMENT plugin (name)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT id (#PCDATA)>
<!ELEMENT item (#PCDATA)>
<!ELEMENT option (#PCDATA)>
<!ELEMENT dependency (#PCDATA)>
<!ELEMENT param (#PCDATA|page|item|option)*>
<!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 effect needs-live-preview (true|false) #REQUIRED>
<!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|optiongroup|color) #REQUIRED>
<!ATTLIST param min CDATA #IMPLIED>
<!ATTLIST param max CDATA #IMPLIED>
<!ATTLIST param max_length CDATA #IMPLIED>
<!ATTLIST param precision CDATA #IMPLIED>
<!ATTLIST param gui-text CDATA #IMPLIED>
<!ATTLIST param gui-tip CDATA #IMPLIED>
<!ATTLIST param gui-description CDATA #IMPLIED>
<!ATTLIST param scope CDATA #IMPLIED>
<!ATTLIST param gui-hidden CDATA #IMPLIED>
<!ATTLIST param appearance (minimal|) "">
<!ATTLIST submenu name CDATA #REQUIRED>
</pre></code></small>

== Relax NG Compact (RNC) ==
<small><code><pre>
datatypes xs = 'http://www.w3.org/2001/XMLSchema-datatypes'
namespace inkscape = 'http://www.inkscape.org/namespaces/inkscape'
default namespace local = ''

# Initially created from a Trang conversion.
# Edited for readability.
#
# @author Zearin
# @date 2010-07-21T11:02:00

start = inkscape-extension

#-------------------------------------------------------------------------------
# ELEMENTS
#===============================================================================
inkscape-extension =
element inkscape-extension
{
name,
id,
dependency*,
param*,
(input | output | effect),
(script | plugin)
}

input =
element input
{
extension,
mimetype,
filetype,
filetypetooltip,
output_extension?
}

output =
element output
{
extension,
mimetype,
filetype,
filetypetooltip,
dataloss?
}

effect = element effect { attlist.effect, (object-type | submenu?) }
script = element script { command, helper_extension*, check* }
plugin = element plugin { name }
name = element name { text }
id = element id { text }
item = element item { text }
option = element option { text }
dependency = element dependency { attlist.dependency, text }
param = element param { attlist.param, (text | page | item | option)* }
page = element page {text, param*}
extension = element extension { text }
mimetype = element mimetype { text }
filetype = element filetype { text }
filetooltip = element filetooltip { text }
object-type = element object-type { text }
command = element command { attlist.command, text }
check = element check { attlist.check, text }
dataloss = element dataloss { text }
helper_extension= element helper_extension { text }
output_extension= element output_extension { text }

#-------------------------------------------------------------------------------
# ATTRIBUTE LISTS
#===============================================================================
attlist.check =
attribute reldir { "absolute" | "path" | "extensions" | "plugins" }

attlist.command =
(
attribute reldir { "absolute" | "path" | "extensions" | "plugins" },
attribute interpreter { text }
)

attlist.dependency =
(
attribute type { "executable" | "extension" },
attribute location { "absolute" | "path" | "extensions" | "plugins" }?,
attribute description { text }?
)

attlist.effect =
attribute needs-live-preview { "true" | "false" }

attlist.page =
(
attribute name { text },
attribute gui-text { text }?
)

attlist.param =
(
attribute name { text },
attribute type {
"int"
| "float"
| "string"
| "boolean"
| "enum"
| "notebook"
| "description"
| "optiongroup"
| "color"
},
attribute min { text }?,
attribute max { text }?,
attribute max_length { text }?,
attribute precision { text }?,
attribute gui-text { text }?,
attribute gui-tip { text }?,
attribute gui-description { text }?,
attribute scope { text }?,
attribute gui-hidden { text }?,
attribute appearance {'minimal'|''}
)

attlist.submenu = attribute name { text }

#-------------------------------------------------------------------------------
# MISC
#===============================================================================
filetypetooltip |= notAllowed
page |= notAllowed
submenu |= notAllowed
</pre></code></small>

== See Also ==
*[[INX Parameters]]
*[[ScriptingHOWTO]]

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

INX extension descriptor format

2010-11-01T17:54:23Z

Flor: /* Example */

== 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 parameters has to have "_" prepended to their name, e.g. <tt><_name>name of extension</_name></tt>

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

Useful 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].

<small><code><pre>
<?xml version="1.0" encoding="UTF-8"?>
<inkscape-extension xmlns="http://www.inkscape.org/namespace/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></code></small>

== DTD ==
<small><code><pre>
<!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|submenu?)>
<!ELEMENT script (command, helper_extension*, check*)>
<!ELEMENT plugin (name)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT id (#PCDATA)>
<!ELEMENT item (#PCDATA)>
<!ELEMENT option (#PCDATA)>
<!ELEMENT dependency (#PCDATA)>
<!ELEMENT param (#PCDATA|page|item|option)*>
<!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 effect needs-live-preview (true|false) #REQUIRED>
<!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|optiongroup|color) #REQUIRED>
<!ATTLIST param min CDATA #IMPLIED>
<!ATTLIST param max CDATA #IMPLIED>
<!ATTLIST param max_length CDATA #IMPLIED>
<!ATTLIST param precision CDATA #IMPLIED>
<!ATTLIST param gui-text CDATA #IMPLIED>
<!ATTLIST param gui-tip CDATA #IMPLIED>
<!ATTLIST param gui-description CDATA #IMPLIED>
<!ATTLIST param scope CDATA #IMPLIED>
<!ATTLIST param gui-hidden CDATA #IMPLIED>
<!ATTLIST param appearance (minimal|) "">
<!ATTLIST submenu name CDATA #REQUIRED>
</pre></code></small>

== Relax NG Compact (RNC) ==
<small><code><pre>
datatypes xs = 'http://www.w3.org/2001/XMLSchema-datatypes'
namespace inkscape = 'http://www.inkscape.org/namespaces/inkscape'
default namespace local = ''

# Initially created from a Trang conversion.
# Edited for readability.
#
# @author Zearin
# @date 2010-07-21T11:02:00

start = inkscape-extension

#-------------------------------------------------------------------------------
# ELEMENTS
#===============================================================================
inkscape-extension =
element inkscape-extension
{
name,
id,
dependency*,
param*,
(input | output | effect),
(script | plugin)
}

input =
element input
{
extension,
mimetype,
filetype,
filetypetooltip,
output_extension?
}

output =
element output
{
extension,
mimetype,
filetype,
filetypetooltip,
dataloss?
}

effect = element effect { attlist.effect, (object-type | submenu?) }
script = element script { command, helper_extension*, check* }
plugin = element plugin { name }
name = element name { text }
id = element id { text }
item = element item { text }
option = element option { text }
dependency = element dependency { attlist.dependency, text }
param = element param { attlist.param, (text | page | item | option)* }
page = element page {text, param*}
extension = element extension { text }
mimetype = element mimetype { text }
filetype = element filetype { text }
filetooltip = element filetooltip { text }
object-type = element object-type { text }
command = element command { attlist.command, text }
check = element check { attlist.check, text }
dataloss = element dataloss { text }
helper_extension = element helper_extension { text }
output_extension = element output_extension { text }

#-------------------------------------------------------------------------------
# ATTRIBUTE LISTS
#===============================================================================
attlist.check =
attribute reldir { "absolute" | "path" | "extensions" | "plugins" }

attlist.command =
(
attribute reldir { "absolute" | "path" | "extensions" | "plugins" },
attribute interpreter { text }
)

attlist.dependency =
(
attribute type { "executable" | "extension" },
attribute location { "absolute" | "path" | "extensions" | "plugins" }?,
attribute description { text }?
)

attlist.effect =
attribute needs-live-preview { "true" | "false" }

attlist.page =
(
attribute name { text },
attribute gui-text { text }?
)

attlist.param =
(
attribute name { text },
attribute type {
"int"
| "float"
| "string"
| "boolean"
| "enum"
| "notebook"
| "description"
| "optiongroup"
| "color"
},
attribute min { text }?,
attribute max { text }?,
attribute max_length { text }?,
attribute precision { text }?,
attribute gui-text { text }?,
attribute gui-tip { text }?,
attribute gui-description { text }?,
attribute scope { text }?,
attribute gui-hidden { text }?,
attribute appearance {'minimal'|''}
)

attlist.submenu = attribute name { text }

#-------------------------------------------------------------------------------
# MISC
#===============================================================================
filetypetooltip |= notAllowed
page |= notAllowed
submenu |= notAllowed
</pre></code></small>

== See Also ==
*[[INX Parameters]]
*[[ScriptingHOWTO]]

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

Talk:Inkscape

2010-11-01T11:17:39Z

Flor:

* The [[Working with SVN]] link must be removed from the front page and consider to remove the refereed svn page from this wiki.
* Can we move the [[INX extension descriptor format]] link to Developer tutorials > Extensions, please?

Extensions

2010-11-01T11:02:50Z

Flor: /* Parameters */

This page is intended as a guide for providing new extensions for Inkscape. Currently the majority of extensions are provided as python scripts.

==Extension types==
The following extension types exist for Inkscape:
* '''input'''
* '''output'''
* '''effect'''
* '''print'''
* '''''path-effect''''' - path effects are '''not''' currently implemented as extension but there is intention to migrate those over as entensions

See also: [[Script extensions]]

==Extension implementation==
* Internal
** C++ implementation (directly in code)
* External
** '''scripts''' - written in '''python''', '''perl''' or as system (console) scripts
** '''xslt transformations'''
** '''plugins''' - ''not fully implemented yet''

==Parameters==
Extensions can be supplied with values obtained through easily definable parameters. Inkscape provides the basic GUI for user input. The following parameters are supported:
* '''integer'''
* '''string'''
* '''float'''
* '''boolean'''
* '''enum'''
* '''optiongroup'''
* '''colour'''

For the sake of the UI there are also the following two parameters that do not provide data to the extension but alter the user input GUI.
* '''description'''
* '''notebook'''

See also: [[INX Parameters]]

==Extension Definition File (INX)==
All extensions are defined through Inkscape Extension Definition Files (.inx) which are XML files in the <pre>http://www.inkscape.org/namespace/inkscape/extension</pre> namespace and described by the [http://relaxng.org/ Relax NG] available [here]
===Structure===
===Examples===
====RadioButton example====
The following mark-up:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<inkscape-extension xmlns="http://www.inkscape.org/namespace/inkscape/extension">
<_name>RadioButton example</_name>
<id>org.inkscape.effect.radiobuttontest</id>
<param name="radio1" type="optiongroup" _gui-text="Select option: ">
<option value="string1">translatable string 1</option>
<option value="string2">string 2</option>
<option value="string3">test 3!</option>
</param>
<param name="radio2" type="optiongroup" _gui-text="Select second option: ">
<option value="string11">string1</option>
<option value="string22">string2</option>
<option>test3!</option>
</param>
<effect>
<object-type>all</object-type>
<effects-menu>
<submenu _name="Developer Examples"/>
</effects-menu>
</effect>
...
</inkscape-extension>
</pre>
Will result in the following GUI being created:

[[Image:Extensions-radiobutton_gui_example.png]]

===i18n===
To allow the .inx files to fit snugly into Inkscape's i18n infrastructure some XML elements and attributes are prefixed with an underscore (_) character to indicate that the containing text should be marked for translation.

Extensions

2010-11-01T11:02:31Z

Flor: /* Extension types */

This page is intended as a guide for providing new extensions for Inkscape. Currently the majority of extensions are provided as python scripts.

==Extension types==
The following extension types exist for Inkscape:
* '''input'''
* '''output'''
* '''effect'''
* '''print'''
* '''''path-effect''''' - path effects are '''not''' currently implemented as extension but there is intention to migrate those over as entensions

See also: [[Script extensions]]

==Extension implementation==
* Internal
** C++ implementation (directly in code)
* External
** '''scripts''' - written in '''python''', '''perl''' or as system (console) scripts
** '''xslt transformations'''
** '''plugins''' - ''not fully implemented yet''

==Parameters==
Extensions can be supplied with values obtained through easily definable parameters. Inkscape provides the basic GUI for user input. The following parameters are supported:
* '''integer'''
* '''string'''
* '''float'''
* '''boolean'''
* '''enum'''
* '''optiongroup'''
* '''colour'''

For the sake of the UI there are also the following two parameters that do not provide data to the extension but alter the user input GUI.
* '''description'''
* '''notebook'''

See also [[INX Parameters]]

==Extension Definition File (INX)==
All extensions are defined through Inkscape Extension Definition Files (.inx) which are XML files in the <pre>http://www.inkscape.org/namespace/inkscape/extension</pre> namespace and described by the [http://relaxng.org/ Relax NG] available [here]
===Structure===
===Examples===
====RadioButton example====
The following mark-up:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<inkscape-extension xmlns="http://www.inkscape.org/namespace/inkscape/extension">
<_name>RadioButton example</_name>
<id>org.inkscape.effect.radiobuttontest</id>
<param name="radio1" type="optiongroup" _gui-text="Select option: ">
<option value="string1">translatable string 1</option>
<option value="string2">string 2</option>
<option value="string3">test 3!</option>
</param>
<param name="radio2" type="optiongroup" _gui-text="Select second option: ">
<option value="string11">string1</option>
<option value="string22">string2</option>
<option>test3!</option>
</param>
<effect>
<object-type>all</object-type>
<effects-menu>
<submenu _name="Developer Examples"/>
</effects-menu>
</effect>
...
</inkscape-extension>
</pre>
Will result in the following GUI being created:

[[Image:Extensions-radiobutton_gui_example.png]]

===i18n===
To allow the .inx files to fit snugly into Inkscape's i18n infrastructure some XML elements and attributes are prefixed with an underscore (_) character to indicate that the containing text should be marked for translation.

Extensions

2010-11-01T11:01:09Z

Flor: /* Parameters */

This page is intended as a guide for providing new extensions for Inkscape. Currently the majority of extensions are provided as python scripts.

==Extension types==
The following extension types exist for Inkscape:
* '''input'''
* '''output'''
* '''effect'''
* '''print'''
* '''''path-effect''''' - path effects are '''not''' currently implemented as extension but there is intention to migrate those over as entensions

==Extension implementation==
* Internal
** C++ implementation (directly in code)
* External
** '''scripts''' - written in '''python''', '''perl''' or as system (console) scripts
** '''xslt transformations'''
** '''plugins''' - ''not fully implemented yet''

==Parameters==
Extensions can be supplied with values obtained through easily definable parameters. Inkscape provides the basic GUI for user input. The following parameters are supported:
* '''integer'''
* '''string'''
* '''float'''
* '''boolean'''
* '''enum'''
* '''optiongroup'''
* '''colour'''

For the sake of the UI there are also the following two parameters that do not provide data to the extension but alter the user input GUI.
* '''description'''
* '''notebook'''

See also [[INX Parameters]]

==Extension Definition File (INX)==
All extensions are defined through Inkscape Extension Definition Files (.inx) which are XML files in the <pre>http://www.inkscape.org/namespace/inkscape/extension</pre> namespace and described by the [http://relaxng.org/ Relax NG] available [here]
===Structure===
===Examples===
====RadioButton example====
The following mark-up:
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<inkscape-extension xmlns="http://www.inkscape.org/namespace/inkscape/extension">
<_name>RadioButton example</_name>
<id>org.inkscape.effect.radiobuttontest</id>
<param name="radio1" type="optiongroup" _gui-text="Select option: ">
<option value="string1">translatable string 1</option>
<option value="string2">string 2</option>
<option value="string3">test 3!</option>
</param>
<param name="radio2" type="optiongroup" _gui-text="Select second option: ">
<option value="string11">string1</option>
<option value="string22">string2</option>
<option>test3!</option>
</param>
<effect>
<object-type>all</object-type>
<effects-menu>
<submenu _name="Developer Examples"/>
</effects-menu>
</effect>
...
</inkscape-extension>
</pre>
Will result in the following GUI being created:

[[Image:Extensions-radiobutton_gui_example.png]]

===i18n===
To allow the .inx files to fit snugly into Inkscape's i18n infrastructure some XML elements and attributes are prefixed with an underscore (_) character to indicate that the containing text should be marked for translation.

Extensions: INX widgets and parameters

2010-11-01T10:00:42Z

Flor: /* color */

Extensions: INX widgets and parameters

2010-11-01T09:59:54Z

Flor: /* color */

Here you will find the different parameter elements you may use in your .inx files (Inkscape Extensions)

== Introduction ==
Use parameter elements to capture user input for further use by a script. The basic structure of the element is:

<code><pre>
<param name="some_name" type="some_type">default value</param>
</pre></code>

The default value is the value that is shown in the input control the first time the user opens the dialog window. Inkscape automatically displays the values used last time when the dialog window is opened again.

==string==
A textbox to capture a '''character string'''.

Example:
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
</pre></code>

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the <code>min</code> and <code>max</code> attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the <code>min</code> and <code>max</code> attributes. To set the number of decimal places, use the <code>precision</code> attribute.

Example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==boolean==
Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.

Example:
<code><pre>
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
</pre></code>

==enum==
Creates a list of choices where the user can only select '''one option''' using a drop down select list.

Create the different choices with <code><item></code> elements. The first item is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected item'''.

Example:
<code><pre>
<param name="some_name" type="enum" _gui-text="Some label text">
<_item value="1">First option</_item>
<_item value="2">Second option</_item>
</param>
</pre></code>

==optiongroup==
Creates a list of choices where the user can only select '''one option'''. By default this is displayed as radiobuttons. Set the attribute <code>appearance="minimal"</code> to display a drop down select list instead.

Create the different choices with <code><option></code> elements. The first option is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.

Example:
<code><pre>
<param name="some_name" type="optiongroup" appearance="minimal" _gui-text="Some label text">
<_option value="1">First option</_option>
<_option value="2">Second option</_option>
</param>
</pre></code>

==color==
Creates a control to select a '''color'''.

The returned value is a RGBA-value.

Example:
<param name="some_name" type="color"></param>

==description==
To show some text in the dialog window, for example as "help" text.

Example:
<code><pre>
<param name="some_name" type="description"">Some text here.</param>
</pre></code>

==notebook==
Creates a '''set of pages''' or tab-sheets. Create individual pages with the <code><page></code> element.

The '''returned value''' for the notebook parameter element is the name of the '''selected''' page/tab.

Example:
<code><pre>
<param name="some_name" type="notebook">
<page name="name_page_1" _gui-text="First page">
<param>...</param>
</page>
<page name="name_page_2" _gui-text="Second page">
<param>...</param>
</page>
</param>
</pre></code>

Extensions: INX widgets and parameters

2010-11-01T09:48:51Z

Flor: /* float */

Here you will find the different parameter elements you may use in your .inx files (Inkscape Extensions)

== Introduction ==
Use parameter elements to capture user input for further use by a script. The basic structure of the element is:

<code><pre>
<param name="some_name" type="some_type">default value</param>
</pre></code>

The default value is the value that is shown in the input control the first time the user opens the dialog window. Inkscape automatically displays the values used last time when the dialog window is opened again.

==string==
A textbox to capture a '''character string'''.

Example:
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
</pre></code>

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the <code>min</code> and <code>max</code> attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the <code>min</code> and <code>max</code> attributes. To set the number of decimal places, use the <code>precision</code> attribute.

Example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==boolean==
Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.

Example:
<code><pre>
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
</pre></code>

==enum==
Creates a list of choices where the user can only select '''one option''' using a drop down select list.

Create the different choices with <code><item></code> elements. The first item is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected item'''.

Example:
<code><pre>
<param name="some_name" type="enum" _gui-text="Some label text">
<_item value="1">First option</_item>
<_item value="2">Second option</_item>
</param>
</pre></code>

==optiongroup==
Creates a list of choices where the user can only select '''one option'''. By default this is displayed as radiobuttons. Set the attribute <code>appearance="minimal"</code> to display a drop down select list instead.

Create the different choices with <code><option></code> elements. The first option is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.

Example:
<code><pre>
<param name="some_name" type="optiongroup" appearance="minimal" _gui-text="Some label text">
<_option value="1">First option</_option>
<_option value="2">Second option</_option>
</param>
</pre></code>

==color==
''??''

==description==
To show some text in the dialog window, for example as "help" text.

Example:
<code><pre>
<param name="some_name" type="description"">Some text here.</param>
</pre></code>

==notebook==
Creates a '''set of pages''' or tab-sheets. Create individual pages with the <code><page></code> element.

The '''returned value''' for the notebook parameter element is the name of the '''selected''' page/tab.

Example:
<code><pre>
<param name="some_name" type="notebook">
<page name="name_page_1" _gui-text="First page">
<param>...</param>
</page>
<page name="name_page_2" _gui-text="Second page">
<param>...</param>
</page>
</param>
</pre></code>

Extensions: INX widgets and parameters

2010-11-01T09:48:24Z

Flor: /* float */

Here you will find the different parameter elements you may use in your .inx files (Inkscape Extensions)

== Introduction ==
Use parameter elements to capture user input for further use by a script. The basic structure of the element is:

<code><pre>
<param name="some_name" type="some_type">default value</param>
</pre></code>

The default value is the value that is shown in the input control the first time the user opens the dialog window. Inkscape automatically displays the values used last time when the dialog window is opened again.

==string==
A textbox to capture a '''character string'''.

Example:
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
</pre></code>

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the <code>min</code> and <code>max</code> attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the <code>min</code> and <code>max</code> attributes. To set the number of decimal places, use the '''precision''' attribute.

Example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==boolean==
Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.

Example:
<code><pre>
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
</pre></code>

==enum==
Creates a list of choices where the user can only select '''one option''' using a drop down select list.

Create the different choices with <code><item></code> elements. The first item is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected item'''.

Example:
<code><pre>
<param name="some_name" type="enum" _gui-text="Some label text">
<_item value="1">First option</_item>
<_item value="2">Second option</_item>
</param>
</pre></code>

==optiongroup==
Creates a list of choices where the user can only select '''one option'''. By default this is displayed as radiobuttons. Set the attribute <code>appearance="minimal"</code> to display a drop down select list instead.

Create the different choices with <code><option></code> elements. The first option is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.

Example:
<code><pre>
<param name="some_name" type="optiongroup" appearance="minimal" _gui-text="Some label text">
<_option value="1">First option</_option>
<_option value="2">Second option</_option>
</param>
</pre></code>

==color==
''??''

==description==
To show some text in the dialog window, for example as "help" text.

Example:
<code><pre>
<param name="some_name" type="description"">Some text here.</param>
</pre></code>

==notebook==
Creates a '''set of pages''' or tab-sheets. Create individual pages with the <code><page></code> element.

The '''returned value''' for the notebook parameter element is the name of the '''selected''' page/tab.

Example:
<code><pre>
<param name="some_name" type="notebook">
<page name="name_page_1" _gui-text="First page">
<param>...</param>
</page>
<page name="name_page_2" _gui-text="Second page">
<param>...</param>
</page>
</param>
</pre></code>

Extensions: INX widgets and parameters

2010-11-01T09:47:41Z

Flor: /* int */

Here you will find the different parameter elements you may use in your .inx files (Inkscape Extensions)

== Introduction ==
Use parameter elements to capture user input for further use by a script. The basic structure of the element is:

<code><pre>
<param name="some_name" type="some_type">default value</param>
</pre></code>

The default value is the value that is shown in the input control the first time the user opens the dialog window. Inkscape automatically displays the values used last time when the dialog window is opened again.

==string==
A textbox to capture a '''character string'''.

Example:
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
</pre></code>

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the <code>min</code> and <code>max</code> attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes. To set the number of decimal places, use the '''precision''' attribute.

Example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==boolean==
Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.

Example:
<code><pre>
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
</pre></code>

==enum==
Creates a list of choices where the user can only select '''one option''' using a drop down select list.

Create the different choices with <code><item></code> elements. The first item is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected item'''.

Example:
<code><pre>
<param name="some_name" type="enum" _gui-text="Some label text">
<_item value="1">First option</_item>
<_item value="2">Second option</_item>
</param>
</pre></code>

==optiongroup==
Creates a list of choices where the user can only select '''one option'''. By default this is displayed as radiobuttons. Set the attribute <code>appearance="minimal"</code> to display a drop down select list instead.

Create the different choices with <code><option></code> elements. The first option is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.

Example:
<code><pre>
<param name="some_name" type="optiongroup" appearance="minimal" _gui-text="Some label text">
<_option value="1">First option</_option>
<_option value="2">Second option</_option>
</param>
</pre></code>

==color==
''??''

==description==
To show some text in the dialog window, for example as "help" text.

Example:
<code><pre>
<param name="some_name" type="description"">Some text here.</param>
</pre></code>

==notebook==
Creates a '''set of pages''' or tab-sheets. Create individual pages with the <code><page></code> element.

The '''returned value''' for the notebook parameter element is the name of the '''selected''' page/tab.

Example:
<code><pre>
<param name="some_name" type="notebook">
<page name="name_page_1" _gui-text="First page">
<param>...</param>
</page>
<page name="name_page_2" _gui-text="Second page">
<param>...</param>
</page>
</param>
</pre></code>

Extensions: INX widgets and parameters

2010-11-01T09:45:48Z

Flor:

Here you will find the different parameter elements you may use in your .inx files (Inkscape Extensions)

== Introduction ==
Use parameter elements to capture user input for further use by a script. The basic structure of the element is:

<code><pre>
<param name="some_name" type="some_type">default value</param>
</pre></code>

The default value is the value that is shown in the input control the first time the user opens the dialog window. Inkscape automatically displays the values used last time when the dialog window is opened again.

==string==
A textbox to capture a '''character string'''.

Example:
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
</pre></code>

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes. To set the number of decimal places, use the '''precision''' attribute.

Example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==boolean==
Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.

Example:
<code><pre>
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
</pre></code>

==enum==
Creates a list of choices where the user can only select '''one option''' using a drop down select list.

Create the different choices with <code><item></code> elements. The first item is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected item'''.

Example:
<code><pre>
<param name="some_name" type="enum" _gui-text="Some label text">
<_item value="1">First option</_item>
<_item value="2">Second option</_item>
</param>
</pre></code>

==optiongroup==
Creates a list of choices where the user can only select '''one option'''. By default this is displayed as radiobuttons. Set the attribute <code>appearance="minimal"</code> to display a drop down select list instead.

Create the different choices with <code><option></code> elements. The first option is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.

Example:
<code><pre>
<param name="some_name" type="optiongroup" appearance="minimal" _gui-text="Some label text">
<_option value="1">First option</_option>
<_option value="2">Second option</_option>
</param>
</pre></code>

==color==
''??''

==description==
To show some text in the dialog window, for example as "help" text.

Example:
<code><pre>
<param name="some_name" type="description"">Some text here.</param>
</pre></code>

==notebook==
Creates a '''set of pages''' or tab-sheets. Create individual pages with the <code><page></code> element.

The '''returned value''' for the notebook parameter element is the name of the '''selected''' page/tab.

Example:
<code><pre>
<param name="some_name" type="notebook">
<page name="name_page_1" _gui-text="First page">
<param>...</param>
</page>
<page name="name_page_2" _gui-text="Second page">
<param>...</param>
</page>
</param>
</pre></code>

Script extensions

2010-11-01T09:24:31Z

Flor: /* Parameters */

[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 ===

Traditional unix scripts can be used to extend Inkscape's functionality.
Such programs read a stream of data on standard input, transform the data in some way, and then write the modified data to standard output. This is an easy way to expand Inkscape and provide custom functionality without learning the internals of Inkscape. Libraries for reading and writing SVG data exist for many programming languages, and most provide support for XML. This HOWTO describes the "ins and outs" of writing one of these scripts and making it work with Inkscape's core functionality.

=== Types of scripts ===

There are three kinds of functions that can be 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 <code>--paramname=paramvalue</code>. 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 <code>--string1="text"</code> to the program specified by the <command> tag.

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

* Boolean (checkbox)
* Int (numeric textbox)
* Float (numeric textbox)
* String (textbox)
* Description (static text)
* Enum (drop down selection list)
* Notebook (pages/tabs)
* Option group (radio buttons)

For a detailed description of all parameters and input controls, see [[INX Parameters]].

=== 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/.config/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 separate 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 ===

*[[Generating_objects_from_extensions]]. How to use a script to generate actual objects inside SVG documents.

*[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]]

*[[Tips For Python Script Extensions]]

[[Category:Extensions]]

Extensions: INX widgets and parameters

2010-11-01T09:17:45Z

Flor:

Here you will find the different parameter elements you may use in your .inx files (Inkscape Extensions)

==string==
A textbox to capture a '''character string'''.

Example:
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
</pre></code>

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes. To set the number of decimal places, use the '''precision''' attribute.

Example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==boolean==
Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.

Example:
<code><pre>
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
</pre></code>

==enum==
Creates a list of choices where the user can only select '''one option''' using a drop down select list.

Create the different choices with <code><item></code> elements. The first item is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected item'''.

Example:
<code><pre>
<param name="some_name" type="enum" _gui-text="Some label text">
<_item value="1">First option</_item>
<_item value="2">Second option</_item>
</param>
</pre></code>

==optiongroup==
Creates a list of choices where the user can only select '''one option'''. By default this is displayed as radiobuttons. Set the attribute <code>appearance="minimal"</code> to display a drop down select list instead.

Create the different choices with <code><option></code> elements. The first option is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.

Example:
<code><pre>
<param name="some_name" type="optiongroup" appearance="minimal" _gui-text="Some label text">
<_option value="1">First option</_option>
<_option value="2">Second option</_option>
</param>
</pre></code>

==color==
''??''

==description==
To show some text in the dialog window, for example as "help" text.

Example:
<code><pre>
<param name="some_name" type="description"">Some text here.</param>
</pre></code>

==notebook==
Creates a '''set of pages''' or tab-sheets. Create individual pages with the <code><page></code> element.

The '''returned value''' for the notebook parameter element is the name of the '''selected''' page/tab.

Example:
<code><pre>
<param name="some_name" type="notebook">
<page name="name_page_1" _gui-text="First page">
<param>...</param>
</page>
<page name="name_page_2" _gui-text="Second page">
<param>...</param>
</page>
</param>
</pre></code>

Extensions: INX widgets and parameters

2010-11-01T09:13:45Z

Flor: /* optiongroup */

Here you will find the differents parameters you may use in your .inx files (Inkscape Extensions)

==boolean==
Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.

Example:
<code><pre>
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
</pre></code>

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes. To set the number of decimal places, use the '''precision''' attribute.

Example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==string==
A textbox to capture a '''character string'''.

Example:
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
</pre></code>

==description==
To show some text in the dialog window, for example as "help" text.

Example:
<code><pre>
<param name="some_name" type="description"">Some text here.</param>
</pre></code>

==enum==
Creates a list of choices where the user can only select '''one option''' using a drop down select list.

Create the different choices with <code><item></code> elements. The first item is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected item'''.

Example:
<code><pre>
<param name="some_name" type="enum" _gui-text="Some label text">
<_item value="1">First option</_item>
<_item value="2">Second option</_item>
</param>
</pre></code>

==notebook==
Creates a '''set of pages''' or tab-sheets. Create individual pages with the <code><page></code> element.

The '''returned value''' for the notebook parameter element is the name of the '''selected''' page/tab.

Example:
<code><pre>
<param name="some_name" type="notebook">
<page name="name_page_1" _gui-text="First page">
<param>...</param>
</page>
<page name="name_page_2" _gui-text="Second page">
<param>...</param>
</page>
</param>
</pre></code>

==optiongroup==
Creates a list of choices where the user can only select '''one option'''. By default this is displayed as radiobuttons. Set the attribute <code>appearance="minimal"</code> to display a drop down select list instead.

Create the different choices with <code><option></code> elements. The first option is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.

Example:
<code><pre>
<param name="some_name" type="optiongroup" appearance="minimal" _gui-text="Some label text">
<_option value="1">First option</_option>
<_option value="2">Second option</_option>
</param>
</pre></code>

==color==
''??''

Extensions: INX widgets and parameters

2010-11-01T09:13:03Z

Flor: /* enum */

Here you will find the differents parameters you may use in your .inx files (Inkscape Extensions)

==boolean==
Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.

Example:
<code><pre>
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
</pre></code>

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes. To set the number of decimal places, use the '''precision''' attribute.

Example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==string==
A textbox to capture a '''character string'''.

Example:
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
</pre></code>

==description==
To show some text in the dialog window, for example as "help" text.

Example:
<code><pre>
<param name="some_name" type="description"">Some text here.</param>
</pre></code>

==enum==
Creates a list of choices where the user can only select '''one option''' using a drop down select list.

Create the different choices with <code><item></code> elements. The first item is selected by default.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected item'''.

Example:
<code><pre>
<param name="some_name" type="enum" _gui-text="Some label text">
<_item value="1">First option</_item>
<_item value="2">Second option</_item>
</param>
</pre></code>

==notebook==
Creates a '''set of pages''' or tab-sheets. Create individual pages with the <code><page></code> element.

The '''returned value''' for the notebook parameter element is the name of the '''selected''' page/tab.

Example:
<code><pre>
<param name="some_name" type="notebook">
<page name="name_page_1" _gui-text="First page">
<param>...</param>
</page>
<page name="name_page_2" _gui-text="Second page">
<param>...</param>
</page>
</param>
</pre></code>

==optiongroup==
Creates a list of choices where the user can only select '''one option'''. By default this is displayed as radiobuttons. Set the attribute <code>appearance="minimal"</code> to display a drop down select list instead.
The default value is always the first option element.

Create the different choices with <code><option></code> elements.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.

Example:
<code><pre>
<param name="some_name" type="optiongroup" appearance="minimal" _gui-text="Some label text">
<_option value="1">First option</_option>
<_option value="2">Second option</_option>
</param>
</pre></code>

==color==
''??''

Extensions: INX widgets and parameters

2010-11-01T09:11:50Z

Flor: /* optiongroup */

Here you will find the differents parameters you may use in your .inx files (Inkscape Extensions)

==boolean==
Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.

Example:
<code><pre>
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
</pre></code>

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes. To set the number of decimal places, use the '''precision''' attribute.

Example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==string==
A textbox to capture a '''character string'''.

Example:
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
</pre></code>

==description==
To show some text in the dialog window, for example as "help" text.

Example:
<code><pre>
<param name="some_name" type="description"">Some text here.</param>
</pre></code>

==enum==
Creates a list of choices where the user can only select '''one option''' using a drop down select list.

Create the different choices with <code><item></code> elements.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected item'''.

Example:
<code><pre>
<param name="some_name" type="enum" _gui-text="Some label text">
<_item value="1">First option</_item>
<_item value="2">Second option</_item>
</param>
</pre></code>

==notebook==
Creates a '''set of pages''' or tab-sheets. Create individual pages with the <code><page></code> element.

The '''returned value''' for the notebook parameter element is the name of the '''selected''' page/tab.

Example:
<code><pre>
<param name="some_name" type="notebook">
<page name="name_page_1" _gui-text="First page">
<param>...</param>
</page>
<page name="name_page_2" _gui-text="Second page">
<param>...</param>
</page>
</param>
</pre></code>

==optiongroup==
Creates a list of choices where the user can only select '''one option'''. By default this is displayed as radiobuttons. Set the attribute <code>appearance="minimal"</code> to display a drop down select list instead.
The default value is always the first option element.

Create the different choices with <code><option></code> elements.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.

Example:
<code><pre>
<param name="some_name" type="optiongroup" appearance="minimal" _gui-text="Some label text">
<_option value="1">First option</_option>
<_option value="2">Second option</_option>
</param>
</pre></code>

==color==
''??''

Extensions: INX widgets and parameters

2010-11-01T08:21:46Z

Flor: /* enum */

Here you will find the differents parameters you may use in your .inx files (Inkscape Extensions)

==boolean==
Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.

Example:
<code><pre>
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
</pre></code>

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes. To set the number of decimal places, use the '''precision''' attribute.

Example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==string==
A textbox to capture a '''character string'''.

Example:
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
</pre></code>

==description==
To show some text in the dialog window, for example as "help" text.

Example:
<code><pre>
<param name="some_name" type="description"">Some text here.</param>
</pre></code>

==enum==
Creates a list of choices where the user can only select '''one option''' using a drop down select list.

Create the different choices with <code><item></code> elements.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected item'''.

Example:
<code><pre>
<param name="some_name" type="enum" _gui-text="Some label text">
<_item value="1">First option</_item>
<_item value="2">Second option</_item>
</param>
</pre></code>

==notebook==
Creates a '''set of pages''' or tab-sheets. Create individual pages with the <code><page></code> element.

The '''returned value''' for the notebook parameter element is the name of the '''selected''' page/tab.

Example:
<code><pre>
<param name="some_name" type="notebook">
<page name="name_page_1" _gui-text="First page">
<param>...</param>
</page>
<page name="name_page_2" _gui-text="Second page">
<param>...</param>
</page>
</param>
</pre></code>

==optiongroup==
Creates a list of choices where the user can only select '''one option'''. By default this is displayed as radiobuttons. But if the attribute <code>appearance="minimal"</code> is set, then an input box with a drop down select list is shown.

Create the different choices with <code><option></code> elements.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.

Example:
<code><pre>
<param name="some_name" type="optiongroup" appearance="minimal" _gui-text="Some label text">
<_option value="1">First option</_option>
<_option value="2">Second option</_option>
</param>
</pre></code>

==color==
''??''

Extensions: INX widgets and parameters

2010-11-01T08:11:35Z

Flor: /* optiongroup */

Here you will find the differents parameters you may use in your .inx files (Inkscape Extensions)

==boolean==
Gives a '''checkbox'''. Set the default value to <code>true</code> or <code>1</code>, <code>false</code> or <code>0</code>.

Example:
<code><pre>
<param name="some_name" type="boolean" _gui-text="Some label text">false</param>
</pre></code>

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes. To set the number of decimal places, use the '''precision''' attribute.

Example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==string==
A textbox to capture a '''character string'''.

Example:
<code><pre>
<param name="some_name" type="string" _gui-text="Some text label">Some default text</param>
</pre></code>

==description==
To show some text in the dialog window, for example as "help" text.

Example:
<code><pre>
<param name="some_name" type="description"">Some text here.</param>
</pre></code>

==enum==
List of choices; the different choices are given by <code><item></code> elements.

==notebook==
Creates a '''set of pages''' or tab-sheets. Create individual pages with the <code><page></code> element.

The '''returned value''' for the notebook parameter element is the name of the '''selected''' page/tab.

Example:
<code><pre>
<param name="some_name" type="notebook">
<page name="name_page_1" _gui-text="First page">
<param>...</param>
</page>
<page name="name_page_2" _gui-text="Second page">
<param>...</param>
</page>
</param>
</pre></code>

==optiongroup==
Creates a list of choices where the user can only select '''one option'''. By default this is displayed as radiobuttons. But if the attribute <code>appearance="minimal"</code> is set, then an input box with a drop down select list is shown.

Create the different choices with <code><option></code> elements.

The '''returned value''' for the optiongroup element is the '''value attribute of the selected option'''.

Example:
<code><pre>
<param name="some_name" type="optiongroup" appearance="minimal" _gui-text="Some label text">
<_option value="1">First option</_option>
<_option value="2">Second option</_option>
</param>
</pre></code>

==color==
''??''

Extensions: INX widgets and parameters

2010-11-01T08:02:10Z

Flor: /* notebook */

Extensions: INX widgets and parameters

2010-11-01T08:01:25Z

Flor: /* notebook */

Extensions: INX widgets and parameters

2010-11-01T07:52:43Z

Flor: /* description */

Extensions: INX widgets and parameters

2010-11-01T07:45:36Z

Flor: /* string */

Extensions: INX widgets and parameters

2010-11-01T07:41:22Z

Flor: /* boolean */

Extensions: INX widgets and parameters

2010-11-01T07:36:26Z

Flor: /* float */

Here you will find the differents parameters you may use in your .inx files (Inkscape Extensions)

==boolean==
Gives a checkbox in the dialog; the default value may be "true" or "1", "false" or "0".

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox is limited to numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes. To set the number of decimal places, use the '''precision''' attribute.

Example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==string==
To get an character string; textbox in the dialog.

==description==
To show some text in the dialog.

==enum==
List of choices; the different choices are given by <code><item></code> elements.

==notebook==
To have different pages in the dialog; the other parameters are given inside <code><page></code> elements.

==optiongroup==
List of choices with rounded checkboxes; the different choices are given by <code><option></code> elements.

==color==
''??''

Extensions: INX widgets and parameters

2010-11-01T07:35:40Z

Flor: /* int */

Here you will find the differents parameters you may use in your .inx files (Inkscape Extensions)

==boolean==
Gives a checkbox in the dialog; the default value may be "true" or "1", "false" or "0".

==int==
To get a textbox for an '''integer''' number. Input to the textbox is limited to integer numbers with up and down buttons at the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes.

Example:
<code><pre>
<param name="some_name" type="int" min="1" max="100" _gui-text="Some label text">1</param>
</pre></code>

==float==
To get a textbox for a '''float number'''. Input to the textbox will be limited to numbers with up and down buttons on the right-hand side.

Limit the input range with the '''min''' and '''max''' attributes. To set the number of decimal places use the '''precision''' attribute.

For example:
<code><pre>
<param name="some_name" type="float" precision="3" min="0" max="9999"
_gui-text="Some label text">1.234</param>
</pre></code>

==string==
To get an character string; textbox in the dialog.

==description==
To show some text in the dialog.

==enum==
List of choices; the different choices are given by <code><item></code> elements.

==notebook==
To have different pages in the dialog; the other parameters are given inside <code><page></code> elements.

==optiongroup==
List of choices with rounded checkboxes; the different choices are given by <code><option></code> elements.

==color==
''??''