Page 1 of 1

Do not create the indexTerms.html file when webhelp.show.indexterms.link==no

Posted: Wed Dec 07, 2022 7:35 pm
by chrispitude
Currently, WebHelp always creates the indexTerms.html file, even if the webhelp.show.indexterms.link parameter is set to no.

In our situation, we have legacy <indexterm> elements in our content that we do not actively update. We set webhelp.show.indexterms.link==no to avoid publishing them. Unfortunately, the indexTerms.html file was still created and indexed by our corporate web portal's search engine, and so it still shows up in the search results for many customer queries (because it contains so many common terms by definition).

It would be useful if the WebHelp build could suppress the indexTerms.html file completely when webhelp.show.indexterms.link==no, as there is no way to navigate to it once the header link is removed.

We could delete the legacy <indexterm> elements from our content, but even then the indexTerms.html file is created with no entries, and so it would still be nice to suppress this useless file when webhelp.show.indexterms.link==no.

A testcase is included:

webhelp_index_topic_file.zip
(1.93 KiB) Downloaded 146 times

To run,

1. Publish the project.xml DITA-OT project file.

Re: Do not create the indexTerms.html file when webhelp.show.indexterms.link==no

Posted: Thu Dec 08, 2022 12:53 pm
by julien_lacour
Hi Chris,

I added your vote to the issue, as a workaround you can create an additional plugin that overrides the 'whr-create-indexterms-page' Ant target.
I already did such plugin, you can use it as a starting point:
com.oxygenxml.webhelp.responsive.custom.zip
(936 Bytes) Downloaded 147 times
If you want the indexterm page on some of your publications you will need to add a condition using the 'webhelp.show.indexterms.link' parameter.

Regards,
Julien

Re: Do not create the indexTerms.html file when webhelp.show.indexterms.link==no

Posted: Thu Dec 08, 2022 6:07 pm
by chrispitude
Perfect, thank you Julien!

Re: Do not create the indexTerms.html file when webhelp.show.indexterms.link==no

Posted: Mon Mar 27, 2023 2:46 pm
by cosmin_andrei
Hello,
I just wanted to let you know that this issue is fixed now, and the fix is available in the latest version of Oxygen, version 25.1 which we released last week.
https://www.oxygenxml.com/download.html
Please let us know if you encounter further problems with this new version.

Re: Do not create the indexTerms.html file when webhelp.show.indexterms.link==no

Posted: Tue Mar 28, 2023 1:46 pm
by chrispitude
Hi Cosmin,

Thank you! I have confirmed the fix. I will gladly share with my team that we will no longer have these index page matches in our customer search portal results. :)

- Chris