Passing search parameters into HTML5 webhelp

[NeilWilliamson]

Our product requires that our online help can be kicked off when the user enters a search term into the search box integrated into the product itself. This action should launch the help package, displaying the search results (the same as if the search string had been entered into the help package's search box). We were able to do this with webhelp but now want to move to HTML5 help. Can anyone suggest how we go about passing the inputted search parameters into HTML5, please?

Cheers

Neil Williamson

[Willam van Weelden]

Add the following two parameters to the URL when you call the help:

rhsearch=<string to search, must be URL encoded>

ux=search

For example:

example.com/robohelp/index.htm?rhsearch=Getting%20started&ux=search

[NeilWilliamson]

Many, thanks Willam. I'll pass this on to the devs and report back as to the success.

Cheers

Neil

[zakwil]

Is there a way to call csh id by parameters?

[Willam van Weelden]

What do you mean by 'call by parameters'? You want to call a specific topic page?

You can CSH as well using the URL. Please see Context Sensitivity in Responsive and Multiscreen HTML5 | WvanWeelden.eu​ for an overview.

[zakwil]

Ok thanks, I need to have Robohelp?

[Jeff_Coatsworth]

If you're trying to create HTML5 help with RH, then , yes, you would need RH2015. If you don't have it, what product did you use to create it?

[zakwil]

Our doc team use Framemaker 2015

[Jeff_Coatsworth]

Ah, ok – you can create HTML5 help directly from FM2015, but the degree of control over the output is limited to what the FM interface exposes. See the FM forum for more info on publishing out of FM.

[JoeJitsu]

This is great stuff. When I test that call, it works, but RH defaults to my TOC view. If i select the Search icon, the string is in there, with results. So the question is, how do i get RH to default to the Search view when passing these parameters?

[Willam van Weelden]

Hmm. I would expect the search bar to be shown if the UX=search is included.

You can always change the default pane to be shown. For Azure blue and Charcoal grey, there's a setting below the 'Basic settings' of the layout.