Extensions - Revision history

Pulsar17: Move documentation.

2022-03-10T20:42:56Z

Move documentation.

← Older revision		Revision as of 20:42, 10 March 2022
Line 1:		Line 1:
	~~This page is intended as a guide~~ for ~~providing~~ new extensions ~~for Inkscape. Currently the majority of extensions are provided as python scripts.~~		The documentation for writing new extensions has been moved to the [https://inkscape.gitlab.io/extensions/documentation/authors/index.html documentation of the extensions repository.]

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

Flor: /* Parameters */

2010-11-01T11:02:50Z

Parameters

← Older revision		Revision as of 11:02, 1 November 2010
Line 33:		Line 33:
	* '''notebook'''		* '''notebook'''

	See also [[INX Parameters]]		See also: [[INX Parameters]]

	==Extension Definition File (INX)==		==Extension Definition File (INX)==

Flor: /* Extension types */

2010-11-01T11:02:31Z

Extension types

← Older revision		Revision as of 11:02, 1 November 2010
Line 8:		Line 8:
	* '''print'''		* '''print'''
	* '''''path-effect''''' - path effects are '''not''' currently implemented as extension but there is intention to migrate those over as entensions		* '''''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==		==Extension implementation==

Flor: /* Parameters */

2010-11-01T11:01:09Z

Parameters

← Older revision		Revision as of 11:01, 1 November 2010
Line 30:		Line 30:
	* '''description'''		* '''description'''
	* '''notebook'''		* '''notebook'''

			See also [[INX Parameters]]

	==Extension Definition File (INX)==		==Extension Definition File (INX)==

Mfloryan: /* RadioButton example */

2008-04-18T15:10:18Z

RadioButton example

← Older revision		Revision as of 15:10, 18 April 2008
Line 62:		Line 62:
	</pre>		</pre>
	Will result in the following GUI being created:		Will result in the following GUI being created:

	[[Image:Extensions-radiobutton_gui_example.png]]		[[Image:Extensions-radiobutton_gui_example.png]]

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

Mfloryan: /* RadioButton example */

2008-04-18T15:09:36Z

RadioButton example

← Older revision		Revision as of 15:09, 18 April 2008
Line 36:		Line 36:
	===Examples===		===Examples===
	====RadioButton example====		====RadioButton example====
			The following mark-up:
	<pre>		<pre>
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
Line 60:		Line 61:
	</inkscape-extension>		</inkscape-extension>
	</pre>		</pre>
			Will result in the following GUI being created:
			[[Image:Extensions-radiobutton_gui_example.png]]

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

Mfloryan: initiated new page. Hopefuly more will come here

2008-04-18T15:04:43Z

initiated new page. Hopefuly more will come here

New page

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

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