Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

authorSDK documentation -- keys exist, but can't find the doc #12

Open
mbakeranalecta opened this issue Jul 27, 2014 · 3 comments
Open

Comments

@mbakeranalecta
Copy link
Contributor

There are keys for authorSDK in the docs, but I cannot find any SDK documentation anywhere on the site. I downloaded the SDK, but that just contains .jar files. Is there supposed to be a separate authorSDK documentation build?

@ctalau
Copy link
Contributor

ctalau commented Jul 27, 2014

Starting from version 16.0, the authorSDK is a Maven Archetype rather than a .zip archive as it used to be in the previous versions. The .zip archive on the website is provided for those who do not use the Maven build system, and includes only the bare minimum needed for one to start developing.

Now, the SDK documentation on the website is located in multiple places:

  • the high-level documentation can be found at [1]
  • the javadoc of our API is available online at [2] and can be downloaded as an archive at [3](the link is not referenced anywhere on the website, but the Maven build system would download it automatically from this link).
  • There is a README.html file inside each module of the SDK, but this requires one to create a project starting from the Maven archetype. The maven archetype is kind of a template for a new project, but to get an idea of how a project created starting from the SDK would look like you can check the following archive [4]. It contains all the README.html files.

[1] http://oxygenxml.com/oxygen_sdk.html
[2] http://oxygenxml.com/InstData/Editor/SDK/javadoc/index.html
[3] http://oxygenxml.com/maven/com/oxygenxml/oxygen/16.0.0/oxygen-16.0.0-javadoc.jar
[4] http://oxygenxml.com/maven/com/oxygenxml/samples/oxygen-sdk-samples-archetype/16.0.0/oxygen-sdk-samples-archetype-16.0.0.jar

@georgebina
Copy link
Contributor

I think we need to clarify this internally, in the meanwhile we can ignore the authorSDK as a deliverable from the UserManual.ditamap.

@georgebina
Copy link
Contributor

The authorSDK condition is used now on the AuthorDeveloperGuide.ditamap which is a sub-chapter of the user manual. I still need to look more into this - possibly we can filter out all chapters except AuthorDeveloperGuide from the user manual on the authorSDK product.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants