--format=webhelp-responsive isn't supported in CLI?

Post here questions and problems related to editing and publishing DITA content.
galanohan
Posts: 115
Joined: Mon Jul 10, 2023 11:49 am

--format=webhelp-responsive isn't supported in CLI?

Post by galanohan »

Hi Guys,

I'm trying to generate webhelp from cli using dita.bat (C:\Program Files\Oxygen XML Editor 26\frameworks\dita\DITA-OT\bin).
I followed the instruction on https://www.oxygenxml.com/doc/versions/ ... utput.html to specify the essential parameters:

PS C:\Program Files\Oxygen XML Editor 26\frameworks\dita\DITA-OT\bin> dita.bat --format=webhelp-responsive --input=D:\documentation\zh\ddb_doc_centre.ditamap --output=D:\documentation\output -Dwebhelp.publishing.template=D:\documentation\css_styles\chn_webhelp -Dwebhelp.publishing.template.descriptor=D:\documentation\css_styles\chn_webhelp\styles.opt

Then I got the following error:
Error: [DOTA001F][FATAL] "webhelp-responsive" is not a recognized transformation type. Supported transformation types are dita, eclipsehelp, html5, htmlhelp, markdown, markdown_gitbook, markdown_github, pdf, pdf2, xhtml.

But on this page, webhelp-responsive is supported as a format in transformation.
image.png
image.png (47.73 KiB) Viewed 580 times
Is this format no longer supported in CLI?

----------------------------------
Then I had another test in CMD,, then I got the following error response:

[echo] Oxygen XML WebHelp 26.0 build 2023110923
[templatetask] Cannot find a valid "licensekey.txt" license file in:
[templatetask] - the DITA-OT directory: "C:\Program Files\Oxygen XML Editor 26\frameworks\dita\DITA-OT"
[templatetask] - the plugin base directory: "c:\Program Files\Oxygen XML Editor 26\frameworks\dita\DITA-OT\plugins\com.oxygenxml.webhelp.responsive"
[templatetask]
[templatetask] Please place your Oxygen WebHelp or Oxygen Publishing Engine license key in a file called "licensekey.txt" and copy it to one of the above locations.
[templatetask]
[templatetask] If you do not have a license key or you need more details, please contact sales@oxygenxml.com.
[templatetask]
[templatetask] at com.oxygenxml.publishing.template.AntLicenseValidationHandler.validationEnded(AntLicenseValidationHandler.java:88)
[templatetask] at ro.sync.licensemanager.webhelp.WebHelpLicenseChecker.checkLicense(Unknown Source)
[templatetask] at com.oxygenxml.publishing.template.PublishingTemplateTask.checkLicense(PublishingTemplateTask.java:467)
[templatetask] at com.oxygenxml.publishing.template.PublishingTemplateTask.execute(PublishingTemplateTask.java:307)
[templatetask] at org.apache.tools.ant.UnknownElement.execute(UnknownElement.java:299)
[templatetask] at jdk.internal.reflect.GeneratedMethodAccessor6.invoke(Unknown Source)
[templatetask] at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
[templatetask] at java.base/java.lang.reflect.Method.invoke(Method.java:568)
[templatetask] at org.apache.tools.ant.dispatch.DispatchUtils.execute(DispatchUtils.java:99)
[templatetask] at org.apache.tools.ant.Task.perform(Task.java:350)
[templatetask] at org.apache.tools.ant.Target.execute(Target.java:449)
[templatetask] at org.apache.tools.ant.Target.performTasks(Target.java:470)
[templatetask] at org.apache.tools.ant.Project.executeSortedTargets(Project.java:1401)
[templatetask] at org.apache.tools.ant.helper.SingleCheckExecutor.executeTargets(SingleCheckExecutor.java:36)
[templatetask] at org.apache.tools.ant.Project.executeTargets(Project.java:1264)
[templatetask] at org.apache.tools.ant.taskdefs.Ant.execute(Ant.java:437)
[templatetask] at org.apache.tools.ant.taskdefs.CallTarget.execute(CallTarget.java:106)
[templatetask] at org.apache.tools.ant.UnknownElement.execute(UnknownElement.java:299)
[templatetask] at jdk.internal.reflect.GeneratedMethodAccessor6.invoke(Unknown Source)
[templatetask] at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
[templatetask] at java.base/java.lang.reflect.Method.invoke(Method.java:568)
[templatetask] at org.apache.tools.ant.dispatch.DispatchUtils.execute(DispatchUtils.java:99)
[templatetask] at org.apache.tools.ant.Task.perform(Task.java:350)
[templatetask] at org.apache.tools.ant.Target.execute(Target.java:449)
[templatetask] at org.apache.tools.ant.Target.performTasks(Target.java:470)
[templatetask] at org.apache.tools.ant.Project.executeSortedTargets(Project.java:1401)
[templatetask] at org.apache.tools.ant.Project.executeTarget(Project.java:1374)
[templatetask] at org.apache.tools.ant.helper.DefaultExecutor.executeTargets(DefaultExecutor.java:41)
[templatetask] at org.apache.tools.ant.Project.executeTargets(Project.java:1264)
[templatetask] at org.dita.dost.invoker.Main.runBuild(Main.java:769)
[templatetask] at org.dita.dost.invoker.Main.startAnt(Main.java:234)
[templatetask] at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
[templatetask] at java.base/jdk.internal.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:77)
[templatetask] at java.base/jdk.internal.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43)
[templatetask] at java.base/java.lang.reflect.Method.invoke(Method.java:568)
[templatetask] at org.dita.dost.invoker.MainWithCPWildcardExpansion.startAnt(MainWithCPWildcardExpansion.java:65)
[templatetask] at org.apache.tools.ant.launch.Launcher.run(Launcher.java:284)
[templatetask] at org.apache.tools.ant.launch.Launcher.main(Launcher.java:101)
Error: Cannot find a valid "licensekey.txt" license file in:
- the DITA-OT directory: "C:\Program Files\Oxygen XML Editor 26\frameworks\dita\DITA-OT"
- the plugin base directory: "c:\Program Files\Oxygen XML Editor 26\frameworks\dita\DITA-OT\plugins\com.oxygenxml.webhelp.responsive"

