Change Search Scop

[catherine]

Hi, I have a question related to the searching scop.
By default, the search engin will search for topics in the generated webhelp.

I have 3 generated webhelp, one for admin guide, one for installation guide, the other one for FAQ.

I will add a div after the search box in the index.html file, the div will contain admin guide link, installation guide link, FAQ link. In this way, users can switch to their desired guide.

For the search engin, I'd like to search all the topics in admin guide, installation guide, and FAQ,
Is it possible?

[ionela]

Hello,

Unfortunately, in the current version of oXygen XML it is not possible to search through multiple publications.
We have this improvement request logged to our issue tracking tool and I've added your vote for it.

Regards,
Ionela

[catherine]

Hi, Ionela
Thanks for your response.
I am sorry for my mistake.
I have only one generated webhelp.
In the webhelp, I have admin guide, installation guide, end user guide and more.
By default, the webhelp search engine will search all the topics.
Is there any way that I can add a search filter beside the search box? This will help users to search efficiently and find the target article quickly ?
In my idea, I have :
admin topic files in "admin" folder,
end user topic files in "user" folder,
installation topic files in "installtion" folder

The next step is , how to customize the search engine to filter the topics?
- When people set the searching filter to "admin", and enter a key word to search, the search engine should search all the topics in the "admin" folder.

How can I achieve this feature?

Regards,
Catherine

[ionela]

Hi,

Thank you for all these details.

I'm sorry, but currently it is not possible to add a filter for search even if you have just one WebHelp output.
We have this improvement request too logged to our tracking tool and I have added your feedback to it.

Regards,
Ionela

[catherine]

Thanks for your support, Ionela.

Best regards,
Catherine

[catherine]

Hi, ionela
Any update for the searching scope issue?
For now, I have an index page for all my documentations (multiple webhelp outputs), I would like to add a searching box on the index page to help
users search globally.
I find that Oxygen website has a global searching engine, is there any way that I can achieve this ?
https://www.oxygenxml.com/search.html?q=SEARCH

Or, can I simply change the searching js file of a generated webhelp to change the searching scope, and help users to search all my documentations?

[ionela]

Hi,

I'm sorry, but the issue is still not resolved.
The oXygen XML website is using a different search engine.
Unfortunately, for the WebHelp Responsive output we do not have a procedure that we can offer as a workaround to replace the search engine functionality.

Regards,
Ionela

[catherine]

Ok, thanks, Ionela.
I will make a searching engine myself.

[revaljilji]

If not late to the party, we were able to create this feature by extending the search.js with one more function.

[Dan02]

@revaljilji, if you don't mind, would you be able to expand on what you implemented?

[alin]

Hello,

I wanted to follow up to announce you that the Oxygen WebHelp Responsive output generated with Oxygen Publishing Engine 26.0 now features faceted search functionality. This feature is powered by Oxygen Feedback 4.0, which can be configured as an external search engine for the WebHelp Responsive output.

To use this functionality, facets must be defined using a DITA Subject Scheme Map, which enables the categorization of DITA topics into various controlled values and subject definitions​​. Once defined, these faceted values must be associated with specific DITA topics using a DITA Classification Map.

In practice, this means when users search within the WebHelp Responsive output, they can now narrow down their search results by selecting relevant facets. This update significantly improves the user's ability to find specific topics efficiently.

For a detailed guide on configuring faceted search in your WebHelp Responsive output, please refer to our user manual: How to Configure Faceted Search in WebHelp Output

All the latest WebHelp Responsive versions of our user manuals have been generated with version 26 of Oxygen Publishing Engine. Moreover they are using Oxygen Feedback Cloud as search engine. Here are some of our user manuals where you can try the faceted search feature:
- Oxygen WebHelp Responsive
- Oxygen Feedback Cloud

Regards,
Alin