Skip to main content
A
Anonymous
July 26, 2016
Question

How do I make context-sensitive help work?

  • July 26, 2016
  • 2 replies
  • 5283 views

I am using RoboHelp 2015. This is the first time in more than 10 years that I have used any version of Robohelp, so I need short, simple answers.

I'm trying to create Webhelp. Each HTML file in the project is specific to a particular module in the software. When you click the help button while module X is on screen, the help should open at the start of the file specific to that module.

I'm trying to use map IDs. I have gone through the RoboHelp online help about doing so. I have created map ID and assigned them to the files. I have a .H file with all the IDS in it. I've given the map IDs to the developers and they have done I'm not sure what with them. I've repeatedly regenerated the Webhelp. It has been installed on the server. Any time a user clicks a help button anywhere on the product GUI, the help opens at the default title page of the Webhelp.

The previous version of the help, which was created by a tech writer who has been gone for years, worked properly. I can't figure out how. It included a CSH.JS file. Do I need to create such a file? If so, how do I use it?

I have spent days searching the posts in the RoboHelp forum for information about using map IDs and none of them address my problem. I just can't get context sensitivity to work at all. I need someone to point me at a video, an article, something that provides detailed do-this-do-that baby-step instructions. When it comes to making context sensitive help I literally don't have a clue what I'm doing, and I need to get this project done quickly.

Is there any such material available anywhere?

This topic has been closed for replies.

2 replies

S
She_Tried_It
Inspiring
October 23, 2018

I'm, in the same situation. I'm the new person trying to make an update for a November 2018 release. (When a user is on a particular screen and presses F1, the RH help topic should display.) There are new topics I've created and made changes to existing and I need the screen names/IDs for the module in the software. I am not getting any information from the developers regarding the IDs of the new screens in the software so I can map them - they keep saying the "last writer used a tool to do all that."

  1. How did you create the "H" file with all the IDs? "I have a .H file with all the IDS in it. I've given the map IDs to the developers..."
  2. Is it possible to map my RH topics to a particular screen without knowing the IDs of the screens in the software? Is there some tool?
  3. If someone can just map out the profess of creating RoboHelp topics and mapping them to screens in a software.
Captiv8r
Captiv8r
Legend
October 23, 2018

Perhaps the video below will help?

S
She_Tried_It
Inspiring
October 23, 2018

Thanks Captiv8r! I watched part of that a few days ago and watched the whole thing since you recommended it.

I now have a better understanding. My issue is a team of developers or rather one developer who doesn't seem to understand that I need his cooperation. Had we not had new screens in the software release, I could make the Help file updates using the files from the previous writer and pass them along.

But I have 4 new screens that need RH topics created and mapped to the software -- when F1 is pressed, the RH topic displays.

1. From most sources, they say I send the .h map file to the developers. What do they do exactly? Connect my IDs to the screens?

2. Other than creating the RH Map IDs and Map#s - is there something I can do on my end to make the software screen map to the correct RH topic?

I need to have perhaps the 10th conversation and push back - letting them know I need them to perform some steps on their end. They allude to a "tool" the previous writer used - doing it all on her own - but I think she just worked with someone else on the team to perform the mapping and the guy I now work with was not aware. She's been gone a year...

I just need to know if there's any other way RH can map a topic to a screen in the software, other than a developer taking my map file and programming the connections. I'm having a meeting this week and want to make sure I'm correct in what I share.

Thanks for the video and any continued help.

Captiv8r
Captiv8r
Legend
July 27, 2016

Hi there

You might start here:

https://www.wvanweelden.eu/articles/context-sensitivity-webhelp-and-flashhelp

I know my dear friend John Daigle had an article somewhere on Adobe, but it seems to have performed a disappearing act!

Cheers... Rick

A
Anonymous
July 27, 2016

The article refers to "you or the author of the help system," so I believe it is aimed at the developer who modifies the product code and all the actions referred to take place in the code. If I am wrong on that, please by all means correct me.

I will try to talk to the developer and see if I can get some time with him to cover this stuff, but that is doubtful. We have a release coming up and he is still very busy trying to get last-minute problems in the code ironed out.

Jeff_Coatsworth
Community Expert
Jeff_CoatsworthCommunity Expert
Community Expert
July 27, 2016

You need to provide your file of Map IDs and the method for launching the help - that will depend on how the developer wants to do this - show (or copy to give them) the \CSH API\ folder that RH comes with (it's in your \Program Files\ location where RH is installed). It has a number of programming language variants available. The launching program queries the index page of your help with the Map ID and the tool knows how to return the exact page you want shown to be displayed in a little headless browser window. You can add the ability to "expand" out the full tri-pane help by adding a "Show" link to the output files (it's controlled by a flag in the Single Source Layouts recipe).

Terms & ConditionsAccessibility statement
Using the community Terms of use Privacy Cookie preferences Do not sell or share my personal information ad choicesAdChoices