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!

Hi,
When you use CSH in a merged project, the master project will automatically check all child projects when the context sensitive id cannot be found in the master project. Peter’s method includes merging the map files but I don’t think that is necessary. We have several merged projects that work perfectly without merging the map files. But Peter is the authority on merged help
It is important to first get the terminology straight. In WebHelp there are Map ID’s and Map numbers. The Map ID (or topic id) is an alphanumeric string that can be anything from one character to a hundred or more characters. Then there are the Map numbers. Map numbers are a number between 1 and 4.294.967.295.
The terminology is important because what RoboHelp calls a Map ID may be referred to as a map number. Reading the article on Peter’s site I get the impression that what is called a Map ID on Peter’s site is actually the Map number in RoboHelp. (Please correct me if I’m wrong Peter.) The Map ID in RoboHelp is the Topic ID on Peter’s site. See step 8 of the article, it describes how to create a test page using the default RoboHelp JavaScript API. But that test page actually uses the map numbers as the default JS API does not support topic id’s, only map numbers.
Your map file tells the following:
‘12345’ is the Map ID or topic ID.
‘1’ is the Map number. The Map ID referred to on Peter’s site if I’m not mistaken.
Calling the Map number 12345 will not work if you use the default method because you are looking for the wrong number. Try the following:
Say that your master project is placed on http://localhost/newproject.htm. Open a new browser window and add the following URL in the browser where you replace the url with the url your project is placed:
http://localhost/newproject.htm#<str=12345
Does this get the desired result? Also try the test page but use ‘1’ instead of ‘12345’. Does this also get the correct page?
You (or your developers) may also be interested in my WebHelp CSH dissection: http://www.wvanweelden.eu/robohelp/webhelp/csh Note that this article is aimed at developers and does not provide any direct answers, but it will help you understand the different settings in RoboHelp.
Hope this doesn’t confuse you and I hope my assumptions about your intended action are correct.
Greet,
Willam

Similar Messages

What are the advantages of using Map IDs?

