3 Replies Latest reply on Nov 24, 2010 11:49 PM by NL_Derek-56V59O

    Verify Index Entries

    NL_Derek-56V59O

      Using Windows XP and RH 8.0.2.208 to generate CHMs.

       

      We are updating a RoboHelp project created by someone who has left the company. It appears that he created index entries (in the project index file) based on words in the topic, and subsequently edited the topic -- in some cases removing the keyword.

       

      As a result, the poor user follows an index entry and finds no mention of it in the topic. Note that we are not using categories or synonyms (like "Format" as an index entry for a topic about fonts). Our index is simply a better-focused search tool.

       

      Is there a way of verifying that the index entry is actually included in the topic?

       

      --- Derek

        • 1. Re: Verify Index Entries
          Peter Grainge Adobe Community Professional (Moderator)

          No because the index keyword does not have to be in the topic.

           

          The previous author may not have edited them out. It may be that they decided the topic was relevant to the index keyword even though it was not in the topic.

           


          See www.grainge.org for RoboHelp and Authoring tips

           

          @petergrainge

          • 2. Re: Verify Index Entries
            Captiv8r Adobe Community Professional & MVP

            Hi there

             

            (Dressing myself with my Indexing Vicar collar here)

             

            To amplify what Peter said, this is really the beauty of an index. The ability to provide keywords that represent concepts and not actual words. For example, perhaps you have a topic that describes a Sofa. Inside the topic proper, all the terminology used is simply "sofa". But some folks may call it a Couch. Some folks may call it a Divan. Some folks may call it a Love Seat. Others may call it a Sectional or Settee. So to effectively lead the user to the Sofa topic, you thoughtfully include all these terms and link them to the topic.

             

            Another thing to note with regards to the index is that some folks have the expectation that clicking an index keyword will not only open the topic, but will also highlight the word inside the topic they view. That has never been a function of the index. It is a function of Search.

             

            Cheers... Rick

             

             

            Helpful and Handy Links

            RoboHelp Wish Form/Bug Reporting Form

            Begin learning RoboHelp HTML 7 or 8 moments from now - $24.95!

            Adobe Certified RoboHelp HTML Training

            SorcererStone Blog

            RoboHelp eBooks

            • 3. Re: Verify Index Entries
              NL_Derek-56V59O Level 1

              Thanks Peter and Rick,

               

              You really don't need to tell me about the beauty of an index; for years now I have been sweating to make good indexes (indices?)

               

              But my dear departed colleague (irony) has left us with an inconsistent index and we want to find a way of cleaning it with a minimum of effort.

               

              He created the index with RoboHelp's index wizard; as you know that lists topics containing the keywords and the author only has to decide whether the mention is merely incidental or justifies an index entry. In many cases he was too lenient and this results in an index which is really no better than a search.On top of that he edited and in some cases split topics AFTER indexing.

               

              What we would like is a tool which leads us to topics where the index entry is NOT in the topic; then we can check these individually.

               

              --- Derek