webhelp parameters

[scotmarvin]

Hi,

We're using the command-line build for webhelp, using the plugin in our Jenkins server. Where do we add the parameters used in the Oxygen Editor configuration for webhelp? For example, I want to use args.breadcrumb, args.copycss, and args.ftr. I tried using these in our shell script (e.g., -Dargs.ftr=...) but got an error saying that the param "does not exist in the project 'DOST'".

I tried setting <param> in the com.oxygen.webhelp/build.xml file, but the generated files did not reflect any of the changes.

Can you give us direction? Thanks.

Thanks

[sorin_ristache]

Hi,

First you can test the parameters in the .sh shell script (or the .bat shell script if you run it on Windows), as explained in the README-DITA.txt file that comes in the Webhelp zip distribution. This README-DITA.txt file gives detailed instructions about DITA parameters like the ones you need (args.breadcrumb, args.copycss, etc) and where to add them in the .sh/.bat script. Please see the section OTHER PARAMETERS OF WEBHELP TRANSFORMATION.

BTW the args.breadcrumb parameter is not implemented. It comes as a built-in parameter of DITA-OT but it has no effect in the output. However Oxygen adds a breadcrumb in the Webhelp output, which consists of the titles of the parent and grand-parent topics (if they exist), above the topic title, on the same line with the tab titles Content, Search and Index. But there is no parameter that controls this Oxygen specific breadcrumb.

After you tested the parameters in the shell script from a command line, as as independent process (outside the server process), you can add them as <param> elements in the [DITA-OT-install-dir]/plugins/com.oxygenxml.webhelp/build_dita.xml file, in the <xslt> task from the ANT task called "dita.inner.topics.webhelp". Please follow the model of the args.ftr and args.draft parameters which are set in this "dita.inner.topics.webhelp" task in the [DITA-OT-install-dir]/plugins/com.oxygenxml.webhelp/build_dita.xml file.


Regards,
Sorin