Skip to main content
January 11, 2008
Question

RH7: Map ID and Frame Topic-Splitting

  • January 11, 2008
  • 2 replies
  • 1241 views
Greetings. Hope someone could help with the following:

I've created a very simple Frame file with two 'Heading2' paragraphs and a handful of other paragraphs types to describe contents.

For illustration purposes, let's say the Map file I have received form my developer has exactly two entries:
HIDD_APP_PREF_FIRST_DIALOG 0x200E8
HIDD_APP_PREF_SECOND_DIALOG 0x200E9

At the beginning of each paragraph I have inserted a custom marker with the name 'HelpMarker'.

(Question 1) What is the exact text that should go in each marker text box?

When I add my Frame file by reference, I specify 'HelpMarker' in the 'Define Context-Sensitive Help Marker' text box.

In the 'Style Settings' dialog...
-- I specify 'H2' as the 'User-Defined HTML Tag'
-- I check 'Heading 2' for pagination settings and click 'Finish'.

Once the Frame file has been processed I have only one topic. I would expect to have two.

(Question 2) What should be done differently to have one topic per 'Heading 2' paragraph type in my original Frame document/
When done
This topic has been closed for replies.

2 replies

Inspiring
February 21, 2008
This is addressed in the RoboHelp patch 7.0.1.
Inspiring
January 14, 2008
You may want to check out this blog post -
http://blogs.adobe.com/techcomm/2007/10/generating_context_sensitive_h_1.html. It says "A unique ID should be specified as the marker text at the time of applying this marker. Since this marker text would be used as the marker ID, the marker text should contain only alphanumeric and ‘_’ (underscore) character as shown in the figure below. The custom marker applied is ‘ExpBank’ and the FrameMaker ID for this paragraph is specified as ‘Marker1_Authorised_Persons’. "

For your second question, please ignore autonumbering for Heading2 and check if you are getting two topics or one.

regards
Vivek Jain
January 14, 2008
Vivek,

Thank you for your response. I have seen the page. Sorry to trouble you but I am missing something basic.
Please see my original post above. I am interested in understanding exactly how to use the hex values that my developer has provided me in the .hm file I received from him.

I understand that in the marker text can be anything as long as it is unique.
I don't understand the following:

(a) Does the marker 'automatically' map the topic if the string it contains forms a match with an entry in the .hm file provided by the developer?

OR

(b) Must I manually match the hypertext marker with a topic using the 'Edit Map IDs Dialog'?

This second approach is the 'traditional' way of accomplishing this task that I am familiar with, but a demo I saw suggested that (a) was another possible approach.

Additionally, if (b) is the correct approach, then I have the following questions:

After adding a FrameMaker file by reference, the right panel in the 'Edit Map IDs' dialog is populated with a large number of entries; a larger number than I have of either Heading2 topics or of 'HelpMarker' markers.

Could you please explain each class of entry that I see here and how they are to be used in this context? The help system does not provide any guidance on these items.

For example I am seeing:

<filename>........................(this one appears twice; I am not really sure why it appears here at all.)

<filename>#CSH_1........(There are a bunch of these entries. From your blog entry I gather that these are what I am supposed to manually link to but there a many of them. If these are what I am supposed to manually link to, then how can I tell which one to use in any given instance as they are simply numbered and do not provide any idea of the text with which they are associated? It'd be very difficult to accurately create links this way; I hope I am wrong.)

<filename>#HTTEXT_TEXT_TEXT.......What are these and how are they to be used in this dialog?

<filename>#XREFTEXT_TEXT_TEXT.......What are these and how are they to be used in this dialog?

Like I said, I think I am close, but am missing something pretty basic -- so I look forward to hearing from you.

Thank You.
Mayank_Agrawal
Participating Frequently
January 15, 2008
Mayank,

Thank you for your detailed reply. Now I see the core issue. The primary assumption in RoboHelp is that the developer will receive Help IDs from the help author. While I have never known that to be the case in development, I suppose an organization could function that way.

That said, in my workflow, I receive the map file from the developer... I now understand replacing the 'BSSCDefault.h' file; and never opening the 'Map IDs Dialog'... (I certainly won't miss it!) Great!!!

One last and very important follow up question, so let's assume I have done all mentioned above.
Let's also say I want to map a topic to the following entry in the .hm file:

#define HIDD_APP_PREF_FIRST_DIALOG 0x200E8

What exactly should I put in FrameMaker's marker text dialog?
(1) HIDD_APP_PREF_FIRST_DIALOG 0x200E8 ?
(2) HIDD_APP_PREF_FIRST_DIALOG ?
(3) 0x200E8 ?
(4) The decimal equivalent.
(5) Something else.

Once this is clear I think I will be off and running!

PS: Your response was great, for the sake of others, please make sure that these two very different approaches are clearly documented in the help system.

#define HIDD_APP_PREF_FIRST_DIALOG 0x200E8

The Map ID, i.e., HIDD_APP_PREF_FIRST_DIALOG in your case should be put in the FrameMaker's marker text dialog.
The file 'BSSCDefault.h' should be replaced only when you are done with FrameMaker document Add/Import to RoboHelp's project.