Existing extensions migration to Oxygen XML Web Author

Alper B
Posts: 9
Joined: Mon Jan 27, 2020 6:26 pm

Existing extensions migration to Oxygen XML Web Author

Post by Alper B » Thu Feb 20, 2020 6:22 pm

Hello,

I found in your customization guide that you recommend to implement any customization as a combination of plugins, frameworks, and options.
If we have already developed Oxygen XML Editor/Author plugins, they can be added in the bundle-plugin/dropins folder in the Maven project.

With the Oxygen XML Editor/Author version, we have implemented an extension which generates, for the inserted elements, a specific ID.
For this, we have implemented classes that extend Oxygen classes like DefaultUniqueAttributesRecognizer, ExtensionsBundle, AuthorDocumentFilter or StylesFilter. But we havn't developed these extensions like "plugins", our classes are integrated in the same module where frameworks are defined.

With Oxygen XML Web Author, what do you recommend to reuse these extensions in the structure of our web app?

Thanks!
Alper

cristi_talau
Posts: 286
Joined: Thu Sep 04, 2014 4:22 pm

Re: Existing extensions migration to Oxygen XML Web Author

Post by cristi_talau » Fri Feb 21, 2020 3:21 pm

Hello,

The extensions that you described in the second paragraph are framework configurations. If you modified one of the builtin frameworks, it is recommended to use a framework extension [1] instead. This way, when we update the builtin framework you will not get stuck with an old modified one. If you have modified a sample framework (included in the SDK) or started from scratch you do not need a framework extension.

Depending on how you plan to use Web Author you can either upload the frameworks and plugins in the Administration Page, copy them in the Oxygen Data Directory [2] or add them in the Web Author Component integration project [3].

For the options, you can either set some of them in the Admin Page or in the options.xml file [4].

Best,
Cristian

[1] https://www.oxygenxml.com/doc/versions/ ... nding.html
[2] https://www.oxygenxml.com/doc/versions/ ... a-dir.html
[3] https://github.com/oxygenxml/web-author ... ntegration
[4] https://www.oxygenxml.com/doc/versions/ ... tions.html

Alper B
Posts: 9
Joined: Mon Jan 27, 2020 6:26 pm

Re: Existing extensions migration to Oxygen XML Web Author

Post by Alper B » Mon Feb 24, 2020 12:56 pm

Thanks for your answer.

Actually, we are in the 3rd architecture. We have developed our own frameworks from scratch and own configuration classes.

We want to copy the same developped classes based on Oxygen XML Author to Oxygen Author Web, but the called Oxygen classes don't have the @webappcompatible annotation, is this definitely means that we can't call them anymore? Have you developed alternatives to these classes?

Regards,
Alper

cristi_talau
Posts: 286
Joined: Thu Sep 04, 2014 4:22 pm

Re: Existing extensions migration to Oxygen XML Web Author

Post by cristi_talau » Mon Feb 24, 2020 2:22 pm

Hello,

Some classes were made compatible with Web Author and annotated with "WebappCompatible". Some of them were re-implemented in JavaScript for various frameworks (e.g. DITA), some of them were re-implemented in a generic way.

To provide you with alternatives we need to know which AuthorOpearation implementations you are trying to use but are not marked as "WebappCompatible".

Best,
Cristian

Alper B
Posts: 9
Joined: Mon Jan 27, 2020 6:26 pm

Re: Existing extensions migration to Oxygen XML Web Author

Post by Alper B » Mon Feb 24, 2020 7:52 pm

Hello Cristian,

The main classes that we surcharged are DefaultUniqueAttributesRecognizer, ExtensionsBundle and AuthorDocumentFilter, they are annotated @API. We have implemented some specific treatments extending these classes, so if there are alternatives to them, please tell us.

Sorry for all these questions, but I'm not sure what the annotation @API does.

Regards,
Alper

mihaela
Posts: 227
Joined: Wed May 20, 2009 2:40 pm

Re: Existing extensions migration to Oxygen XML Web Author

Post by mihaela » Tue Feb 25, 2020 4:24 pm

Hi,

The ro.sync.ecss.extensions.api.WebappCompatible annotation is used only for AuthorOperations, to mark them as compatible with Web Author.
So please let us knwo which AuthorOpearation implementations you are trying to use but are not marked with "@WebappCompatible".

Best Regards,
Mihaela
Mihaela Calotescu
http://www.oxygenxml.com

Alper B
Posts: 9
Joined: Mon Jan 27, 2020 6:26 pm

Re: Existing extensions migration to Oxygen XML Web Author

Post by Alper B » Wed Feb 26, 2020 1:45 pm

Hi Mihaela,

On this particular Ids generation feature, I don’t think we’re implementing the Authoroperation interface, so I’ll try to reconnect all of my classes and do some testing.

Thanks for your help,

Regards,
Alper

Post Reply