Oxygen 16.1 custom framework having issue with Oxygen 17.1 SDK

Post here questions and problems related to oXygen frameworks/document types.
hongyung
Posts: 12

Oxygen 16.1 custom framework having issue with Oxygen 17.1 SDK

Mon Nov 16, 2015 6:06 am

Hi,
My oXygen XML Author 17.1 eclipse plugin having issue with my custom actions defined in my framework which I previously I created for oXygen XML Author 16.1 eclipse plugin.
I find out that is because the API I use in 16.1 is no longer valid in 17.1.

This is what I found for one of my action. It is not working after I put my framework from 16.1 into 17.1 folder. For this case, It is due to the package name has been renamed.
in 16.1
ro.sync.ecss.extensions.dita.topic.InsertEquationOperation

in 17.1
ro.sync.ecss.extensions.commons.operations.InsertEquationOperation

Is there a way to upgrade my existing 16.1 framework to be 17.1 compatible ? I have quite huge customization in my framework and it can be a huge efforts to manually detect and convert them manually.

Thanks in advance!
mihaela
Posts: 188

Re: Oxygen 16.1 custom framework having issue with Oxygen 17.1 SDK

Mon Nov 16, 2015 4:19 pm

Hi,

Indeed we have removed the ro.sync.ecss.extensions.dita.topic.InsertEquationOperation from the built-in DITA 17.1 version because, after we made some updates on the operation, there was no difference between the DITA implementation and the common one. So, now, in version 17.1, the default DITA framework uses the
ro.sync.ecss.extensions.commons.operations.InsertEquationOperation
instead of
ro.sync.ecss.extensions.dita.topic.InsertEquationOperation.

There is no automatic procedure to make your old framework compatible with 17.1. Generally, we try to keep backwards compatibility with older frameworks code as much as possible.
To solve your problem you just have to create the ro.sync.ecss.extensions.dita.topic.InsertEquationOperation class (with the old implementation) or to use the ro.sync.ecss.extensions.commons.operations.InsertEquationOperation in your insert equation action (I recommend this second approach if you want to benefit from the improvements we have added to this operation).

Here is our recommendation for future framework extensions: the best way is to use the Extend framework functionality, instead of copying a framework and then change something to it. In this way, you will benefit of new functionality added to the base framework by newer Oxygen versions, and still use your customization. If you used the framework extension mechanism your problem could have been avoided.
Here are some details:
http://blog.oxygenxml.com/2015/08/docum ... aring.html
Mihaela Calotescu
http://www.oxygenxml.com
hongyung
Posts: 12

Re: Oxygen 16.1 custom framework having issue with Oxygen 17.1 SDK

Thu Nov 19, 2015 4:25 am

Hi Mihaela,
Thank a lot for the informative reply. My framework is extended from oxygen framework after oxygen introduced this new framework extension feature. I'll relook into my framework to verify this again thanks!

Return to “SDK-API, Frameworks - Document Types”

Who is online

Users browsing this forum: No registered users and 0 guests