Difference between revisions of "Extension requirements"

From Inkscape Wiki
Jump to navigation Jump to search
(Reformated the page to have headers and moved mac os x info to here)
m (→‎on Debian GNU / Linux: current extensions depend on python-lxml (python-xml is no longer required))
(21 intermediate revisions by 9 users not shown)
Line 1: Line 1:
== Setting Up Effects in Inkscape ==
{{Other languages|en=Effect requirements}}
<i>For effects to work you need to be using inkscape .42 or later.</i><br>
<i>For info about what effects can do, screenshots, and how to make your own go to [http://www.ekips.org/comp/inkscape/ Aarons Site]</i><br>
<i>See also [[GettingExtensionsWorking]].</i><br>
 
 
=== Unhide the Effects menu ===
(Only necessary in some versions of Inkscape. Between .41 and .45)
 
On the "Misc" tab of the "Inkscape Preferences" dialog check the box labeled "Enable script effects" (0.41+CVS onwards only)
 
Close and reopen Inkscape


For info about what effects can do, screenshots, and how to make your own go to [http://www.ekips.org/comp/inkscape/ Aarons Site]
If you are interested in opening special file formats through extensions, see  [[GettingExtensionsWorking]].


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


=== on Microsoft Windows ===
=== on Microsoft Windows ===
[[GettingEffectsWorking/Windows]] Tutorial on Getting Effects to work on Windows
From version .44 onwards, Inkscape now includes Python in the download, and has effects <i>enabled</i> by default.
The latest stable Inkscape version includes Python 2.6.5.


=== on Mac OS X ===
=== on Mac OS X ===


Mac OS X ships with python but without some packages that Inkscape uses: [http://pyxml.sourceforge.net/ pyXML] (which will be suppressed in version 0.46), [http://numpy.scipy.org/ numpy] and [http://codespeak.net/lxml/ lxml]
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 ====
==== Binary packages ====
You can install a binary version compiled by us, downloadable with the development builds of Inkscape:
 
:http://inkscape.modevia.com/macosx-snap/?M=D
# Download and open http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
You need to copy the folders for pyXML (_xmlplus), numpy (numpy) and lxml (*lxml*.egg or lxml) to /System/Library/Frameworks/Python.framework/Versions/2.3/lib/python2.3/site-packages (there is a link in the dmg on which the folders can be dropped).
# 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 ====
If you prefer, you can install them from source, it is really easy.
If you prefer, you can install them from source, it is really easy.


'''pyXML'''
# download the source code for [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] and/or [http://codespeak.net/lxml/index.html#download lxml download section]
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=6473 sourceforge]
# unpack the <code>.tar.gz</code> file <pre>tar -xzf numpy***.tar.gz lxml***.tar.gz</pre>
# unpack the <code>.tar.gz</code> file
# for each one <code>cd</code> into the newly created directory
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator privileges)<pre>sudo python setup.py install</pre>and type your password.
# set the variable <code>MACOSX_DEPLOYMENT_TARGET</code> to version of your operating system (10.3 for Panther, 10.4 for Tiger, 10.5 for Leopard. It probably won't work on previous systems). In bash syntax this means typing:<pre>export MACOSX_DEPLOYMENT_TARGET=10.?</pre>
# move the python files and build C extensions by just typing <pre>python setup.py build</pre>
# install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.


'''numpy and lxml'''
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.
# download the source code from [http://sourceforge.net/project/showfiles.php?group_id=1369&package_id=175103 sourceforge numpy repository] or [http://codespeak.net/lxml/index.html#download lxml download section]
# unpack the <code>.tar.gz</code> file
# cd into the newly created directory
# build C extensions and install (the install is system wide so you need administrator rights)<pre>sudo python setup.py install</pre>and type your password.


== Perl Effects ==
== Perl Effects ==
Line 63: Line 51:
      http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
      http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
         3: open command prompt and locate perl"s lib directory with:
         3: open command prompt and locate perl"s lib directory with:
      perl -e "print qq(@INC)"    (mine was C:[[/Perl/site/lib]])
      perl -e "print qq(@INC)"    (mine was C:/Perl/site/lib)
         4: unpack xml-xql archive
         4: unpack xml-xql archive
         5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML
         5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML

Revision as of 09:32, 18 July 2012

Other languages: العربية Català Česky Deutsch English Español Français Italiano 日本語 한국어 Polski Português Português do Brasil Русский Slovenčina 中文

For info about what effects can do, screenshots, and how to make your own go to Aarons Site If you are interested in opening special file formats through extensions, see GettingExtensionsWorking.

Python Effects

on Debian GNU / Linux

   apt-get install python python-lxml

on Microsoft Windows

From version .44 onwards, Inkscape now includes Python in the download, and has effects enabled by default. The latest stable Inkscape version includes Python 2.6.5.

on Mac OS X

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

  1. Download and open http://inkscape.modevia.com/macosx-snap/Python-packages.dmg
  2. 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
  3. 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

If you prefer, you can install them from source, it is really easy.

  1. download the source code for sourceforge numpy repository and/or lxml download section
  2. unpack the .tar.gz file
    tar -xzf numpy***.tar.gz lxml***.tar.gz
  3. for each one cd into the newly created directory
  4. build C extensions and install (the install is system wide so you need administrator privileges)
    sudo python setup.py install
    and type your password.

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

on Debian GNU / Linux

   apt-get install perl libxml-xql-perl

on Gentoo GNU / Linux

   emerge -a XML-XQL

on Microsoft Windows

   install ActivePerl
   install XML::XQL::DOM (perhaps like this?)
       1: install prereqs with ppm:
	    install xml-dom
	    install parse-yapp
	    install datemanip
       2: download xml-xql from:
	    http://www.cpan.org/authors/id/T/TJ/TJMATHER/XML-XQL-0.68.tar.gz
       3: open command prompt and locate perl"s lib directory with:
	    perl -e "print qq(@INC)"    (mine was C:/Perl/site/lib)
       4: unpack xml-xql archive
       5: copy contents of XML-XQL-*\lib\XML into C:\Perl\site\lib\XML
       6: copy XML-XQL-*\XQLParser\Parser.pm to C:\Perl\site\lib\XML\XQL

Plugin Effects

I have absolutely no idea. Please record your success here. :)

What if it doesn't work?

Run Inkscape from the console

Use the error messges 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"