How to generate webhelp from console

[ArtGoddess]

Hello,

We want to generate all documentation of our software using ANT in order to integrate in our build system (Atlassian Bamboo).

Can you please give me any hint in how to do it?

Your help is really appreciated in advance.

[sorin_ristache]

Hello,

Using an Oxygen user license the DITA Map Webhelp transformation can be launched only from the Oxygen install directory. For running this transformation outside Oxygen (in a DITA-OT installed outside the Oxygen install directory) you need to integrate the Webhelp plugin in that DITA-OT and use a dedicated Webhelp license with that Webhelp plugin installation. The integration is done as for any other DITA-OT plugin, following the general plugin integration instructions.

The transformation will run in an external DITA-OT in the same way as in Oxygen, if the same parameters are set as in the Oxygen transformation, the only difference is the license type. If you want more details about the Webhelp license for running the Oxygen DITA Webhelp transformation in an automatic build system outside Oxygen please contact us by email at support at oxygenxml dot com.


Regards,
Sorin

[ArtGoddess]

Hello, I don't really need to launch the transformation from outside the Oxygen directory.

It's ok to run it from there but my problem is that I don't know how to find out the appropriate comand line.

In other words, I want to open a console, go to Oxygen install dir, type a command line (no matter how complex) and get the same web help as with the UI.

Thank you very much.

[sorin_ristache]

Hello,

Our legal department says that the EULA license terms for the Webhelp plugin specify that running the Oxygen DITA Webhelp transformation in an external process (for example from a command line, in an automatic build system) requires a dedicated Webhelp license, not a regular Oxygen user license. This type of license (Oxygen Webhelp license) has a fixed price but the corresponding product (Webhelp license) is not yet linked from the Buy page (does not have yet a link in the online shop) on the Oxygen website, this is why I suggested to contact us by email.

The result of the Oxygen DITA Webhelp transformation will be the same when executed from an external build process (from a command line) as from the Oxygen editor application, so if you want only to evaluate the DITA Webhelp transformation and see if it suits your needs, you can just run it inside the Oxygen application on the same DITA map that you plan to use in your build system.


Regards,
Sorin

[ArtGoddess]

Hello,

We already own an Oxygen Editor license, and we are already generating our documentation with Oxygen application.
What we want now is to generate the same documentation but using the console.

As far as I know Oxygen generate the webhelp by invoking DITA OT itself. I just want to know what command line my Oxygen application is running so I can do the same on the console.

Right now we have our technical writer writing the documentation on Oxygen Front-End but besides, we would like to automatize the process for batch generation in the console and getting the same result as the technical writer does by clicking one botton in the UI.

Thanks.

[sorin_ristache]

Hello,

There are two distinct ways (with two distinct sets of license terms) of calling the Oxygen Webhelp plugin integrated in a DITA Open Toolkit for generating the Webhelp output pages from an input DITA map:

• by running the DITA Webhelp transformation in Oxygen on the current DITA map opened in the DITA Maps Manager view, which means calling inside the Oxygen application the built-in DITA-OT installed by Oxygen; in this case only a user license registered in the Oxygen application is required;
• by calling the Webhelp plugin from an external application (outside the Oxygen application), for example from a command line or from an automated build system; in this case a dedicated Webhelp license is required which is distinct from an Oxygen user license and is purchased separately; the license terms (EULA) of the Webhelp plugin are different in this case.

Of course the Oxygen Webhelp plugin for DITA-OT can be evaluated in the Oxygen application by running the DITA Webhelp transformation. If the Webhelp transformation in the Oxygen application covers all the needs of an Oxygen user, he/she can just keep using the Webhelp plugin in the Oxygen application without ever needing to run the Webhelp transformation outside the Oxygen application and without a dedicated Webhelp license.

If you need clarifications regarding the two distinct cases (in which distinct license terms are applied) you may contact us by email (support at oxygenxml dot com) and your message will be forwarded to our legal department.


Regards,
Sorin

[juliovaz]

So if I understand this correctly, to build Webhelp in batch mode, you need a Webhelp license. I assume that part of this also includes a package that installs the additional jar files and a sample startcmd.bat (assuming Windows DITA input) that integrates those jars into the build process. Am I right?

Thanks,

Julio

[sorin_ristache]

Hi Julio,

Yes, to build Webhelp in batch mode you need an Oxygen XML Webhelp license. The Webhelp distribution includes a README.txt file with installation and integration instructions for the Oxygen Webhelp plugin for DITA-OT. It includes also an example of Windows batch script (a .bat file) and Linux batch script (a .sh file) for starting the Webhelp transformation from a command line.


Regards,
Sorin