Integrate Oxygen XML Author with Jenkins

<oXygen/> general issues.
Sreeram891
Posts: 7
Joined: Tue May 08, 2018 1:40 pm

Integrate Oxygen XML Author with Jenkins

Post by Sreeram891 » Wed Jul 04, 2018 9:54 am

Hello team,

Currently, we are in a idea to automate the documentation process through Jenkins.

As i am new to Jenkins and automation process, i would top like to seek your suggestions or ideas about automating the documentation.

We use Oxygen XML Author 15.2 for authoring the XML content and trying to find ways to integrate the Oxygen Author with Jenkins.

Can you suggest how this process works and how can we take it to the next level.


Thanks,
Sreeram

Radu
Posts: 7207
Joined: Fri Jul 09, 2004 5:18 pm

Re: Integrate Oxygen XML Author with Jenkins

Post by Radu » Thu Jul 05, 2018 12:44 pm

Hi Sreeram,

I will assume you want to publish DITA content using a Jenkins server. If you want something else, please provide us with more details.
Oxygen uses for publishing DITA content an engine called the DITA Open Toolkit which can also be downloaded and invoked separately (on the server side):

https://www.dita-ot.org/download
https://www.dita-ot.org/3.0/topics/building-output.html

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com

Sreeram891
Posts: 7
Joined: Tue May 08, 2018 1:40 pm

Re: Integrate Oxygen XML Author with Jenkins

Post by Sreeram891 » Thu Jul 05, 2018 1:43 pm

Hi Radu,

Thanks for the response.

But, what i am looking is to automate the documentation process by using Jenkins.

I was browsing through forum and found this topic post44987.html?hilit=jenkins#p44987 for automating builds.

I am looking for some plugins, using which we can automate existing manual process for documentation.

Radu
Posts: 7207
Joined: Fri Jul 09, 2004 5:18 pm

Re: Integrate Oxygen XML Author with Jenkins

Post by Radu » Thu Jul 05, 2018 3:38 pm

Hi,

I understand and I stick to my previous answer.
Using Jenkins you can start any process on the server side. So on the server side you can have a Jenkins job which first downloads the current DITA content for the documentation from your CMS or version control system, then downloads a DITA Open Toolkit (from the DITA OT website I mentioned), unzips it, then runs the DITA OT process specifying various parameters to it (path to the DITA Map, output format). Then the Jenkins job can take the output content and move it to a web server to publish it.

Regards,
Radu
Radu Coravu
<oXygen/> XML Editor
http://www.oxygenxml.com

kmckenna7
Posts: 1
Joined: Mon Dec 10, 2018 10:11 pm

Re: Integrate Oxygen XML Author with Jenkins

Post by kmckenna7 » Wed Jul 29, 2020 7:05 pm

But, can you use the Oxygen plugin (com.oxygenxml.webhelp.responsive) when you build on Jenkins? I like the look of the Oxygen transform, better than the DITA-OT one.

Also, how do you know what version of the DITA-OT my version of Oxygen uses? It says this 2.x in this folder: C:\Program Files\Oxygen XML Author 20\frameworks\dita\DITA-OT2.x. Not sure what applicable version of the DITA-OT to use in this case.

Can you install Oxygen on your Jenkins machine? Should you?

Costin
Posts: 715
Joined: Mon Dec 05, 2011 6:04 pm

Re: Integrate Oxygen XML Author with Jenkins

Post by Costin » Thu Jul 30, 2020 11:48 am

Hello,

You have an older version of Author - version 20 - which worked with an older version of DITA (2.x), that is bundled with it.
The latest version uses DITA OT 3.x (it comes bundled with DITA OT 3.4.1 more specific).

To answer your other question, no, you could not use the WebHelp plugin that comes bundled with Oxygen Author outside of oXygen Author.
Instead, you could use the separate Oxygen XML WebHelp product (that is intended for command-line transformations, outside of the oXygen GUI software - outside of Editor/Author/Developer).
As the WebHelp Plugin for DITA-OT is a separate product, intended for different use-cases (to automate publishing of WebHelp output), it has its own license, so you should purchase a WebHelp license from the Shop.
Then you should download the DITA-OT 3, download the WebHelp Plugin from our website and deploy it in the DITA OT, following the steps described in the Installing section from the WebHelp User-Guide.

Also in the User-Guide you will find information on how to run and automate output generation from an integration server.

Regards,
Costin
Costin Sandoi
oXygen XML Editor and Author Support

Post Reply