config.xml

A config.xml file is a necessary part of any PYTHA plugin. If a plugin folder does not contain a config.xml file, PYTHA will generate a bare-bones config file for you (this is the recommended way to create this file for your plugin).

A simple config.xml file might look like this:

<?xml version="1.0" encoding="UTF-8"?>
<plugin xmlns="http://xmlns.pytha.com/plugin_config/1.0">

  <header>
    <guid>XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX</guid>
    <version>1.0</version>
    <pytha-version>25.0</pytha-version>
    <name>Plugin Name</name>
    <description>The description of your plugin goes here.</description>
    <licensing>Information about the licensing terms goes here.</licensing>
  </header>

  <extension type="function">
    <entry-point>main</entry-point>
    <caption>Button Caption</caption>
    <description>A short description of the function goes here.</description>
    <help-file>help.html</help-file>
  </extension>

</plugin>

it contains a header section followed by one or more extension definitions.

Header

The header contains

• guid - A globally-unique-identifier that PYTHA uses to distinguish different plugins. When you start programming a new plugin, create a new guid for your plugin. There are many websites that create GUIDs for you (e.g. this one). When PYTHA automatically creates a bare-bones config file, it will create a new GUID for it.
• version - Version of the plugin. When multiple versions of the same plugin (as per its GUID) are installed, PYTHA will load the newest version.
• pytha-version - Minimum version of PYTHA required to run the plugin. PYTHA will not load the plugin if it does not satisfy the minimum version.
• name - A human-readable name to identify the plugin. The name will be localized through the .xlif files.
• description - A longer description of the plugin. The description will be localized through the .xlif files.
• licensing - A place to write information about your licensing conditions. Note that this is human-readable information only and the user is responsible for honoring the licensing condition (e.g. regarding redistribution and such). PYTHA will not try to enforce these conditions.

Extension

Different types of extensions can be defined and their functionality is described separately:

• type="function" - Function Extension
• type="edit" - Edit Extension
• type="attribute" - Attribute Extension

See also:

Function Extension, Edit Extension, Attribute Extension, Localization and Translation