Skeleton Plugin

All Plugins / Action / Skeleton

Identity Card

StatusCore
Plugin LabelSkeleton Plugin
Short DescriptionThis is an empty container to demonstrate the basics of plugins coding.
Plugin Identifieraction.skeleton
AuthorCharles du Jeu
Urldocs/references/plugins/action/skeleton
Dependencies

Documentation

This plugin is an empty container for demonstrating how to create a simple plugin. It is disabled by default. If enabled, will simply add a button to the application toolbar that opens an external URL.

It covers standard features of plugins, included internationalisation and embedded images libraries. You should naturally read the developer doc in conjunction with the study of this plugin code to understand how it works!

It could be used in a middle term to automatically generate a new empty plugin, but for the moment if you duplicate this plugin to write your own, you'll have to grep the file names and plugin ids to make sure not to mess up with the original plugin.. For example, let's say your plugin is "action.gotomysite" :

  • Rename the plugin folder
  • Edit the manifest.xml file and replace skeleton by to gotomysite everywhere.
  • Rename the javascript and PHP classes with names and filenames more adequate to your new plugin, and update the manifest.xml file accordingly
  • Etc

You can note the various way to use the i18n libraries depending on where you are in the application. Note that the "id" key of the message is prefixed by your i18n namespace, here we use 'skeleton.1', 'skeleton.2' because the i18n namespace is defined like that in the manifest.xml.

  • In specific XML atributes, use simply the id of the message.
  • Inside XML CDATA, use AJXP_MESSAGE[id] (will be replaced before the XML is output)
  • In javascript, use MessageHash[id] (it's a hash available as a global variable)
  • In PHP, use the array provided by ConfService::getMessages()

Plugin parameters

LabelDescriptionTypeDefault
Custom Footer
SHOW_CUSTOM_FOOTER
Show a custom footer divBooleanfalse
Footer Content
CUSTOM_FOOTER_CONTENT
Display this content in the footerTextareaYour custom footer content
Button Target Url *
CUSTOM_BUTTON_TARGET
The target URL of the button that will be added to the applicationStringhttp://www.ajaxplorer.info