Difference between revisions of "INX extension descriptor format"

From Inkscape Wiki
Jump to navigation Jump to search
(→‎Attributes description: clarify "needs-document" (can likely be dropped in future as it was only important for help menu extensions which were dropped for 1.0)
(Move documentation)
Tags: Replaced Visual edit
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Introduction ==
This page previously contained information on the *.inx file format. The information is now found at [https://inkscape.gitlab.io/extensions/documentation/authors/inx-overview.html the extensions documentation].
 
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
* etc
Be sure to read through the INX files that come with Inkscape. Nothing beats a working example.
 
== Translation of extensions ==
 
Extension dialog windows, described in INX files, can be prepared for translation or localisation by adding an <code>_</code> (underscore) to the XML tags or attributes. Only add underscores when text need to be translated (not numeric values, for example!).
 
Example:
<pre>
<_name>Some translatable extension name</_name>
</pre>
 
Or:
<pre>
<param name="..." type="..." _gui-text="Some translatable label text">
</pre>
 
When extensions are included in the [https://gitlab.com/inkscape/extensions Inkscape Extensions Repository], various scripts will scan each INX file for translatable text and prepare [https://gitlab.com/inkscape/inkscape/-/tree/master/po translation files] for others to translate.
 
See also: [http://gould.cx/ted/blog/Translating_Custom_XML Ted's blog].
 
 
== Attributes description ==
 
{| class="wikitable"
|-
! Attribute name
! Allowed values
! Comment
|-
| <code>implements-custom-gui</code> (''new in 1.0'')
| <code>"true"</code> <nowiki>|</nowiki> <code>"false"</code> ''(default)''
| If set to <code>true</code> '''requires''' effect extension to implement custom GUI. Implementation detail: "extension is working" window is not show for this kind of extensions.
|-
| <code>needs-document</code>
| <code>"true"</code> ''(default)'' <nowiki>|</nowiki> <code>"false"</code>
| If set to <code>false</code> the effect extension will not be passed a document nor will a document be read back ("no-op" effect). This is currently a hack to make extension manager work and will likely be removed/replaced in future, so use at your '''own risk'''!
|-
| <code>needs-live-preview</code>
| <code>"true"</code> ''(default)'' <nowiki>|</nowiki> <code>"false"</code> (default)
| '''''(please fill in!)'''''
|-
|}
 
== Example ==
More example INX files are available in the Inkscape distribution, which takes its files from the [https://gitlab.com/inkscape/extensions Inkscape Extensions Repository].
 
<small><pre>
<?xml version="1.0" encoding="UTF-8"?>
<inkscape-extension xmlns="http://www.inkscape.org/namespace/inkscape/extension">
  <_name>{Friendly Extension Name}</_name>
  <id>{org.domain.sub-domain.extension-name}</id>
  <dependency type="executable" location="[extensions|path|plugins|{location}]">program.ext</dependency>
  <param name="tab" type="notebook"> 
    <page name="controls" _gui-text="Controls">
      <param name="{argumentName}" type="[int|float|string|boolean|description]" min="{number}" max="{number}"
        _gui-text="{Friendly Argument Name}">{default value}</param>
    </page>
    <page name="help" _gui-text="Help">
      <param name="help_text" type="description">{Friendly Extension Help}</param>
    </page>
  </param>
  <effect>
    <object-type>[all|{element type}]</object-type>
      <effects-menu>
        <submenu _name="{Extension Group Name}"/>
      </effects-menu>
  </effect>
  <script>
    <command reldir="extensions" interpreter="[python|perl|ruby|bash|{some other}]">program.ext</command>
  </script>
</inkscape-extension>
</pre></small>
 
For a full list of currently supported interpreters, please see [[Extension Interpreters]].
 
== DTD XML schema==
The following XML schema may not fully describe the current ING file structure. The actual XML schema used is described in the [[INX extension descriptor format#RELAX NG XML schema|next paragraph]].
<small><pre>
<!ELEMENT inkscape-extension (name, id, dependency*, param*,(input|output|effect),(script|plugin))>
<!ELEMENT input (extension, mimetype, filetype, filetypetooltip, output_extension?)>
<!ELEMENT output (extension, mimetype, filetype, filetypetooltip, dataloss?)>
<!ELEMENT effect (object-type|submenu?)>
<!ELEMENT script (command, helper_extension*, check*)>
<!ELEMENT plugin (name)>
<!ELEMENT name (#PCDATA)>
<!ELEMENT id (#PCDATA)>
<!ELEMENT item (#PCDATA)>
<!ELEMENT option (#PCDATA)>
<!ELEMENT dependency (#PCDATA)>
<!ELEMENT param (#PCDATA|page|item|option)*>
<!ELEMENT page (#PCDATA, param*)>
<!ELEMENT extension (#PCDATA)>
<!ELEMENT mimetype (#PCDATA)>
<!ELEMENT filetype (#PCDATA)>
<!ELEMENT filetooltip (#PCDATA)>
<!ELEMENT object-type (#PCDATA)>
<!ELEMENT command (#PCDATA)>
<!ELEMENT check (#PCDATA)>
<!ELEMENT dataloss (#PCDATA)>
<!ELEMENT helper_extension (#PCDATA)>
<!ELEMENT output_extension (#PCDATA)>
<!ATTLIST check reldir (absolute|path|extensions|plugins) #REQUIRED>
<!ATTLIST command reldir (absolute|path|extensions|plugins) #REQUIRED>
<!ATTLIST command interpreter CDATA #REQUIRED>
<!ATTLIST dependency type (executable|extension) #REQUIRED>
<!ATTLIST dependency location (absolute|path|extensions|plugins) #IMPLIED>
<!ATTLIST dependency description CDATA #IMPLIED>
<!ATTLIST effect needs-live-preview (true|false) #REQUIRED>
<!ATTLIST effect implements-custom-gui (true|false) #IMPLIED>
<!ATTLIST page name CDATA #REQUIRED>
<!ATTLIST page gui-text CDATA #IMPLIED>
<!ATTLIST param name CDATA #REQUIRED>
<!ATTLIST param type (int|float|string|boolean|enum|notebook|description|optiongroup|color) #REQUIRED>
<!ATTLIST param min CDATA #IMPLIED>
<!ATTLIST param max CDATA #IMPLIED>
<!ATTLIST param max_length CDATA #IMPLIED>
<!ATTLIST param precision CDATA #IMPLIED>
<!ATTLIST param gui-text CDATA #IMPLIED>
<!ATTLIST param gui-tip CDATA #IMPLIED>
<!ATTLIST param gui-description CDATA #IMPLIED>
<!ATTLIST param scope CDATA #IMPLIED>
<!ATTLIST param gui-hidden CDATA #IMPLIED>
<!ATTLIST param appearance (minimal|) "">
<!ATTLIST submenu name CDATA #REQUIRED>
</pre></small>
 
== RELAX NG XML schema ==
The XML schema for INX files is available in the [https://gitlab.com/inkscape/extensions/-/blob/master/inkscape.extension.rng Inkscape extensions Git repository]. This is a [http://www.relaxng.org/ RELAX NG schema].
 
== See Also ==
*[[INX Parameters]]
*[[ScriptingHOWTO]]
 
[[Category:Developer Documentation]]
[[Category:Developer Documentation]]
[[Category:Help Wanted]]
[[Category:Help Wanted]]
[[Category:Extensions]]
[[Category:Extensions]]

Latest revision as of 20:12, 10 March 2022

This page previously contained information on the *.inx file format. The information is now found at the extensions documentation.

Retrieved from "https://wiki.inkscape.org/wiki/index.php?title=INX_extension_descriptor_format&oldid=120972"