Difference between revisions of "Extension Guide"

From OpenKM Documentation
Jump to: navigation, search
Line 1: Line 1:
OpenKM allows to create your own plugin extensions.
+
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 implemented to your extensions. 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 avaliable OpenKM API to communicate directly with some widget values. Comunicators encapsulates allows a transparent way to accessing internally data values. Each extensions has its own communicate methods. Communicate API is read only, there's no enabled to make internal changes.
 +
 
  
 
{{Warning|This section is still unders contruction}}
 
{{Warning|This section is still unders contruction}}

Revision as of 16:22, 2 June 2010

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 implemented to your extensions. 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 avaliable OpenKM API to communicate directly with some widget values. Comunicators encapsulates allows a transparent way to accessing internally data values. Each extensions has its own communicate methods. Communicate API is read only, there's no enabled to make internal changes.



Nota advertencia.png This section is still unders contruction