REST Search API

[Eyal Lewinsohn]

I have published a DITA map as a WebHelp Classic system.
I have an online B2B product.
I would like to develop a "help widget" that would display search results from my WebHelp Classic system in the product.
Clicking on a search result will open the WebHelp system in a new browser tab.

I have developer resources so if this is not on any roadmap I would greatly appreciate any information on how this can be best accomplished.

[radu_pisoi]

Hi,

When WebHelp Responsive output is generated by Oxygen XML Editor, the transformation process produces an XML mapping file called context-help-map.xml and copies it in the output folder of the transformation. This XML file maps an ID to a corresponding HTML page through an appContext element, as in the following example:

Code: Select all

<map productID="oxy-webhelp" productVersion="1.1">

  <appContext helpID="myapp-functionid1" path="tasks/app-help1.html"/>

  <appContext helpID="myapp-functionid2" path="tasks/app-help1.html"/>

    .  .  .

</map>

Please note that the paths are relative to the location of the context-help-map.xml mapping file.

There are two ways of implementing context-sensitive help in your system:

• Invoke the index.html WebHelp system file and pass the contextId parameter with a specific value.
  The WebHelp system will automatically open the help page associated with the value of the contextId parameter.

  Code: Select all

  index.html?contextId=myDITATopic

• If you want to implement a "help widget" in your application, you can use the context-help-map.xml file to find the URL associated with your view. Then, you can load the address in a widget that supports HTML, like javafx.scene.web.WebView for JavaFX.
  http://docs.oracle.com/javafx/2/webview ... ebview.htm

[Eyal Lewinsohn]

Thank you very much for the detailed response.

However, I think that this will not satisfy our needs.

When you run a search on WebHelp Classic you get result that contain the word/s you were looking for.
The map file you are referring to does not seem to include this information.

Ideally, I would like to invoke the same search function on WebHelp classic only from an API and not the normal browser interface. Than I would like to display the results in my application.

I hope this clarifies the topic,

thanks again,
Eyal

[bogdan_cercelaru]

Hello,

Ideally, I would like to invoke the same search function on WebHelp classic only from an API and not the normal browser interface. Than I would like to display the results in my application.

Unfortunately the WebHelp system doesn't have API for this.
I've registered this, as a feature request in our issue tracking system to be analyzed.

Regards,
Bogdan

[syed]

Hello,
Does Webhelp have a search API now that can be called from a web application?

Thanks...
Syed

[cosmin_andrei]

Hello,

Unfortunately, Oxygen XML WebHelp system does not have a component (server) to provide API search.