WebHelp Search Results Improvement

Are you missing a feature? Request its implementation here.
felixliu
Posts: 26
Joined: Thu Jun 09, 2022 11:04 am

WebHelp Search Results Improvement

Post by felixliu »

Hi, we are using Oxygen XML Author to generate WebHelp Responsive output.
When searching some content on the website, it seems that all the search results only show content in the first paragraph of a document. This could be confusing if the searched word is actually in the later part of the document body instead of the first paragraph, which makes one think that the search result is inaccurate.
( please see this example: https://tak6gihsud0.feishu.cn/docx/B65H ... lAcUODonWm Password: h63413&5 )
So, is there any way to achieve the following:
1. Can the search results display the content of the document where the keyword appears?
2. When clicking on a search result, can the webpage automatically scroll to the location of the keyword within the document?
Thanks in advance.
marius
Posts: 52
Joined: Thu Mar 05, 2009 11:44 am

Re: WebHelp Search Results Improvement

Post by marius »

Hello,

Currently, on the search results page, the text shown includes the short description of the topic. However, there is a feature request in our issue tracker to display content from the current topic that matches the search query. I have added your vote to this request.

Regarding your request about scrolling to the search term, you can achieve this behavior by setting the transformation parameter webhelp.enable.scroll.to.search.term to yes.

Best regards,
Marius
Marius Ciolacu
Syncro Soft / Oxygen XML
felixliu
Posts: 26
Joined: Thu Jun 09, 2022 11:04 am

Re: WebHelp Search Results Improvement

Post by felixliu »

marius wrote: Mon Apr 14, 2025 11:25 am Hello,

Currently, on the search results page, the text shown includes the short description of the topic. However, there is a feature request in our issue tracker to display content from the current topic that matches the search query. I have added your vote to this request.

Regarding your request about scrolling to the search term, you can achieve this behavior by setting the transformation parameter webhelp.enable.scroll.to.search.term to yes.

Best regards,
Marius
Thanks for your help. I have two follow-up questions.
1. Is there any customization method to achieve displaying the content where the search keyword appears?
2. Besides, our website is in Chinese. The current default search function has low accuracy for searching Chinese content. Is there any customization method to optimize the search accuracy for Chinese content?
marius
Posts: 52
Joined: Thu Mar 05, 2009 11:44 am

Re: WebHelp Search Results Improvement

Post by marius »

Hello,
1. Is there any customization method to achieve displaying the content where the search keyword appears?
For the WebHelp built-in search engine, there are only a few things that can be customized, but none of them can help you achieve this behavior.
There is also the option to integrate a custom search engine.
2. Besides, our website is in Chinese. The current default search function has low accuracy for searching Chinese content. Is there any customization method to optimize the search accuracy for Chinese content?
The Oxygen Feedback search engine might work better in this situation. Even though it requires a separate license, you can take advantage of a 30-day trial to test it out.

Regards,
Marius
Marius Ciolacu
Syncro Soft / Oxygen XML
Post Reply