Creating the Publisher Plug-In

Creating a plug-in allows to contribute a new SECollab Publisher.

Here are the steps to create a SECollab Publisher plug-in:

Create the plug-in:

  1. Click File > New Project..., select Plug-In Project
  2. Enter a project name (e.g. com.sodius.mdw.clm.client.tool.sample) and click Next.
  3. Turn on the Generate an activator checkbox
  4. Turn off the This plug-in will make contributions to the UI checkbox and click Finish.

Declare the dependencies on other plug-ins:

  1. Edit the plug-in Manifest file: <myPlugIn>/META-INF/MANIFEST.MF
  2. Click the Dependencies tab.
  3. Add the following required plug-ins:
  4. Save the updated Manifest file.

Declare an extension to register the publisher:

  1. Edit the plug-in Manifest file: <myPlugIn>/META-INF/MANIFEST.MF
  2. Click the Extensions tab.
  3. Click Add.., select the com.sodius.mdw.clm.client.authoringTool extension point and click Finish.
  4. In the Extension Element Details section, associate an id attribute value (e.g. com.sodius.mdw.clm.client.tool.sample) and a name visible to the end user (e.g. Sample).
  5. Declare the publisher operation:
    1. Below the authoring tool extension, select the operationFactory child node and enter a qualified name of your choice for the class implementing the publisher operation (e.g. com.sodius.mdw.clm.client.tool.sample.SampleOperationFactory).
    2. Click the class attribute hyperlink, to open a Java Class creation wizard and click Finish to generate the source file. You will implement this class later.
  6. Declare the publisher wizard:
    1. Below the authoring tool extension, select the wizard child node and enter a qualified name of your choice for the class implementing the publisher wizard (e.g. com.sodius.mdw.clm.client.tool.sample.ui.SampleWizard).
    2. Click the class attribute hyperlink, to open a Java Class creation wizard and click Finish to generate the source file. You will implement this class later.
  7. Save the updated Manifest file.

Associate an icon to the publisher:

  1. Create a folder <myPlugIn>/icons/obj16
  2. Put in this folder a 16x16 image that represents the authoring tool, e.g. <myPlugIn>/icons/obj16/Tool.gif
  3. Edit the plug-in Manifest file: <myPlugIn>/META-INF/MANIFEST.MF
  4. Click the Extensions tab.
  5. Select the com.sodius.mdw.clm.client.authoringTool extension previously created.
  6. In the Extension Element Details section, click the Browse... button for the icon attribute and select the image file.
  7. Click the Build tab.
  8. In the Binary Build section, select the icons folder, so that it is part of the jar when the plug-in is deployed.
  9. Save the updated Manifest file.

Related tasks
Setting Up a Development Environment
Implementing the Publisher Wizard
Implementing the Publisher Operations