xml editor

[november]

Hi,

How is webhelp actually built? Which ant file is invoked?

[sorin]

Hello,

The WebHelp output is built from a DITA map using the build.xml file of DITA-OT just like all DITA output formats. This build.xml file is located in the ${frameworks}\dita\DITA-OT folder, where ${frameworks} is the frameworks folder inside the Oxygen install folder.

Do you get any errors when trying to generate WebHelp output from a DITA map? Do you want to customize the WebHelp output?


Regards,
Sorin

[november]

Yes, I am trying to customize the process. Can I retrofit it back into a clean install of DITA-OT? I might need to build the webhelp on a remote server.

Thanks

[sorin]

Hello,

As you can read in the license.txt file from the directory of the Webhelp plugin inside the DITA-OT embedded in Oxygen, using the Webhelp plugin outside Oxygen is forbidden. You are not allowed to migrate it to other DITA-OT install outside Oxygen.

We can discuss your particular case to run on a server machine, from a command line, the Webhelp transformation from the DITA-OT embedded in Oxygen, that is from the [Oxygen-install-dir]/frameworks/dita/DITA-OT directory, if you are willing to purchase as many Named User (standard) licenses or floating licenses as the number of users that will run the Webhelp transformation on the server.


Regards,
Sorin

[undrgrnd]

Hello,

What do we need to execute oxygen dita webhelp transformation in a build server via command line? Thanks

[sorin]

Hi undrgrnd,

As I said above the license terms forbid running the DITA WebHelp transformation outside Oxygen. For automating the process of generating the WebHelp output, the Oxygen DITA WebHelp transformation may be called from a command line as an ANT process that runs the DITA-OT toolkit embedded in Oxygen (located in the [Oxygen-install-dir]/frameworks/dita/DITA-OT directory). The general process is described in the User Manual.

You can start by copying and pasting the command line that is displayed at the top of the DITA Transformation view when you run the WebHelp transformation manually in the Oxygen window. When you paste this command at a command line and run it you will see some info lines with the changes that you need to make in the command line, like the following:

Code: Select all

==================================================
 You are running a DITA transformation outside Oxygen application.
 Please make sure you have a registered Oxygen installation for the current user.
 In case you need more details, you can contact the Oxygen support team
 at support@oxygenxml.com

 Running DITA-OT from outside Oxygen requires the Saxon 9 Basic processor.
 You can download Saxon 9 Basic from:
 http://sourceforge.net/projects/saxon/files/Saxon-B/

 Please copy the saxon9.jar and saxon9-dom.jar files into the directory
 S:\oxygen\frameworks/dita/DITA-OT/lib/saxon
 and add these two files to the classpath of the ANT launcher.

 Also you should remove from classpath the following Oxygen specific jar files:
     oxygen.jar
     oxygenAuthor.jar
     oxygenDeveloper.jar
     oxygenEclipse.jar
     oxygenAuthorEclipse.jar
     oxygenDeveloperEclipse.jar
     saxon9ee.jar
==================================================

So the command needs some minor manual editing: adding some parameters for the Saxon 9 Basic jar files and removing the parameters that specify the following jar files, as specified in the info message above:

Code: Select all

-lib "C:\Program Files (x86)\Oxygen XML Editor 13\lib\saxon9ee.jar"

Code: Select all

-lib "C:\Program Files (x86)\Oxygen XML Editor 13\lib\oxygen.jar"

etc.

You need either a standard Oxygen license (that is a Named User license) for each user that will run the WebHelp transformation from command line or a floating license for the group of these users. Depending on your particular situation a floating license for a reduced number of concurrent users may be more cost effective than one standard license for each distinct user that runs the command line transformation.


Regards,
Sorin

[undrgrnd]

Hi,

Thanks! Everything is running smoothly until I hit this error:

BUILD FAILED
C:\Program Files\Oxygen XML Author 14\frameworks\dita\DITA-OT\build.xml:56: The following error occurred while executing this line:
C:\Program Files\Oxygen XML Author 14\frameworks\dita\DITA-OT\build.xml:769: taskdef class com.nexwave.nquindexer.IndexerTask cannot be found

[undrgrnd]

Hi,

Thanks! Everything is running smoothly until I hit this error:

BUILD FAILED
C:\Program Files\Oxygen XML Author 14\frameworks\dita\DITA-OT\build.xml:56: The following error occurred while executing this line:
C:\Program Files\Oxygen XML Author 14\frameworks\dita\DITA-OT\build.xml:769: taskdef class com.nexwave.nquindexer.IndexerTask cannot be found

Already fixed this problem. Directory of ".../plugins/webhelp" should be ".../plugins/com.oxygenxml.webhelp"

[sorin]

Hi,

Yes, the path of the WebHelp plugin is [Oxygen-install-dir]/frameworks/dita/DITA-OT/plugins/com.oxygenxml.webhelp (not plugins/webhelp) but I wonder where you found that filepath? If you copy and paste the command from the DITA Transformation view in the Oxygen window you will always have the correct filepath for all the jar files needed by the command line.


Regards,
Sorin

[undrgrnd]

Hi you are right. The commands I used are from the documentation you provided. I should have used the command line provided by the oxygen author application.

[sorin]

Hi,

That command line is only an example to give you a feel of the content and length of the command, but you get the actual command by copy and paste from the output view of the DITA transformation in the Oxygen window as you can read in step 3 of that procedure from the User Manual.

Please let us know if you run into other errors or difficulties.


Regards,
Sorin