Hi:
I am trying to find out the advantages for using map ids as
opposed to just using the file names for the topics, but I couldn't
find this information in the RH7 Help or the forums. Can you please
list the advantages and disadvantages.
Also, I am describing how I wish to implement the context
sensitive help feature for my application and you can tell me which
approach is better. We make an application that is packaged within
a Java IDE. We want to launch context sensitive help topics from
the wizards and cheat sheets. Now, this context sensitive help can
be either be installed on the local machine or network (file://
protocol) or available on our portal (https:// protocol). We do
have the infrastructure in place to let the user decide whether
he/she wants to access the local help topic or the one over the
internet. Will map ids work for both the scenarios?
Thanks,
K

It sounds like your application call needs to call an online
version of the help first and if this is not available to point to
a local copy. Is that right? If so, how this happens is entirely in
the hands of your developers. I know it can be done, just sketchy
on the actual procedure.
As far as the CSH in the help is concerned, you can use
mapids for both versions of the help if you want. If using webhelp
you'd do well to check out
this
link on Peter Grainge's site.

Calling WebHelp Topics using Map IDs didn't work

Hi all,
Can anybody please tell me what is it that I am doing incorrect:
I created a sample web page and added the following to the head section:
<script type="text/javascript" language=JavaScript1.2 src="context-WebHelp/RoboHelp_CSH.js">
In the body, my link looked like this:
<A href='javascript:RH_ShowHelp(0,"C:\Program Files\...\Help\Infolinxweb_help.htm>Mainwindow", HH_Help_Context, 10)'>Help</a>
BTW: We have RH6
Thanks,
Sangeeta

Hi Sangeeta.
You'll find the correct syntax over at Peter Grainge's article on calling webhelp at:
http://www.grainge.org/pages/authoring/calling_webhelp/using_map_ids.htm
Read the RoboColum(n) for a tips, tricks and musings on the Technical Communication Suite products.
Follow the RoboColum(n) on Twitter

Creating context-sensitive HTML Help without using Map #s

I am uisng RH 8 and am producing a compiled HTML Help file.
I am wondering if there is another way to call a topic from our application without using the MAP numbers in RH.
The developer would like to use the MAP ID (string) instead.
Is there a way to do this?
Please let me know.
Thanks.

Your points are valid but there are also situations when urls are an excellent method.
For some projects our developers name fields and we have a method of identifying the name applied. We use that as our filename. By that means they know what the help file will be and can create the call before the topic exists and we don't have to maintain map ids for those projects. If we should fail to create the topic, the call has the logic to go to a higher level.
I wouldn't advise using map ids or urls, I would say understand how both work, their pros and cons, and then decide what works for the project.
See www.grainge.org for RoboHelp and Authoring tips
@petergrainge

Removing the Pound Sign in MAP IDs

We want to use MAP IDs in our Web Help output in order to
bring up the correct document for each screen. The MAP IDs are
based on the screen names, which makes things pretty easy for the
developers. This is the code for calling the desired screen:
http://www.company.com/help/help_csh.htm#topicId=TOPIC,withnavpane.
Is there ANY WAY (like with javascript or some other magical
thing) we can change the pound sign (#) to a question mark (?) and
still bring up the correct page? We're hoping there is something we
can do in RoboHelp so we don't have to drag a bunch of developers
into it.
Any suggestions you have would be greatly appreciated.

Hello bgatch,
I do not believe that there is a way to do what you are
after. I suspect the better question is why do you want to replace
the # with a ? in the first place? Hopefully, once we understand
the workflow a bit better, we can come up with a better answer for
you.
Thanks,
Bobby W
Adobe Customer Care

Creating Map IDs using HTM File Name

Is it possible to create Map IDs using the File name of the HTM, instead of its Topic Title?

While Generating Map IDs, we get an ID along with a Map # for each HTM in the CSH.
For Example, I have a HTM in my CSH with the following Details:
Topic Title - Access Masks
File Name - admpr00001.htm
Now when I create a Map ID for this page. I can customise the Map ID by setting any/all of the three options: - 'Prefix Map IDs with', 'Make Uppercase' and 'Start Numbering with'. But the Map ID is generated only based on the Topic Title.
Like - ebACCESS_MASKS 1000 where, eb is the set prefix.
Is it possible for me to create a MAP ID using the File Name. In this case, as ebadmpr00001 1000?
Hope I am clear .

How Do RoboHelp 9 WebHelp Generated Files Handle Map IDs and Aliases?

The text below was written by our team's developer/architect. I am the help author who uses RoboHelp to write content and generate the help files, but I am clueless how it all gets generated and is deployed. Please help. We use RoboHelp 9. I use it in Windows XP and our app and help run on IE 7, 9, and Firefox (multiple versions).
"Our application uses the numeric identifiers associated with the Map ID. For example, to get to the <appname>_home_page.htm file, we use the number 1053. <appname> = pecs, in this example.
All of this is used in a call to a RoboHelp method defined in the RoboHelp_CSH.js file. The mehtod we are calling is the RH_ShowHelp() JavaScript method and the code to perform the call, when you click on Page Help, is this:
RH_ShowHelp(0, ''/pecsHelp/index.htm>pecsHelp',HH_HELP_CONTEXT,topic);
Topic is translated to the Map ID number for the page help. HH_HELP_CONTEXT is defined in the RoboHelp_CSH.js file. This method translates into a URL and from what I have seen, the URL that gets generated is this:
http://{server}[:port]/pecsHelp/index.htm/{server}[:port]/pecsHelp/index.htm#<id=1053>>pecsHelp
Server and port get replaced with the appropriate values. I have no clue how id=1053 is supposed to get translated to mean "pecs_home_page.htm". If you check the PECS_help.h file, you will see the following entry:
#define PECS_Home_Page1 1053
Then in the RoboHelp alias file (PECS 3.0.ali), the following line is in the file:
<alias name="PECS_Home_Page1" link="pecs_home_page.htm"> </alias>
But both of these files are used during the WebHelp generation process and I don't know how the WebHelp generated files handle the Map ID and aliases."

You need to assign the numbers you find in the pecs_help.h file to topics in your help. You do this in Context Sensitive Help > Map Files > All Map IDs. (From RH7, but I assume the location is similar in RH9.) This creates the entries in the .ali file.
Peter Grainge suggests a couple of sites to read for a greater understanding here:
http://www.grainge.org/pages/authoring/calling_webhelp/using_map_ids.htm
(Although the second site is based on RH X5, the basic concepts and procedures should be very similar. )
HTH,
Amber

Why are Map IDs landing in Project Map File, not All Maps, and with a .h extension

I am using the Tech Comm Ste 2, Adobe Robohelp 8.0.2.2 in Windows XP. I assign map IDs manually instead of using automap. I open the Edit Map IDs window. In the right column, under "Topic," I select the topic I want to map. I then click the icon below to open the Context-sensitive Properties for Help Topic window. I select the topic title, without the .htm, and copy it. Then, from the left column, I click the Map File dropdown list and select the HH file to which I want to map the help topic. I then click the icon at the bottom to open the Create/Edit Map ID window. In the first field, I paste the topic ID, and in the second field I enter the map ID I want to assign. Then I click OK.
Usually this places the topic in the correct HH file, highlighted in yellow until I select the topic from the list and then click Assign. For some reason, RH is not adding my topic to the HH file; instead it is adding it to the Project Map file. When I click OK, I get a blank window and the Assign button is disabled. My topic shows up in the Project Map File. The topic displays with the HH files and a .h extension has been added to it.
I can't delete these topics from the Project Map file. I can't assign them map IDs. And this seems to happen randomly. SOMETIMES I can map my topics, but I never know when I can do it and when one of them is going to land in the Project Map file.
Can anyone help?

Personally I've never had or heard of this issue. The fact that this appears to be random suggests that the MapFile dropdown may not be displaying the correct map file when you add or assign the mapid. Also check to ensure your project's source files are not located on a network drive as this can cause issues. If this continues perhaps you could give us an image of what you are seeing.
The RoboColum(n)
@robocolumn
Colum McAndrew

How do I update linked FM files without losing TOC entries or Map IDs?

Hi,
I'm using RH 10 with linked FM 11 files to create a WebHelp project and this is what happens when I do an update or force update of a linked file in the RH project:
After the update, the topic that contains updated content gets deleted from project TOC in RH.
After the update, any Map IDs assigned to the topic that contains the updated content are deleted.
Can someone please advise how to update a linked file without losing TOC entries or Map IDs?
Thanks a bunch!
Gabe

HI Gabe,
You will want to link the TOC from FM in your conversion settings, and set the map id's via TopicAlias markers in FM.
-Matt
Matt R. Sullivan
co-author Publishing Fundamentals: Unstructured FrameMaker 11
P: 714.960.6840 | C: 714.585.2335 | [email protected]
@mattrsullivan LinkedIn facebook mattrsullivan.com
http://mattrsullivan.com/

Imported a .h map file, no Map IDs show

Background: RoboHelp 10 project, linked to a FrameMaker 11 book, HTML Help output. No errors or missing resources on update of Fm book.
After linking the project to a Fm book with TopicAlias markers selected for CSH, I imported a .h map file used by the developers and did a Force Update All. The imported map file shows up under the Map Files node in the Project Set-up pod. But when I double-click it, nothing displays in the Map IDs panel on the left side of the Edit Map IDs dialog box.
I thought 1) specifying TopicAlias markers for CSH during link setup, and 2) importing the developers' .h file would map the IDs to the topics.
Am I doing something wrong in the linking or .h import steps? I really don't want to have to manually edit the topic IDs in BSSCDefault.h--there are hundreds of them.

Umm, if you’re using the markers from your FM files to set the mapping, why are you getting something from the developers? In your workflow I would expect you to be sending them your .h file, not the other way round ;>)

