Using Map Files / Map IDs
Heya,
RH9, merged webhelp
I'm trying to set up Map IDs for a quasi-context sensitive help feature, and I'm feeling a bit overwhelmed. I've read through the RH9 help which links to the Grainge website and a couple more links, but I'm still not sure what to do.
First, the background:
We auto-generate a set of release notes for new features and fixes. This is done using a script that pulls the relevant information out of Dovetail (basically where all our support and development cases are stored). So basically our release list shows the case number, the area of the software, and a brief summary of the fix/feature. The release notes are script-generated as an .html file that we can link to in help.
The issue is that they want me to alter the release notes so that the case number serves as a hyperlink to the relevant topic in help. So, for example, if we had a new feature for widget making, case number 12345, the release notes entry for this would have a hyperlink that would take the user to the 'Widget Making' help topic.
My thinking is that I can use the case numbers as Map IDs, ie assign Map ID '12345' to the 'Widget Making' topic, and then create a generic link in the release notes that can 'insert' the relevant case number when the user goes to find that associated help topic.
Potential Issue:
We use a merged help system, but we do not need to merge map files. Our help system consists of one mostly-empty parent project (title page, about page, etc.), a project that contains the majority of our topics, a project that contains database information for technical users, and a few other odd projects. All of the linked topics are going to be in the same main child help project. Because of this, the map file/IDs are going to be a single set in a single project, but not the parent project.
Does this only affect the pathway for the basic link (e.g. "webhelp/mergedProjects/child1.htm" instead of "webhelp/start.htm"?), or are there other considerations? For example, the merged help map ID topics I've seen talk about using number ranges to denote the different projects, but since we've only the one, do we really need to do that? To me, it seems like we should be able to use a relatively straight-forward single-project type link, with the only difference being that the the link goes to a child project folder and not the main webhelp folder.
So far in testing, the link doesn't work, so I'm wondering if either the URL is not as straight-forward as I hoped, or I'm missing something else due to the nature of how our webhelp is set up. Because it's a child, do we still need to 'merge' map files even if we don't need one for the parent? (ie we create an empty parent map file, merge it with the child, and link to the parent?)
Thanks for any tips/advice!