How do I link to a HelpID or a Search Term without any programming, through a URL?

Forum|Forum|11 years ago
June 7, 2014
1 reply
494 views

I have looked through the documentation, and it seems that every "possibility" to call either a search term or a HelpID/CHSID for my documentation is to use some sort of API.

Is there a way to call the search function and CHSIDs directly by only typing a URL in a browser (or link from another page, or from an email, etc etc)?

I'd actually like to know for all 3 outputs I am potentially going to be using: WebHelp, WebHelp Pro (RoboHelp Server 9) and HTML5, as I'm not sure yet which form it will take at the software release.

Thanks!

This topic has been closed for replies.

Correct answer RoboColum_n_

See Calling Webhelp for the options for calling WebHelp. Although it doesn't explicitly say so, WebHelp Pro has the same options. I can't speak for HTML5. As for calling a search term, you may well be right that you call one programatically but I would not know about that.

RoboColum_n_Correct answer

Legend

See Calling Webhelp for the options for calling WebHelp. Although it doesn't explicitly say so, WebHelp Pro has the same options. I can't speak for HTML5. As for calling a search term, you may well be right that you call one programatically but I would not know about that.

O

OL-LachanceAuthor

Inspiring

Ok so basically, "Map IDs" and "Topic IDs" are different... but they're setup the same. Very confusing to me.

What's very ironic to me is the comment on the Topic ID page, "undocumented javascript". considering that Widgets are also undocumented, I'm starting to get a feeling that maybe somebody should take the time to fully document the documentation software... y'know.

O

OL-LachanceAuthor

Inspiring

Hi OL-Lachance

A couple of items I would add to Willam and Colum's comments.

At the present time, WebHelp Pro (the Rh Server 9) does not support HTML5 output. WebHelp on a conventional web server is fine.
In terms of the odd terminology for CSH, the term MAP Number or Map ID, generally refers to a unique number that is assigned to a topic so that it can be referred to in the application calling the help. The Topic ID is generally an alphanumeric string which is often the name of the topic title connected by underscores. Depending on the language of the application, sometimes only the Map number or sometimes only the Topic ID is used. Or, as you have learned, sometimes neither one is used and a URL is used instead!

You and your developers may also find these topics helpful in the RoboHelp online help which can be downloaded here:
http://help.adobe.com/en_US/robohelp/robohtml/robohelp_11_help.pdf

Look at Chapter 11 for some interesting specifics on the many ways to call CSH. Of course the links mentioned in Willam's and Colum's posts are excellent as well.

John Daigle

Adobe Certified RoboHelp and Captivate Instructor

Evergreen, Colorado

www.showmethedemo.com

Thanks for the precision on the differences between MapID and TopicID.

As for the "interesting specifics", if you're talking about the documentation giving multiple APIs and ways to call the documentation using functions... honestly that's not going to happen with us. Specific code implementations like this pretty much means that if we were to decide to switch to another documentation authoring suite, there would be a necessary code change in our software, and that sort of lock-in is not very desirable. Whereas now with pure URL calls, if I decide I'm going with someone else, I can just change my urlRewrites to the new format and be done with it. We don't have plans to change, but keeping the door open is fine with us.

Sign up

To post, reply, or follow discussions, please sign in with your Adobe ID.

Sign in to Adobe Community

To post, reply, or follow discussions, please sign in with your Adobe ID.

Scanning file for viruses.

This file cannot be downloaded