Map files and map IDs

This question was posted in response to the following article: http://help.adobe.com/en_US/robohelp/robohtml/WS5b3ccc516d4fbf351e63e3d11aff59c571-7ff9.ht ml

Typo in this section:
Remove an unused map ID
Your map files must be unlocked to use this option. To remove unused map IDs:
Expand the Context-Sensitive Help folder in the Project Set-up pod.
Right-click the Map Files folder.
Select Edit.
Do the following:
Map Files Select the map files from which to remove unused map IDs.
Select All Click to remove unused map IDs from all map files.
Clear All Click to deselect all map files and not remove unused map IDs.
The third point should read "Select Remove Unused Map IDs..." instead of "Select Edit"; then the rest of the topic makes sense.

Assigning Map IDs when using Version Control

Hi
We are using RH11 with version control (two of us have licences to use RH) I am wanting to assign Map IDs in our project. I created the map number, but when I go to assign it to a topic, I get the the following message.
"The files in the list below could not be checked out from version control. Exclusive access to these files is required to execute the selected action"
The file in the list that it is referring to has the extension .ali
Is this saying that because there are two of us with RH that can access the project that I can't do this? Or is it because of the version control I cannot do this? I don't really understand why? I am hoping there is an expert who can enlighten me!
Thanks, Louise

