Inkscape Wiki - User contributions [en]

Tips For Python Script Extensions

2007-10-04T17:45:47Z

Scott Huey: New page: Test Category:Extensions

Test

[[Category:Extensions]]

Script extensions

2007-10-04T17:45:36Z

Scott Huey: /* See Also */

[Note: This page concerns using scripting languages to create new Inkscape functionality. To access Inkscape functionality from scripting languages (i.e. to script Inkscape), see the Inkscape man page (especially in the development version or v0.46 or later, which provide --select and --verb options), or see the work in the src/extension/script directory of Inkscape source.]

=== Introduction ===

Inkscape provides the ability for its functionality to be extended using traditional unix scripts. By this, we mean a program that takes in a stream of data through standard in, and then outputs that data on standard out. This is a very easy way to expand Inkscape, and provide custom functionality, without learning the internals of Inkscape. Plus, there are SVG read and writing libraries out there for almost any language, and the rest of them all have XML support (which is really what you probably want to use anyway). This HOWTO discusses the ends and outs of writing one of these scripts and getting it to work with the Inkscape core functionality.

=== Types of scripts ===

There are three functions that added with a script:

* Input, providing translation from a file format to SVG
* Output, providing translation from SVG to a format
* Effect, taking in SVG, changing it, and then outputing SVG

While all of these are very similar in the scripting interface, there are slight differences between them.

=== Interaction ===

It is important for a script author to understand how Inkscape and scripts communicate.

(interpreter)? your_script (--param=value)* /path/to/input[[/SVGfile]] | inkscape

Inkscape runs your script (optionally with an interpreter) passing it any number of parameters in long gnu style. The final argument is the name of the temporary svg file your script should read. After processing, the script should return the modified svg file to inkscape on STDOUT.

=== Important Tips ===

* Receive the inkscape arguments.
* Clear temp files if it creates one.
* Write full changed SVG to the default output.
* Don't break an xml:space="preserve" area.
* Send error text to the error output and help the user.

=== Description ===

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
Please see [[MakingAnINX]] for help creating an INX file for your script.

==== Parameters ====
The INX file describes which parameters the extension needs. Inkscape will prompt the user with a UI to fill out these parameters before the extension is called. Each parameter will be passed through the commandline as "--paramname=paramvalue". Eg. if you have described a string parameter with name 'string1' in the INX file, Inkscape will present a textbox to the user. When the user fills in "text" and presses OK, it will pass '--string1="text"' to the program specified by the <command> tag.

There are several types of parameters that can be requested by the INX description:

* Boolean
* Int
* Float
* String
* Description
* Enum
* Notebook
* Option group (radio buttons)

=== Installing ===

Installing is as simple as copying the script (unless it resides in your path) and its INX file to the inkscape/share/extensions (home/.inkscape/extensions) directory. (If you install a script in your home directory be sure to copy the dependencies.)

If you are looking to use scripts that have already been written, the most difficult part will likely be the installation. Since scripts are seperate programs they may have any number of dependencies that are not included with inkscape. Currently, the best way to find missing dependencies is by reading the error messages produced by running the script from the command line.

=== See Also ===

