Skip to main content
Participating Frequently
August 18, 2008
Question

Creating "Topic Alias" marker in FM document for CS Help

  • August 18, 2008
  • 5 replies
  • 2267 views
Hi,

I am eventiually moving toward creating content sensitive help and am looking at preparing the source documents for the leap (documents in my Framemaker version7 and book file) for the leap. On-line, it says that I should create markers called "Topic Alias" and marker the topics/ headings with this marker. I have tried to do this but, Once I convert those same documents (the book) into RoboHelp, my "Topic Alias" markers don't appear. What I find confusing is that my other markers (e.g. TOC markers) are visible in RoboHelp.

Would someone know why my Topic Alias markers are not appearing? Am I preparing my document the correct way?

Thanks you. I have posted this on the RoboHelp forum but as this deals with both FM and RoboHelp, I am also posting this here.

Thanks,

Ingrid
    This topic has been closed for replies.

    5 replies

    Participant
    October 28, 2008
    I'm working with the following versions:
    RoboHelp 7.02.001
    FrameMaker 8.0p277

    Thanks,
    Lisa
    October 27, 2008
    Lisa, can you confirm which versions of FM and RoboHelp you're using (including the "pxxx" numbers in Help > About)?
    Participant
    October 27, 2008
    I tried following your procedure but I don't see that RoboHelp is using the context-sensitive markers I defined in FrameMaker.
    I've been using TopicAlias markers.
    RoboHelp places a CSH marker in the topic, but seems to be ignoring the text I entered in the TopicAlias markers.
    Can you shed some light on this issue?
    Participating Frequently
    September 9, 2008
    Ingrid

    You should use the FrameMaker integration category in RoboHelp forum.

    Scenario 1 - Map files provided by Developers - If you import the map files in the project before you add the FrameMaker book in RoboHelp, context sensitive help should work fine. RH already has a map file called BSSCDefault.h - don't worry about it. The alias file was practically empty. When I checked "All Map IDs" in Project Manager, none of the IDs visible in the opening pane were assigned to topics.

    If you import the map files after you have added the book - you need to do one Force Update for RoboHelp to connect the two sets of information. All Map IDs are properly assigned to topics and the context-sensitive help worked properly

    Steps
    1. Add FM files to the project. Select the Topic Alias Markers in the Context Sensitive Help field during import.
    2. Go to Project Settings Pod, open Context Sensitive Help folder and right click on Map Files. You shall get Import Map File option in the context menu. In the import dialog box you will get option to import .hh, .hm and .h files. Please ensure that Locked option at the bottom is checked. RoboHelp will not touch your file if this option is on.
    3. If required, force update and then generate your SSL output.
    4. Use the Help for context sensitive help in your product.

    Scenario 2 - Map files generated by Help Author - We defined our special marker in the field "define context sensitive help marker". And there are markers (CSH_1 to n) in the topics but there are no map ids with the markertext from the framemaker files and thus there is no mapping. By the way, we are working with referenced framemaker files. You can generate MapID file through RoboHelp, export the mapid file and re-import it in locked mode.

    Steps
    1. Defined your special marker in the framemaker files:
    2. During import define your special marker in the correct option
    3. Import the FrameMaker files - Robohelp does not automatically create the mapIDs on the basis of our special markers in the framemaker files. There ae CSH_n-markers in the HTML-code of the topics, but they are not mapped automatically, because there are no mapIDs from the frammaker files. You can use the AutoMap feature in RoboHelp. Select topics on the right pane of the CSH dialog and click on AutoMap.
    4. Export the mapid file and re-import it in locked mode (as described in Scenario 1).

    I had updated my blog post - The behavior has changed after RoboHelp patch 7.0.1. RoboHelp does not generate the mapIDs automatically and enables you to load the developer provided mapping files. If you are generating mapping files for your developers, please generate it through RoboHelp and export it. For importing the mapping file -> Go to Project Settings Pod, open Context Sensitive Help folder and right click on Map Files. You shall get Import Map File option in the context menu. In the import dialog box you will get option to import .hh, .hm and .h files. Please ensure that Locked option at the bottom is checked. RoboHelp will not touch your file if this option is on.

    http://www.adobe.com/cfusion/webforums/forum/messageview.cfm?forumid=65&catid=680&threadid=1349305&enterthread=y
    http://www.adobe.com/cfusion/webforums/forum/messageview.cfm?forumid=65&catid=680&threadid=1348153&enterthread=y
    http://www.adobe.com/cfusion/webforums/forum/messageview.cfm?forumid=65&catid=680&threadid=1349232&enterthread=y
    Known Participant
    August 18, 2008
    Ingrid:

    Off the top of my head, should they be TopicAlias markers rather than "Topic Alias" markers (i.e., no space)?

    Cheers & hope this helps,
    Riley