Skip to main content
Inspiring
March 8, 2023
Question

Index keywords rh-index-keywords vs MS-HKWD

  • March 8, 2023
  • 2 replies
  • 357 views

Somewhere between RH10 and RH2020, index keywords are stored differently in the <head>:

RH10: <meta name="MS-HKWD" content="keyword1" />

RH2020:  <meta name="rh-index-keywords" content="keyword1, keyword2, ..." />

 

I did not notice this until now because I had an issue with a style. The <head> contained both versions of the keyword-definitions. By removing the RH10-version keywords, the style issue is solved. Strange.

 

I have some questions:

  • Is it save to remove all RH10-version keywords or are they required for something? (e.g. for a particular type of output)
  • Or is it save to leave the RH10-version keywords in the topics, and only to remove them in case of a style issue?
  • Why haven't they been removed by upgrading the project, or did I miss something?

 

    This topic has been closed for replies.

    2 replies

    Community Expert
    March 9, 2023

    In RH Classic, there was an option in Project Settings to add keywords to the topic rather than the index (hhk) file. If you selected this option, the index keywords were added to the topic in the format you describe. This format I believe is a holdover from when Microsoft invented CHM files.

     

    New UI has done away with a central index file for whatever reason, so keywords are now added into the topic directly using the new format you describe.

     

    I think most people used the index file rather than the topic method, so it's possible that Adobe missed this option when they were writing the upgrade scripts, and when they were writing the New UI interface.

    D.DesmetAuthor
    Inspiring
    March 9, 2023

    I also think that Adobe forgot to remove the old in-topic keyword data when upgrading. As a result, there is superfluous code in the topic's head section.
    This code could be removed easily if the find&replace could handle wildcards, e.g. replace <meta name="MS-HKWD" content="*" /> by nothing. The * represents any text.
    Or maybe I could post a feature request to clean up old in-topic keywords via a next upgrade.
    I will only remove them manually if there they cause other problems like the one I had.

    Jeff_Coatsworth
    Community Expert
    Community Expert
    March 8, 2023

    I just did a RH10 test of adding a keyword to a topic and generated WebHelp. Looking at the HTML, I get this - <meta name="search-keywords" content="keyword1" /> . Not sure where your meta tag is coming from, but it could be that your source is from Word (at some point).

    If I look at the source view of the RH topic I added it to, the same meta tag is present. Maybe you need to do a find & replace on all instances in a copy of the RH10 project & then see how upgrading handles it.

    D.DesmetAuthor
    Inspiring
    March 9, 2023

    I tested with a new project in RH10. First I have set 'add new keywords to topics'. Then I added a keyword. The result is:
    <meta name="MS-HKWD" content="test" />
    So it does not come from Word.
    And when I upgrade it to RH2022, that code remains in the topic and the next code is added:
    <meta name="rh-index-keywords" content="test" />