Plugin API

PubTal plugins allow the functionality of PubTal to be expanded and customised.  Currently support for new content types and new upload methods can be added using plugins.

Plugin Interface

Plugins are implemented as Python modules which are placed in either the site-packages/pubtal/plugins directory, or in a directory specified using the additional-plugins-dir configuration option.  All plugins must implement a module level function called getPluginInfo() which returns a list of the functionality provided by this plugin.  The list is comprised of dictionaries that describe the functionality provided by this plugin and provide additional information to PubTal about that functionality.

Each dictionary in the list returned from getPluginInfo() must have a key "functionality".  Legal values of for this key are currently :

  • "content" - This plugin provides a new content type.
  • "upload-method" - This plugin provides a new upload method.

Additional Content Types

In addition to the key "functionality" having a value of "content", the dictionary must also contain the following keys:

  • "content-type" (Mandatory) - A name for the type of content support provided.
  • "class" (Mandatory) - The class which provides this support must be derived from SitePublisher.ContentPublisher.
  • "file-type" (Optional) - The file type extension which this content type should be associated with by default.  This can be a list of file extensions if more than one type should be associated.

The two methods defined by SitePublisher.ContentPublisher (other than the constructor) which must be implemented are: publish() and getPageContext()

Additional Upload Methods

In addition to the key "functionality" having a value of "upload-method", the dictionary must also contain the following keys:

  • "method-type" (Mandatory) - The name of the upload method (used in the configuration file).
  • "class" (Mandatory) - The class which provides support for this method must be derived from SiteUploader.UploadMethod.
Last Modified: Sat, 07 Feb 2015 12:35:15 GMT

Made with PubTal 3.5

Copyright 2017 Colin Stewart

Email: colin at owlfish.com