User:Suzanne.soy/XternalApps Workbench/Example

The contents of this page are released in the public domain using the Creative Commons CC0 license, contrarily to the rest of the wiki. The contributors agree to waive all rights on their modifications to the fullest extent possible.

Rationale: this is a description of the basic usage of an external application, aimed at facilitating implementation of interoperability tools which target this application, this information should not be encumbered in any way.

Plug-ins and extensions
Describe here the plug-in or extension mechanism(s) thoroughly. Go into detail, give minimal but complete reproducible examples (e.g. steps which can be followed in a freshly-installed virtual machine). Include links to any blog posts, forum questions and other documentation which could help understanding how the plug-in system works; include a one-liner describing the external resource.

INX extension descriptor format

Open in tab feature on Linux systems
Relevant portion of and  which can be used to identify the window.


 * Make a test with the freshly-opened application window
 * Make a test with a window containing an open document
 * Make a test where another, unrelated application is editing a document whose name contains the name of this application (e.g. for info about Inkscape, open a file named "Inkscape.png" in The GIMP or "Inkscape.txt" in a text editor, and copy-paste here enough lines of and  to show how to distinguish the two)

Scripting
Describe here the scripting facilities offered by the application. It could be via an embedded programming or via a rich command-line API.


 * Include here links to the API docs
 * Minimal but complete reproducible examples (e.g. steps which can be followed in a freshly-installed virtual machine) on how to access the command-line interface or how to create and execute a script
 * An example script which uses one tool/filter
 * How to run a script from the command-line: in a new instance of the application
 * How to run a script from the command-line: in an existing instance of the application
 * Where are scripts stored in the user's configuration files?
 * Which features of the application can / cannot be accessed from a script?
 * Is it possible to save and quit from a script?

Online documentation
"online documentation" is documentation that can be opened directly from the application, e.g. using the "What's this?" feature, and ironically can usually be browsed offline.

How to open the online documentation? Where is the online documentation stored, and in which format? How is the online documentation built, from what sources (wiki dump, manually edited HTML files, generated by the application on the fly…)?