There are two reasons that this behaviour normally occurs:
The file is checked out by the other author. This happens when you both are trying to add new map id's at the same time. If the other author checks in the entire project, you should be fine.
The file is somehow located outside source control. In this scenario your source control link has issues. Try opening the Source Control application to see what is going on.
Can you also try checking out the entire project before adding the map id. Does that help?

How to get the filename in mapping when using sender File adapter?

hi Experts,
   I have scenario where XI reads the input file using Sender file adapter.
   The file name is configured in the communication channel.
   In my message mapping it is possible to read this file name?
Thanks
gopal

Hi Gpoal,
Use Dynamic Configuration - /people/michal.krawczyk2/blog/2005/11/10/xi-the-same-filename-from-a-sender-to-a-receiver-file-adapter--sp14
Regards,
Geetha

Has anyone seen changing map ids corrupting an HTML project?

I am working in RoboHelp8, and generating .chm help files to be attached to my company's software application. I built a map id file from numbers the programmer gave me. His calls have been able to use my generated files, but the "HH_HELP_CONTEXT called without a [MAP] section error message shows up when using context-sensitive help links.
What I've done so far:
I took a project from my backup server to replace the project that keeps giving me the map id error message (attached) when I hook it to the application.
1. I made some minor text changes to the file and generated, hooked it to the application, it ran ok.
2. I backed up the entire RH project.
3. I opened the project again in RH, and tried to make some necessary changes to the map ids. This seems to be the problem area, because after making the changes and regenerating, the error message reappears. Plus, when I reattach the generation from step 1, the one
without the map id changes, it fails too.
It appears to me that changing map ids within RoboHelp does something to corrupt my project. I have noticed that behavior is strange when I
attempt changing map ids. The destinations disappear unexpectedly, map ids say Unassign when there is no destination, etc. I have tried
deleting all 20 of them and mapping them again, with no different result.
Do you know anyone who has experienced this?
Better yet, do you know an expert in the San Francisco Bay area who I can consult with?
The application my organization is developing is supposed to be put on CD today, so this is a huge problem, impacting the whole team. Any
ideas you may have would be welcome. - Caroltypesetting

See if this thread helps.
Read the RoboColum(n) for a tips, tricks and musings on the Technical Communication Suite products.
Follow the RoboColum(n) on Twitter

Missing Map IDs in RoboHelp 7 HTML

Hi -
We produced Webhelp for various projects using RH 7.0. We
have a help file with 460 topics and we painstakingly make sure
that as we add topics, we add a map ID, so everything is in sync.
However, yesterday we found looked in the project and found that
one of our older topics has no map ID attached to it (If you go to
Topic Properties>Advanced, it says “No Map
ID…”). But, in the whchsdata.htm file, the topic does
have a map ID.
I have two questions: First, is there an easy way to pinpoint
which topic has a missing map ID, when you discover the number of
map IDs is out of sync with the number of topics? Also, why would a
map ID be missing in the project but be OK in the Webhelp as
described above?

Hi Mary.
You can see the topics with no mapid by running one of RH's
reports. The Mapid report lists the mapids and the topic they are
assigned to. The Topic Properties report can also be used with the
mapid option on to show topics with their mapid.
As far as why the topic with no mapid is in the webhelp, is
the file you are looking at the latest version? I'd ensure you have
the "Republish All" option set and try again.

Using Map Files / Map IDs

Similar Messages

Maybe you are looking for