Updating your Extension for 1.0 - Revision history

Joneuhauser: move documentation

2022-03-03T19:02:43Z

move documentation

Joneuhauser at 08:55, 11 February 2022

2022-02-11T08:55:49Z

← Older revision		Revision as of 08:55, 11 February 2022
Line 194:		Line 194:
	Visit https://gitlab.com/inkscape/extensions, fork the repository, and create a merge request on GitLab.		Visit https://gitlab.com/inkscape/extensions, fork the repository, and create a merge request on GitLab.

			== External links ==
			A script to perform some of the conversion steps automatically has been contributed: https://gitlab.com/inkscape/extensions/-/issues/380
	[[Category:Extensions]]		[[Category:Extensions]]

Neon22: optiongroup updates for clarity

2020-08-20T10:18:48Z

optiongroup updates for clarity

← Older revision		Revision as of 10:18, 20 August 2020
Line 47:		Line 47:
	There are also some updates to the parameter definitions in .inx files. While these are intended to be backwards compatible to 0.92, you may wish to review the changes below:		There are also some updates to the parameter definitions in .inx files. While these are intended to be backwards compatible to 0.92, you may wish to review the changes below:

	* '''Underscores''' in inx parameter tags and attributes for translation '''can be dropped''' entirely. Use <code>translatable="no"</code> to make an item (e.g.e a unit name) untranslatable.		* '''Underscores''' in inx parameter tags and attributes for translation '''can be dropped''' entirely. Use <code>translatable="no"</code> to make an item (e.g. a unit name) untranslatable.
	* <code>boolean</code> can be renamed to <code>bool</code>		* <code>boolean</code> can be renamed to <code>bool</code>
	* <code><param type="enum" /></code> is deprecated, instead use optiongroups ~~for~~ dropdown selections (comboboxes) and radio buttons (e.g. <code><param type="optiongroup" appearance="combo" /></code>, or <code><param type="optiongroup" appearance="radio" /></code>).		* <code><param type="enum" /></code> is deprecated, instead use optiongroups. Remember to rename <code><item></code> to <code><option></code> when replacing.
	* Appearance value <code>minimal</code> is deprecated		* In optiongroups <code>appearance="minimal"</code> is deprecated.
			** In optiongroups you can now define dropdown selections (comboboxes) and radio buttons.
			** i.e. <code><param type="optiongroup" appearance="combo" /></code>, or <code><param type="optiongroup" appearance="radio" /></code>.
	* Choosing files / folders with <code><param type="path" /></code> (these return the path as a string to the Python script):		* Choosing files / folders with <code><param type="path" /></code> (these return the path as a string to the Python script):
	** Files:		** Files:

Moini: /* Remove dependency listings */

2020-04-11T14:33:48Z

Remove dependency listings

← Older revision		Revision as of 14:33, 11 April 2020
Line 41:		Line 41:

	This change is backwards compatible (as long as the user has a fully functioning Inkscape installation).		This change is backwards compatible (as long as the user has a fully functioning Inkscape installation).
	Not removing these will result in the extension not being selectable (disabled) in Inkscape 1.0 or higher.		Not removing these will result in the extension not being selectable (disabled and greyed out) in Inkscape 1.0 or higher.

	=== Changes to parameter definitions ===		=== Changes to parameter definitions ===

KBenoit: Add syntax highlighting

2020-04-09T16:09:29Z

Add syntax highlighting

← Older revision		Revision as of 16:09, 9 April 2020
Line 12:		Line 12:
	An extension that uses the following snippet:		An extension that uses the following snippet:

	<~~pre~~>		<source lang="xml">
	<script>		<script>
	<command location="inx" interpreter="python">hello.py</command>		<command location="inx" interpreter="python">hello.py</command>
	</script>		</script>
	</~~pre~~>		</source>

	can be put into any subfolder in <code>extensions</code> or into the <code>extensions</code> folder itself, as long as the file <code>hello.py</code> is in that same folder, at the same hierarchy level.		can be put into any subfolder in <code>extensions</code> or into the <code>extensions</code> folder itself, as long as the file <code>hello.py</code> is in that same folder, at the same hierarchy level.

KBenoit: Highlight the source

2020-04-09T16:06:33Z

Highlight the source

← Older revision		Revision as of 16:06, 9 April 2020
Line 72:		Line 72:
	<div class="mw-collapsible mw-collapsed" style="overflow:auto;">		<div class="mw-collapsible mw-collapsed" style="overflow:auto;">

	<~~pre~~>		<source lang="xml>
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<inkscape-extension xmlns="http://www.inkscape.org/namespace/inkscape/extension">		<inkscape-extension xmlns="http://www.inkscape.org/namespace/inkscape/extension">
Line 142:		Line 142:
	</script>		</script>
	</inkscape-extension>		</inkscape-extension>
	</~~pre~~>		</source>
	</div>		</div>

Moini: Add info about subdirs for extensions.

2020-03-15T23:39:11Z

Add info about subdirs for extensions.

