Cannot deploy DITA-OT plug-in as an add-on

<oXygen/> general issues.
jlowther
Posts: 8

Cannot deploy DITA-OT plug-in as an add-on

Fri Aug 04, 2017 9:10 am

I am using oXygen 18.1. I have created a DITA-OT plug-in and framework that I have been using locally and now I want to deploy to other team members as an add-on. I followed the instructions here:

https://www.oxygenxml.com/doc/versions/ ... ddons.html
https://www.oxygenxml.com/addons.html

I copied my XML descriptor file and ZIP archives containing the plugin and framework to my HTTP server. Then, I installed them using Help > Install new add ons. However, after I restart oXygen, the plug-in does not appear in the list of installed plug-ins on Options > Preferences > Plugins. Also, none of the content that I created using the plug-in locally is valid anymore: I get the message "Cannot find task.dtd". (I am using public identifiers, btw.)

It appears, however, that the framework is installed correctly as I can see it in Options > Preferences > Document Type Associations.

What is the reason why I cannot install my plug-in as an add-on and how do I fix it? Thanks.
adrian
Posts: 2326

Re: Cannot deploy DITA-OT plug-in as an add-on

Fri Aug 04, 2017 12:21 pm

Hi,

There may be some confusion here.
The plugins packed as add-ons are meant for Oxygen (Oxygen plugins).
Currently there is no way to deploy a DITA-OT plug-in (just the plug-in) as an Oxygen add-on. The problem is the plugin needs to be placed in the DITA-OT folder. The Oxygen bundled DITA-OT is in a read-only area for the user ("Program Files" or /Applications).

The solution is to pack a framework as an add-on and that framework should bundle its own DITA-OT that has your DITA-OT plugin already deployed. The framework should provide transformation scenarios that use this DITA-OT, or you should configure Oxygen to use the DITA-OT you provide as the default (Preferences > DITA).

Regards,
Adrian
Adrian Buza
<oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger
http://www.oxygenxml.com
jlowther
Posts: 8

Re: Cannot deploy DITA-OT plug-in as an add-on

Tue Aug 08, 2017 8:23 pm

Adrian,
Thanks for the clarification.
Could you please give me a summary of what I need to do to configure oXygen to use the DITA-OT that I package with my framework? Thanks.
adrian
Posts: 2326

Re: Cannot deploy DITA-OT plug-in as an add-on

Wed Aug 09, 2017 9:52 am

Hi,

After installing the add-on with the framework, go to Options > Preferences, DITA and set the DITA Open Toolkit to Custom and the location:
${frameworkDir(my_framework_name)}/DITA-OT
Where my_framework_name is the name of your framework (case sensitive). This is the actual name of the "Document type" (framework), not the folder name.

Regards,
Adrian
Adrian Buza
<oXygen/> XML Editor, Schema Editor and XSLT Editor/Debugger
http://www.oxygenxml.com

Return to “Other Issues”

Who is online

Users browsing this forum: No registered users and 2 guests