Oxygen web app customization!

Post here questions and problems related to editing and publishing DITA content.
mu258770
Posts: 157
Joined: Mon Aug 18, 2014 4:11 pm

Oxygen web app customization!

Post by mu258770 »

Hi team,

We would like to customize oxygen web app version.

We have already customized eclipse plugin version of oxygen 16.1. In that I added one custom action operation and I could call the action dialog (created using SWT) by giving proper classpath in the document type association. But in web app version, these options are not there.

We would like to add the action in the web app context menu and toolbar. How is it possible? Is there any way in the backend we will give the classpath for our action jar file and it can be added to the toolbar and contextual menu

Regards,
Shabeer
cristi_talau
Posts: 494
Joined: Thu Sep 04, 2014 4:22 pm

Re: Oxygen web app customization!

Post by cristi_talau »

Hello,

oXygen XML WebApp can be customized using plugins [1] which have the same format as oXygen Standalone plugins. They are similar but different from Eclipse plugins. In order to add libraries to the classpath you can check the "Referencing Libraries" section here [2].

The GUI of the custom action will have to be reimplemented in JavaScript + HTML in order to be used with the WebApp. You can find an example of how to add an action on one of the toolbars in our documentation [3].

In order to start working on the customization, you may want to check out our dedicated section [4]. You will need an evaluation license key to set up your webapp instance. Please contact us on our support address in order to request one.

Best,
Cristian

[1] https://www.oxygenxml.com/doc/versions/ ... ugins.html
[2] https://www.oxygenxml.com/doc/versions/ ... lugin.html
[3] http://www.oxygenxml.com/maven/com/oxyg ... ction.html
[4] http://www.oxygenxml.com/oxygen_sdk.htm ... ntegration
mu258770
Posts: 157
Joined: Mon Aug 18, 2014 4:11 pm

Re: Oxygen web app customization!

Post by mu258770 »

Thanks for Info Cristian,

Currently we are using oXygen 16.1 only in our CMS application, so may we know the procdure mentioned below is valid for 16.1 also or not?

And also if possible can you pls provide us if you have any templates or samples for this?

Thank you!

Br//Shabeer
cristi_talau
Posts: 494
Joined: Thu Sep 04, 2014 4:22 pm

Re: Oxygen web app customization!

Post by cristi_talau »

Hello,

The problem with 16.1 is that it does not have a toolbar and context menu. These are features we added in 17.0.

Anyway, I don't see any problems in having an extension for oXygen Eclipse plugin 16.1 and one for oXygen XML WebApp 17.0 - you can still reuse a lot of code between them. The Java API is backwards compatible.

Some sample code for adding a custom action on the toolbar can be found here [1]. You can also check out the "oxygen-sample-plugins" folder in our SDK. It contains a lot of sample code.

Best,
Cristian

[1] http://www.oxygenxml.com/maven/com/oxyg ... ction.html
Post Reply