userguide icon indicating copy to clipboard operation
userguide copied to clipboard

Author SDK vs Oxygen SDK

Open mbakeranalecta opened this issue 11 years ago • 6 comments

I am finding references to both the Author SDK and the Oxygen SDK. I'm not sure if these are distinct products. but links from Author SDK in the docs lead to a web page that talks about the Oxygen SDK, so I suspect they are the same product and the name changed at some point. Correct?

mbakeranalecta avatar Aug 13 '14 12:08 mbakeranalecta

Hi Mark,

Starting with version 16 we unified the SDK into a single package, in fact a set of Maven artifacts, as described at http://oxygenxml.com/oxygen_sdk.html Before that we provided multiple packages, for developing with the oXygen Author Component, for extending the Author interface by creating extensions and custom frameworks, for developing oXygen plugins, for extending the Eclipse plugin version, for working with the diff functionality, etc. I think the reference to Author SDK are made in the context of customizing the authoring part while Oxygen SDK refers more generically to all oXygen customizations.

georgebina avatar Aug 13 '14 13:08 georgebina

So we should change all SDK references to read "Oxygen SDK"?

mbakeranalecta avatar Aug 13 '14 13:08 mbakeranalecta

In cases there is a reference to the SDK yes - there are also cases when there are references to specific parts of the SDK, for example in DITA/topics/api_faq_introduction.dita:


This section contains answers to common questions regarding the customisations using the Author SDK


this refers to the author specific part of the SDK, so cannot be immediately changed to Oxygen SDK (or oXygen SDK).

georgebina avatar Aug 13 '14 13:08 georgebina

In that case I think we should say "the Author part of the Oxygen SDK", otherwise readers will not be clear that there is only one SDK.

mbakeranalecta avatar Aug 13 '14 14:08 mbakeranalecta

Yes, I just wanted to emphasize that we need to double check each reference :).

georgebina avatar Aug 13 '14 14:08 georgebina

Okay, I will make the changes where I am sure which is referred to and place comments on the rest for review.

mbakeranalecta avatar Aug 13 '14 14:08 mbakeranalecta