oe-logo
img img
Open Source Enterprise Content Management for the Enterprise
A proven framework for building great web sites
Digital Asset Management Glossary of Terms and Icons

Home : Digital Asset Management : Plug Ins : Creating

Creating

OpenEdit Plug In API

A five star OpenEdit Plugin will have these features

  1. Multiple copies can be install on one server
  2. Works within a webapp
  3. Works out of the box and uses fallback for loading all default configurations
  4. Has it's own thumbnail and title that can be used in the OpenEdit toolbar
  5. Has a jar files that contains:
    1. plugin.xml - Spring configurations. You should not interfere with the operation of other beans
    2. permissions.xml - Should specify and permissions that are shown in the user manager
    3. depends.xml - The id of the plugin that should match the jar name. Any other projects it depends on.

To work with the OpenEdit toolbar you will need to set these properties:

  1. /WEB-INF/base/yourplugin/.oepluginthumb.gif  Note there is a leading '.'
  2. /WEB-INF/base/yourplugin/_site.xconf
    1.   <property name="oeplugintype">openedit-archive</property>
    2.   <property name="oeplugintitle">Digital Assets</property>
  3. OpenEdit will provide a unique catalogid property for each plugin to allow multiple instances of your plugin on one server.

To register your Plug In you will need to provide a link to an install.js file. This file should only deal with it's own files and not install any other dependent files.