Extension Guide

From OpenKM Documentation
Revision as of 16:33, 2 June 2010 by Jllort (talk | contribs)

Jump to: navigation, search

Nota advertencia.png This section is still unders contruction

OpenKM allows to create your own plugin extensions. OpenKM plugin extensions makes OpenKM more easilly to extends OpenKM users interface encapsulating plugin codeand making rehusable between OpenKM versions.


The OpenKM plugin extension is based on:

  • Extensions
  • Events
  • Handlers
  • Comunicators


Extensions are available panels definitions that allows to make extensible widget ( for example tab document panel in Desktop view )


Events are a collection of events that OpenKM UI fires when some changes happens ( for example adding new keyword in tab document panels)


Handlers are a collection of metods called internally by OpenKM. Handlers must be implemented to your extensions in order to take advantage of events. Each extension you make can have one ore several handlers that are automatically registered by OpenKM on loading process. OpenKM internally fire events to each declared handler.


Comunicators are a collection of methods avaliable as OpenKM Comunitate API to accessing transparently with some widget values. Comunicators encapsulation allows a transparent way to accessing internally data values. Each extensions has it own communicate methods. Major Communicate API is read only althought there're some write methods.