8 Replies Latest reply: Aug 21, 2014 6:49 AM by argus08 RSS

    Context-Sensitive Help IDs

    JaneBeckman Community Member

      I hope this is the right format. People here have been very helpful with my questions on transitioning to RoboHelp.

       

      I have TCS 3.0 and have linked pages from Framemaker 10 to generate WebHelp in RoboHelp 9.0.We are trying to migrate to RoboHelp so as to drop our WebWorks/Frame 7 help system. Fine for those systems that don't have context-sensitive Help implemented already, but I'm running into issues

       

      One of our main tools has multitudes of context-sensitive web pages (flagged with a HelpLink tag in Frame).

       

      I go into the Context-sensitive Help tool in RoboHelp to create a map. It needs ID #s for the pages. Currently, our page source follows the format:

      <div class-"menu_item">

      <span class="menu_text" id="m1">Preface</span>

      <span class="menu_link" style="display:none;">Intro_Copyright_and_Warrenty.html#1000183</span>

       

      In creating the context-sensitive help, the format in the tool would then be (reading across the entry fields): Intro_Copyright_and_Warrenty.html m1 Preface

       

      I have created a map, but the IDs are problematic, as we use a format that is not straight numbers. Notice that in the source above, the id is "m1". All of our ID numbers are an alphabet character followed by a number, as we have literally thousands of page links. But the tool will not take anything except numbers. Is there any way to get RoboHelp to accept a mixed-format mapping?

        • 1. Re: Context-Sensitive Help IDs
          Jeff_Coatsworth CommunityMVP

          Might be better in the FM Integration area; however, you can use FM marker text to be used in the creation of your MapIDs in RH. We do this all the time in one of our projects. I created a CSH marker type (along with a character tag) that I use to mark the spots where I want the help launched from within our app. In the CSH marker text, I enter the program name code that will be launching the topic when it's over in RH (e.g. one of our program screens is internally coded GJK10, so the marker text is just GJK10). When I import the FM books over into RH in the Conversion Settings I exclude the CSH character tag from appearing and in the Other Settings I set the "Context Sensitive Help Marker" to my CSH marker. Works really nice at creating a BSSCDefault.h MapID file with numbers to names. We use the Javascript launcher provided by RH to call the CSH MapID numbers to launch the correct topics.

          • 2. Re: Context-Sensitive Help IDs
            JaneBeckman Community Member

            I suspect I didn't explain this well. This would be helpful for one of our other scenarios. And I do appreciate it.

             

            With the book in question, we already have FM text with embedded help markers and conditional text, that we have been using in generating Webworks Help pages, so the infrastructure is already in place. Our developers have already coded map IDs, which we have been using. But they use identifying #  format of M1, M2, M3, M4, M5....etc. in the java source code, and RoboHelp doesn't like it. I try assigning the map # as "M1" and it says that it's an "unacceptable character." "You can only type numbers here."

             

            I suspect that the answer may be having the developers change it to use 1, 2, 3, 4, 5,...etc instead of M1, M2, etc.  But I expect that, based on the number of ID numbers in the code, it's not going to be popular.

            • 3. Re: Context-Sensitive Help IDs
              Peter Grainge CommunityMVP

              Thread moved to FM Integration.

               


              See www.grainge.org for RoboHelp and Authoring tips

               

              @petergrainge

              • 4. Re: Context-Sensitive Help IDs
                argus08 Community Member

                Jeff, what is the purpose of creating a CSH character tag, and excluding it in the RH Conversion Settings?

                • 5. Re: Context-Sensitive Help IDs
                  Jeff_Coatsworth CommunityMVP

                  A tip on the Framers list a few years ago suggested giving your markers a custom Character tag to easily distinguish your different types of markers and where they appear – tricky little “T” buggers ;>)

                  So my Cross-Ref ones are nice big 18 point red “T”s, my index markers are 18 point green ones & my CSH markers are 18 pt teal. I don’t want any of that colouring accidentally coming over to RH, so I exclude it from appearing.

                  • 6. Re: Context-Sensitive Help IDs
                    argus08 Community Member

                    Thanks Jeff. I understood why to apply the character style, but wasn't sure why it should be excluded during the RH  conversion. 

                     

                     

                    ***********************

                    Laurie Little

                    Words That Work

                    www.words-tw.com

                    905-947-1557

                     

                     

                    • 7. Re: Context-Sensitive Help IDs
                      Jeff_Coatsworth CommunityMVP

                      Oh hi Laurie – you actually got us started on this process a few years ago – I never would have discovered the joys of FM/RH without your start ;>)

                       

                      I’m fairly sure that I could skip excluding the character tags upon import since my FM source is pretty clean; but there’s always a chance that I may have left some tagging to spill over onto other content – excluding it doesn’t take too long since there’s only a few tags in play.

                       

                      Maybe we’ll run into each other at an STC-Toronto event this year.

                      • 8. Re: Context-Sensitive Help IDs
                        argus08 Community Member

                        LOL, I don’t remember that! You must have caught me just as I was starting with TCS. I’ve only really used it for one client about every 6-8 months, so your experience has far surpassed mine, and now I’m looking to you as the expert!

                         

                        Laurie