*[http://www.ekips.org/comp/inkscape/extending.php#ignorance| Aarons website] describing his path to learning how scripting extensions work. '''VERY OUT-OF-DATE'''

*[[MakingAnINX]]

*[[PythonEffectTutorial]]

*[[Tips For Python Script Extensions]]

[[Category:Extensions]]

Script extensions

2007-10-04T17:45:13Z

Scott Huey: /* See Also */

User:Scott Huey

2007-10-04T17:33:08Z

Scott Huey: Removing all content from page

User:Scott Huey

2007-10-04T17:33:02Z

Scott Huey: New page: ?

Lib2geom

2006-09-01T23:29:24Z

Scott Huey:

I've started this page on the Inkscape Wiki to help the lib2geom team with some developer documentation. As this material matures it can be moved to the "Developer Documentation" section of the wiki instead of where it currently resides. (2006-09-01 Scott Huey)

[[lib2geom FAQ]]

[[lib2geom SVN Repository Guide]]

Lib2geom

2006-09-01T23:29:04Z

Scott Huey:

I've started this page on the Inkscape Wiki to help the lib2geom team with some developer documentation. As this material matures it can be moved to the "Developer Documentaiton" section of the wiki instead of where it currently resides. (2006-09-01 Scott Huey)

[[lib2geom FAQ]]

[[lib2geom SVN Repository Guide]]

Lib2geom

2006-09-01T23:28:50Z

Scott Huey:

Inkscape

2006-09-01T23:26:29Z

Scott Huey: /* Development Discussion */

This is a freeform area for Inkscape development and discussion.
Curious about [[WikiSyntax]]?

Other languages: [[Inkscape en español|Wiki en español]], [[L'Inkscape en Català|Wiki en Català]], [[Inkscape em Português|Wiki em Português]], [[Startseite|Wiki auf Deutsch]]...

<table cellspacing="11" width="100%"><tr valign="top">
<td style="width:33%;background-color: #EFFBFF; padding:.5em; border: 1px solid #BFEEFF">
=== About Inkscape ===
* [http://www.inkscape.org/ Inkscape Homepage]
* [[About Inkscape]]
* [[InkscapeFeatures]]
* [[FAQ]] - Frequently Asked Questions
* [[ProjectInfo]]
* [[SupportedOperatingSystems]]
* [[Tools]] - Supporting Tools and Applications
* [[Galleries]]
* [[ArticlesAndPresentations]]
* [[TestimonialComments]]
* [[InkscapePopularity]]
* [[ContactInfo]] our heroes

</td><td style="width:33%;;background-color: #FFF1EF; padding:.5em; border: 1px solid #FFC7BF;margin:.5em">

=== User Documentation ===
* [[InstallHelp]]
* [[InkscapeTerminology]]
* [[UserManual]]
* [http://inkscape.org/doc/ Tutorials]
* [[InkscapeSVG|Inkscape SVG vs. Plain SVG]]
* [[GettingExtensionsWorking]]
* [[GettingEffectsWorking]]
* [[WhatEffectsDo]]
* [[UsingTheConnectorTool]]
* [[Installing Fonts as a User]]
* [[EmergencySave]]
* [[ReleaseNotes045|Release Notes]] for 0.45 (unstable)
* [[ReleaseNotes044|Release Notes]] for 0.44 and past
* [[Announcing Releases]] for 0.44 and past
* [[ArticleIntroducingInkscape0_40|Introducing Inkscape 0.40]]
* [[TricksAndTips]]
</td><td style="width:33%;background-color: #FFFAE5; padding:.5em; border: 1px solid #FFFF66; margin:.5em">

=== Help Inkscape Without Coding ===

* [[PrintingConsensusPoll]]
* [[HelpWanted]]
* [[CreatingDists]]: how to build packages
* [[WebsiteEditing]]
* [[UpdatingTrackerItems]]
* [[TutorialIdeas]]
* [[How_To_Start_A_Page]] how to use the wiki
* [[TestingInkscape]]

</td></tr></table><table cellspacing="0" width="100%" style="background-color: #FFFAE5; border-width:0em .5em; border-style:solid; border-color:white"><tr valign="top" style="padding:11px 0em 0em 11px">
<th colspan="2" align="left" style="padding:.5em 0em 0em .5em">

=== Developer Documentation ===
</th></tr><tr valign="top" align="left"><td style="width:50%;padding:.5em">
==== General ====
* [[DeveloperManual]]
* [[CompilingInkscape]]
* [[WorkingWithSVN]]
* [[HandlingPreferences]]: creating and using preference values
* [[AddSPObject]]: how to add a new SPObject type
* [[ReprListeners]]: responding to XML doc changes
* [[ErrorsAndWarnings]]: how to deal with reporting errors, warnings, and other messages
* [[DebuggingTips]]: random tips to help debug problems

* [[DeveloperTitles]]: terms for various roles in Inkscape
* [[InkscapeJanitors]]: small tasks that need doing
* [http://livarot.sourceforge.net/ Livarot]: for boolean ops
* [[ExtensionAttributes]]: currently defined attributes in Inkscape's XML namespace and what they do
* [[MakingAnExtension]]: how extension must work and how to write an INX file
* [[ExtensionsRepository]]: an Internet central for Inkscape Extensions
* [[OtherProjects]] (outside links)

</td><td style="width:50%;padding:.5em">

==== Development Discussion ====
* [[Roadmap]]: the main todo list
* [[NewFeatureProposals]]
* [[ExtensionArchitectureProposals]]
* [[Coding Style|Coding Style Discussion]]
* [[FileTypes]]
* [[ApplicationIcons]] ( Application + Interface )
* [[InkscapeColor]]
* [[PrintingSubsystem]]
* [[SVG Competitors Plan]] - MS WVG vs SVG, etc
* [[SVG Tiny Compliance]]
* [[SVG Test Suite Compliance]] - [[W3C]] full test suite
* [[CSS Support]]
* [[OpenVG]] Standard (draft)
* [[OpenDocument proposal]]
* [[Googles Summer Of Code]]
* [[UI MockupScreenshots]]
* [[lib2geom]]

</td></tr><tr valign="top" align="left"><td style="width:50%;padding:.5em">

==== User Interface Discussion ====
* [[Translation_information]]
* [[AccessibleGraphics]]
* [[ObjectManager]]
* [[DialogsReorganization]]
* [[DialogReplacement]]
* [[ModalInterfaces]]
* [[TextUsability]]: text tool /dialog dialog
* [[KeyboardShortcutsToDo]]
** [[KeyboardProfiles]]: how you can help
* [[StatusbarAPI]]
* [[Animation-(Timeline)]]
* [[Free Desktop Graphic Suite]]

</td><td style="width:50%;padding:.5em">
==== Rearchitecture Discussion ====
* [[SubsystemRearchitecture]]
* [[GtkMMification]]: replace C boilerplate with gtkmm objects
* [[PathRepresentation]]
* [[Cairoification]]
* [[ScribusInteroperability]]

</td></tr></table>

----
* [[WikiAttic]]: pages that are no longer relevant but kept for historical value

__NOTOC__

[[Category:About Inkscape]]
[[Category:User Documentation]]