Please place your Oxygen WebHelp or Oxygen Publishing Engine license key in a file called "licensekey.txt" and copy it to one of the above locations.

If you do not have a license key or you need more details, please contact sales@oxygenxml.com.

It looks like for now, if I want to use the dita.bat in built-in dita-ot to generate a webhelp, I need to purchase a license of Oxygen Publishing Engine, is that right? In other words, generating webhelp is no longer available to CLI users with oxygen xml editor license, right?

Thanks and Regards,
Galano
ionela
Posts: 402
Joined: Mon Dec 05, 2011 6:08 pm

Re: --format=webhelp-responsive isn't supported in CLI?

Post by ionela »

Hi,

The DITA Map WebHelp Responsive transformation can be run from Oxyen XML Editor but only using the GUI. Also, the WebHelp plugin that comes bundled with Oxygen XML should be used only from Oxygen XML, it is not recommended to use that plugin outside Oxygen XML Editor (from command line).
If you need to run the WebHelp transformation outside Oxygen XML Editor (e.g. command line), you we recommend you to download Oxygen Publishing Engine
Oxygen Publishing Engine is an archive that contains a DITA Open Toolkit distribution with Oxygen publishing plugins already integrated
This requires a separate license key either for Oxygen Publishing Engine or Oxygen XML WebHelp.

Generating Oxygen XML WebHelp output from command line using an Oxygen XML Editor license key has never been permitted by the license terms.

Let us know if you need additional information.

Regards,
Ionela
Ionela Istodor
oXygen XML Editor and Author Support
galanohan
Posts: 115
Joined: Mon Jul 10, 2023 11:49 am

Re: --format=webhelp-responsive isn't supported in CLI?

Post by galanohan »

I had this test that with a trial license key for oxygen publishing engine, the dita.sh or dita.bat under DITA-OT/bin of a licensed oxygen xml editor could execute commands for webhelp transformation in CLI (for example, Windows CMD or Linux's Terminal). The only thing that bothers me was that such webhelp cannot grab the predefined footer file specified in the .opt. (Which is weird)
ionela
Posts: 402
Joined: Mon Dec 05, 2011 6:08 pm

Re: --format=webhelp-responsive isn't supported in CLI?

Post by ionela »

Hi,

By design, that footer can be customized only with a commercial license of Oxygen XML WebHelp/Publishing Engine. The webhelp.fragment.footer parameter used to customize the footer is not available while using a trial license:
How to Create a Custom Footer

Let us know if you need further assistance.

Regards,
Ionela
Ionela Istodor
oXygen XML Editor and Author Support
galanohan
Posts: 115
Joined: Mon Jul 10, 2023 11:49 am

Re: --format=webhelp-responsive isn't supported in CLI?

Post by galanohan »

Thank you, Ionela!
Post Reply