Extension requirements - Revision history

Moini at 19:54, 3 February 2023

2023-02-03T19:54:15Z

← Older revision		Revision as of 19:54, 3 February 2023
Line 1:		Line 1:
	{{~~Other languages~~\|en=Extension ~~requirements~~}}		{{Template:MovedToOtherSite\|topic=Extension development\|new_url=https://inkscape.gitlab.io/extensions/documentation/\|new_site=GitLab}}

	This page is '''outdated''' ~~and needs an overhaul. If you can help with updating the page, please contact the [https://inkscape.org/en/community/mailing-lists/ Inkscape developers mailing list, or the docs mailing list]~~.		----

			This page is '''outdated'''.

Patrick87: /* Plugin Extensions */

2019-09-19T20:49:23Z

Plugin Extensions

← Older revision		Revision as of 20:49, 19 September 2019
Line 69:		Line 69:
	Plugins are a special type of extension that are similar to internal extensions. They're written in C/C++ and can directly interface with Inkscape itself. However, they're linked into a separate library that is dynamically loaded at runtime.		Plugins are a special type of extension that are similar to internal extensions. They're written in C/C++ and can directly interface with Inkscape itself. However, they're linked into a separate library that is dynamically loaded at runtime.

	While this makes them very powerful, they're also significantly harder to code and need to be compiled before being usable. Also the compiled library will be OS/platform-dependent and not even be compatible between different versions of Inkscape on a single platform.		While this makes them very powerful, they're also significantly harder to code and need to be compiled before being usable. Also the compiled library will be OS/platform-dependent and might not even be compatible between different versions of Inkscape on a single platform.

	See the [https://gitlab.com/inkscape/inkscape/tree/master/src/extension/plugins/grid2 grid2 extension] for a working prototype of this extension type. If you have an Inkscape development environment set-up		See the [https://gitlab.com/inkscape/inkscape/tree/master/src/extension/plugins/grid2 grid2 extension] for a working prototype of this extension type. If you have an Inkscape development environment set-up

Patrick87: /* Plugin Extensions */ - basic info

2019-09-19T20:48:42Z

Plugin Extensions: - basic info

← Older revision		Revision as of 20:48, 19 September 2019
Line 65:		Line 65:
	6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL		6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

	== Plugin ~~Extensionss~~ ==		== Plugin Extensions ==
	~~I have absolutely no idea~~. ~~Please record your success here~~. :)
			Plugins are a special type of extension that are similar to internal extensions. They're written in C/C++ and can directly interface with Inkscape itself. However, they're linked into a separate library that is dynamically loaded at runtime.

			While this makes them very powerful, they're also significantly harder to code and need to be compiled before being usable. Also the compiled library will be OS/platform-dependent and not even be compatible between different versions of Inkscape on a single platform.

			See the [https://gitlab.com/inkscape/inkscape/tree/master/src/extension/plugins/grid2 grid2 extension] for a working prototype of this extension type. If you have an Inkscape development environment set-up
			* compile/link with "make grid2"
			* copy the linked library (libgrid2.dll/so) and the libgrid2.inx file into the "/extensions" folder.
			* run from "Render -> Grids -> Grid2"

	== What if it doesn't work? ==		== What if it doesn't work? ==

Moini: /* What if it doesn't work? */

2017-03-19T16:31:05Z

What if it doesn't work?

← Older revision		Revision as of 16:31, 19 March 2017
Line 73:		Line 73:
	* Use the error messages printed to the console to diagnose the problem (very often missing dependencies)		* Use the error messages printed to the console to diagnose the problem (very often missing dependencies)
	* On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"		* On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"
	* If your operating system (e.g. your Linux distro) uses a different default version of Python (or Perl, Ruby, etc.) than what is required by Inkscape extensions, please see [[Extension_Interpreters#Selecting_a_specific_interpreter_version_.28via_preferences_file.29]] for how to set the interpreter that Inkscape will use. The most common example of this is that the default Python version of the operating system is 3, but Inkscape requires Python2, resulting in all extensions giving an error.		* If your operating system (e.g. your Linux distro) uses a different default version of Python (or Perl, Ruby, etc.) than what is required by Inkscape extensions, please see [[Extension_Interpreters#Selecting_a_specific_interpreter_version_.28via_preferences_file.29 \| Extension Interpreters]] for how to set the interpreter that Inkscape will use. The most common example of this is that the default Python version of the operating system is 3, but Inkscape requires Python2, resulting in all extensions giving an error.


	[[Category:Extensions]]		[[Category:Extensions]]

Moini: /* What if it doesn't work? */ Layout improvement

2017-03-19T16:28:34Z

What if it doesn't work?: Layout improvement

← Older revision		Revision as of 16:28, 19 March 2017
Line 69:		Line 69:

	== What if it doesn't work? ==		== What if it doesn't work? ==
	~~Run Inkscape from the console~~

	Use the error messages printed to the console to diagnose the problem (very often missing dependencies)		* Run Inkscape from the console
			* Use the error messages printed to the console to diagnose the problem (very often missing dependencies)
	On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"		* On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"
			* If your operating system (e.g. your Linux distro) uses a different default version of Python (or Perl, Ruby, etc.) than what is required by Inkscape extensions, please see [[Extension_Interpreters#Selecting_a_specific_interpreter_version_.28via_preferences_file.29]] for how to set the interpreter that Inkscape will use. The most common example of this is that the default Python version of the operating system is 3, but Inkscape requires Python2, resulting in all extensions giving an error.
	If your operating system (e.g. your Linux distro) uses a different default version of Python (or Perl, Ruby, etc.) than what is required by Inkscape extensions, please see [[Extension_Interpreters#Selecting_a_specific_interpreter_version_.28via_preferences_file.29]] for how to set the interpreter that Inkscape will use. The most common example of this is that the default Python version of the operating system is 3, but Inkscape requires Python2, resulting in all extensions giving an error.


	[[Category:Extensions]]		[[Category:Extensions]]

Moini: /* What if it doesn't work? */ Add hint about setting interpreter executable for script extensions.

2017-03-19T16:27:36Z

What if it doesn't work?: Add hint about setting interpreter executable for script extensions.

← Older revision		Revision as of 16:27, 19 March 2017
Line 74:		Line 74:

	On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"		On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"

			If your operating system (e.g. your Linux distro) uses a different default version of Python (or Perl, Ruby, etc.) than what is required by Inkscape extensions, please see [[Extension_Interpreters#Selecting_a_specific_interpreter_version_.28via_preferences_file.29]] for how to set the interpreter that Inkscape will use. The most common example of this is that the default Python version of the operating system is 3, but Inkscape requires Python2, resulting in all extensions giving an error.


	[[Category:Extensions]]		[[Category:Extensions]]

Moini: Add info about how to help update

2016-03-15T12:02:10Z

Add info about how to help update

← Older revision		Revision as of 12:02, 15 March 2016
Line 1:		Line 1:
	{{Other languages\|en=Extension requirements}}		{{Other languages\|en=Extension requirements}}

	This page is '''outdated''' and needs an overhaul. For '''alternative information sources''', see:		This page is '''outdated''' and needs an overhaul. If you can help with updating the page, please contact the [https://inkscape.org/en/community/mailing-lists/ Inkscape developers mailing list, or the docs mailing list].


			For '''alternative information sources''', see also:

	* The extensions error log in your Inkscape user configuration directory, in case an extension doesn't work. It will list missing dependencies for each extension.		* The extensions error log in your Inkscape user configuration directory, in case an extension doesn't work. It will list missing dependencies for each extension.

Moini: Update, remove dead links, add links to alternative info sources

2016-03-15T11:41:53Z

Update, remove dead links, add links to alternative info sources

← Older revision		Revision as of 11:41, 15 March 2016
Line 1:		Line 1:
	{{Other languages\|en=~~Effect~~ requirements}}		{{Other languages\|en=Extension requirements}}

	~~For info about what effects can do, screenshots,~~ and ~~how to make your own go to [http://www~~.~~ekips.org/comp/inkscape/ Aarons Site]~~		This page is '''outdated''' and needs an overhaul. For '''alternative information sources''', see:
	~~If you are interested in opening special file formats through extensions~~, see ~~[[GettingExtensionsWorking]].~~

	== Python ~~Effects~~ ==		* The extensions error log in your Inkscape user configuration directory, in case an extension doesn't work. It will list missing dependencies for each extension.

			* For info about how to make your own:
			** go to [https://inkscape.org/en/develop/extensions/ the corresponding page on our main website]
			** also take a look at these Wiki articles: [[Script_extensions \| Script Extensions]], [[INX_extension_descriptor_format \| INX Extension Descriptor Format]], [[Inkscape-specific_XML_attributes \| Inkscape-Specific XML attributes]]

			* If you are interested in opening special file formats through extensions, see [[GettingExtensionsWorking]].

			* More info about existing extensions can be found
			** [https://inkscape.org/en/download/addons/ in our website's addon gallery]
			** and in the [[Extension_repository \| Extension Repository page]] of the Wiki.




			== Python Extensions ==
	=== on Debian GNU / Linux ===		=== on Debian GNU / Linux ===
	apt-get install python python-lxml		apt-get install python python-lxml

	=== on Microsoft Windows ===		=== on Microsoft Windows ===
	From version .44 onwards, Inkscape now includes Python in the download, and has ~~effects~~ <i>enabled</i> by default.		From version .44 onwards, Inkscape now includes Python in the download, and has extensions <i>enabled</i> by default.
	The latest stable Inkscape version includes Python 2.6.5.		The latest stable Inkscape version includes Python 2.6.5.

Line 26:		Line 40:
	The packages are installed in the site-packages directory of your Python install. This is /Library/Python/2.*/site-packages for the stock install of Python on Mac OS X.		The packages are installed in the site-packages directory of your Python install. This is /Library/Python/2.*/site-packages for the stock install of Python on Mac OS X.

	== Perl ~~Effects~~ ==		== Perl Extensions ==
	=== on Debian GNU / Linux ===		=== on Debian GNU / Linux ===
	apt-get install perl libxml-xql-perl		apt-get install perl libxml-xql-perl
Line 48:		Line 62:
	6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL		6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

	== Plugin ~~Effects~~ ==		== Plugin Extensionss ==
	I have absolutely no idea. Please record your success here. :)		I have absolutely no idea. Please record your success here. :)

Line 54:		Line 68:
	Run Inkscape from the console		Run Inkscape from the console

	Use the error ~~messges~~ printed to the console to diagnose the problem (very often missing dependencies)		Use the error messages printed to the console to diagnose the problem (very often missing dependencies)

	On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"		On Windows you will have to redirect output to a text file like this: "inkscape > output.txt"

Moini: Moini moved page Effect requirements to Extension requirements

2016-03-15T11:22:38Z

Moini moved page Effect requirements to Extension requirements

← Older revision

Revision as of 11:22, 15 March 2016

~suv: /* Binary packages */ outdated, package at modevia no longer available.

2014-12-15T01:14:38Z

Binary packages: outdated, package at modevia no longer available.

← Older revision		Revision as of 01:14, 15 December 2014
Line 15:		Line 15:

	Starting with version 0.46, Inkscape contains the python packages needed for the extension system. All python extensions should work out of the box. However in case you still have trouble you can install them in their regular location.		Starting with version 0.46, Inkscape contains the python packages needed for the extension system. All python extensions should work out of the box. However in case you still have trouble you can install them in their regular location.

	~~==== Binary packages ====~~

	~~# Download and open http://inkscape.modevia.com/macosx-snap/Python-packages.dmg~~
	~~# Browse the disk image to find the packages corresponding to your architecture and Python version~~
	~~#* Your architecture is ppc if you have a G4-G5 based Mac, i386 if you have an Intel Mac~~
	~~#* By default Panther and Tiger have Python 2.3 and Leopard has Python 2.5. If you have installed a newer version of Python we also provide packages for 2.4~~
	# Copy all the files and folder from the appropriate location to your Python site-packages directory. By default the site-packages directory is /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages on Panther and Tiger, /Library/Python/2.5/site-packages on Leopard. Otherwise it is somewhere in your custom install of python (/opt/local/Library/Frameworks/Python.framework/Versions/2.4/lib/python2.4/site-packages/ for an install of Python 2.4 via MacPorts for example)

	==== Compiling from source ====		==== Compiling from source ====