WoodWing Help Center

Adding custom context menu commands to Content Station 10

 

Adding custom context menu commands to Content Station 10

Info: This feature requires Content Station 10.17 or higher.

One of the ways of adding custom functionality to Content Station 10 is by adding commands to the context menu of a file. These commands can be linked to specific actions.

Example: You can add functionality such as printing a file, downloading a custom contact sheet in PDF format, and so on.

Note: The context menu is accessed by right-clicking a file.

Clicking a custom menu command

Figure: In this example a file named 'Coffee' is referenced on Wikipedia.

Custom context menu result

Figure: The result is displayed in a window and can optionally be opened in a new tab.

Areas to add commands to

Custom context menu commands can be added to the following areas in Content Station:

  • Files that are shown in the search results

How actions are provided

The action that is performed should be provided in the form of a javascript plug-in.

Where to get the actions from

The actions need to be created or obtained yourself; they are not provided by WoodWing.

Creating a plug-in

To help you create your own plug-ins, an SDK and sample files are available in the following location:

  • Content Station 10 folder > sdk

It contains the following files and folders:

  • content-station-10-sdk.md. The SDK describing the available options that can be implemented.
  • plugins.md. Sample code showing how to enable plug-ins in Content Station
  • samples. Folder containing some example plug-ins. See the SDK for more information.

The process

The process of creating and adding a plug-in is as follows:

Step 1. Create the plug-in by following the instructions in the SDK.

Step 2. Place the plug-in in the following folder (optionally in a subfolder of this folder):

  • Content Station 10 folder > sdk

Step 3. Enable the plug-in in Content Station by opening the contentstation > config.js file and adding a reference to the plug-in in the plugins section:

plugins: {
    contentStation: [
      'my-plugin.js'
    ]
  }

Example:

plugins: {
    contentStation: [
      'sdk/samples/sample-1.js',
      'sdk/samples/sample-2.js'
    ]
  }

Step 4. Save the file.

Step 5. Log in to Content Station — or refresh the page when you are already logged in — and test the working of your plug-in.

Was this article helpful?
0 out of 0 found this helpful / Created: / Updated:
Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.