INX extension descriptor format

From Inkscape Wiki
Revision as of 16:34, 16 November 2006 by Acspike (talk | contribs) (MakingAnExtension moved to MakingAnINX: the old page was duplicating information. I'm rolling that information into ScriptingHOWTO and moving all INX information here to be fleshed out.)
Jump to navigation Jump to search

How an extension must work and how to write an INX file.

About the Inkscape Extension Interface

The inkscape call a program with some arguments and as the last argumet it tells to the extension program where is the temporay SVG file to do the work. The temporay SVG file represents the actual state of the working SVG.

After the extension program work it writes the modified SVG to the default output, the Inkscape get this and update the SVG for the user.

How to Write an INX File


   <_name>{Friendly Extension Name}</_name>
     <dependency type="executable"
     <param name="{argumentName}" type="[int|float|string]"
            min="{number}" max="{number}"
            _gui-text="{Friendly Argument Name}">{default value}</param>
     <object-type>[all|{element type}]</object-type>
         <submenu _name="{Extension Group Name}"/>
     <command reldir="extensions"
              interpreter="[python|perl|bash|{some other}]">program.ext</command>

See Also