Inkscape Wiki - User contributions [en]

Extensions: INX widgets and parameters

2008-06-08T14:31:21Z

François Melchior: New page: 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", "fals...

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 an integer; sort of textbox in the dialog.

==float==
To get an float number; sort of textbox in the dialog.

==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==
''??''

INX extension descriptor format

2008-06-08T14:18:36Z

François Melchior: /* See Also */

== Introduction ==

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

== Localisation of extensions ==

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

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

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

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

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

== DTD ==

<!ELEMENT inkscape-extension (name, id, dependency*, param*,(input|output|effect),(script|plugin))>
<!ELEMENT input (extension, mimetype, filetype, filetypetooltip, output_extension?)>
<!ELEMENT output (extension, mimetype, filetype, filetypetooltip, dataloss?)>
<!ELEMENT effect (object-type|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 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>

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

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

INX extension descriptor format

2008-06-08T14:16:44Z

François Melchior: /* 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 parametres has to have "_" prepended to their name, e.g. <_name>name of extension</_name>

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

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

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

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

== DTD ==

<!ELEMENT inkscape-extension (name, id, dependency*, param*,(input|output|effect),(script|plugin))>
<!ELEMENT input (extension, mimetype, filetype, filetypetooltip, output_extension?)>
<!ELEMENT output (extension, mimetype, filetype, filetypetooltip, dataloss?)>
<!ELEMENT effect (object-type|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 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>

== See Also ==
*[[ScriptingHOWTO]]

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

INX extension descriptor format

2008-06-08T12:44:01Z

François Melchior: /* 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 parametres has to have "_" prepended to their name, e.g. <_name>name of extension</_name>

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

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

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

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

== DTD ==

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

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

== See Also ==
*[[ScriptingHOWTO]]

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