← Older revision		Revision as of 23:39, 15 March 2020
Line 1:		Line 1:
	This is a preliminary and incomplete list of actions to take for updating Python extensions for Inkscape 1.0:		This is a preliminary and incomplete list of actions to take for updating Python extensions for Inkscape 1.0:

			== Adjusting folder structure ==

			For easier extension 'installation' by users and for having a better overview about the installed extensions, you can now put extensions into their own subfolders of the <code>extensions</code> directory. This is optional.

			When specifying the command in the .inx file, you can use the new parameter 'location'.

			* If you set <code>location="extensions"</code> (de-facto default in 0.92.x), it will assume the path is relative to either user or system extensions folder.
			* If it's <code>location="inx"</code> (new and recommended in 1.0), it will assume the path is relative to the .inx file location.

			An extension that uses the following snippet:

			<pre>
			<script>
			<command location="inx" interpreter="python">hello.py</command>
			</script>
			</pre>

			can be put into any subfolder in <code>extensions</code> or into the <code>extensions</code> folder itself, as long as the file <code>hello.py</code> is in that same folder, at the same hierarchy level.

			The old parameter <code>reldir</code> is deprecated. It is recommended to use Unix style path separators (i.e. <code>/</code>), if your script file is located in a nested subdirectory (should be a very rare case).

	== Updating *.inx files ==		== Updating *.inx files ==

Doctormo at 13:55, 8 March 2020

2020-03-08T13:55:54Z

← Older revision		Revision as of 13:55, 8 March 2020
Line 130:		Line 130:
	# Instead of <code>inkex.Effect.OptionParser.add_option</code>, your extension should now use <code>inkex.Effect.arg_parser.add_argument</code>.		# Instead of <code>inkex.Effect.OptionParser.add_option</code>, your extension should now use <code>inkex.Effect.arg_parser.add_argument</code>.
	# The 'type' option now works with variables instead of strings. Use <code>int</code> instead of <code>"int"</code> (same for float,...).		# The 'type' option now works with variables instead of strings. Use <code>int</code> instead of <code>"int"</code> (same for float,...).
	# The 'inkbool' type is now <code>inkex.~~inkbool~~</code>.		# The 'inkbool' type is now <code>inkex.Boolean</code>.
	# <code>action="store"</code> can be removed.		# <code>action="store"</code> can be removed.

Moini: /* Updating .inx files /

2020-02-08T20:25:40Z

Updating *.inx files

← Older revision		Revision as of 20:25, 8 February 2020
Line 20:		Line 20:

	This change is backwards compatible (as long as the user has a fully functioning Inkscape installation).		This change is backwards compatible (as long as the user has a fully functioning Inkscape installation).
	Not removing these will result in the extension not being selectable (~~greyed out~~) in Inkscape 1.0 or higher.		Not removing these will result in the extension not being selectable (disabled) in Inkscape 1.0 or higher.

	=== Changes to parameter definitions ===		=== Changes to parameter definitions ===

Moini: /* Changes to parameter definitions */

2020-02-08T03:33:54Z

Changes to parameter definitions

← Older revision		Revision as of 03:33, 8 February 2020
Line 32:		Line 32:
	* Choosing files / folders with <code><param type="path" /></code> (these return the path as a string to the Python script):		* Choosing files / folders with <code><param type="path" /></code> (these return the path as a string to the Python script):
	** Files:		** Files:
	*** Choose a file, with file type restriction (optional): <code><param name="~~param_file~~" type="path" mode="file" filetypes="png,jpg" gui-text="A file:">my/path/to/file.png</param></code>		*** Choose a file, with file type restriction (optional): <code><param name="my_file" type="path" mode="file" filetypes="png,jpg" gui-text="A file:">my/path/to/file.png</param></code>
	*** Choose multiple files (file type restriction possible, too): <code><param name="~~param_files~~" type="path" mode="files" gui-text="Multiple files:">my/path/to/file.png</param></code>		*** Choose multiple files (file type restriction possible, too): <code><param name="my_files" type="path" mode="files" gui-text="Multiple files:">my/path/to/file.png</param></code>
	*** Create a new file: <code><param name="~~param_file_new~~" type="path" mode="file_new" filetypes="png" gui-text="A new file:">my/path/to/file.png</param></code>		*** Create a new file: <code><param name="my_new_file" type="path" mode="file_new" filetypes="png" gui-text="A new file:">my/path/to/file.png</param></code>
	** Folders:		** Folders:
	*** Choose a folder: <code><param name="~~param_folder~~" type="path" mode="folder" gui-text="A folder:">my/path/</param></code>		*** Choose a folder: <code><param name="my_folder" type="path" mode="folder" gui-text="A folder:">my/path/</param></code>
	*** Choose multiple folders: <code><param name="~~param_folders~~" type="path" mode="folders" gui-text="Folders:">my/path/</param></code>		*** Choose multiple folders: <code><param name="my_folders" type="path" mode="folders" gui-text="Folders:">my/path/</param></code>
	*** Create a new folder: <code><param name="~~param_folder_new~~" type="path" mode="folder_new" filetypes="png" gui-text="A new folder:">my/path/</param></code>		*** Create a new folder: <code><param name="my_new_folder" type="path" mode="folder_new" filetypes="png" gui-text="A new folder:">my/path/</param></code>
	* Color choosers: make them more compact with <code>appearance="colorbutton"</code> for parameters of type <code>color</code>		* Color choosers: make them more compact with <code>appearance="colorbutton"</code> for parameters of type <code>color</code>
	* Multiline text entry fields are available with <code>appearance="multiline"</code> for parameters of type <code>string</code>		* Multiline text entry fields are available with <code>appearance="multiline"</code> for parameters of type <code>string</code>