Released: Nov 1, 2023

Updates in V4.0 Build ID: 2023110114

Funktionen

Oxygen Feedback Search Engine Enhancements

• Semantic Search - A Semantic search is a data searching technique that delivers more accurate results by understanding the real intent behind the search and providing an enhanced user experience. Oxygen XML WebHelp now supports semantic searches to help produce more relevant search results. To enable this feature, integration with the OpenAI platform is required, which involves specifying an API key.
• Faceted Search - A Faceted search enables users to narrow down their search results by applying multiple filters based on different properties or "facets" of the information they are looking for. WebHelp users can select one or more of these facets, and the search engine will only display results that match all the selected facets.
• Search or Filter Topics by Labels - A new Insert Label action is now available in Oxygen that allows users to add a special label keyword to the prologue of a topic. These labels are visible in the WebHelp Responsive output and can be helpful when searching for specific topics. By clicking on a label in the WebHelp Responsive output, you can quickly find other topics with the same label.
• Topic Breadcrumb Now Displayed in the Search Results Page - When viewing search results, the breadcrumb now displays the ancestor topics of a selected topic. This feature helps you understand the topic's context, particularly when the search results appear to show duplicates.
• Advanced Search Queries - Oxygen XML WebHelp integrates the Oxygen Feedback Search Engine, which supports an advanced query syntax that allows users to create more complex, flexible, and useful queries that generate more precise search results. Some examples of these supported advanced queries include phrase searches, regular expression searches, and proximity searches.

Comment Thread Improvements

• Reply to Entire Thread - To facilitate replying to a thread that already has existing replies, a Reply to this thread button has been included at the end of the reply list. This button makes it easier for users to respond to a specific thread.

Page Ratings Improvements

• See Number of Votes Received on Each Page - When an administrator visits a page on the website, they can now easily see the number of positive and negative votes received for that specific page. This information is displayed as a number in a badge, conveniently placed over the rating buttons. As a result, the administrator doesn't have to navigate to the Feedback administration interface to access the vote count.
• Ratings Information Displayed in Dedicated Page - When viewing information in the Page Ratings admin interface page, administrators can now easily access ratings information for documentation output pages.
  • By clicking on the name of a documentation output page, a new ratings information page will open. This page displays the number of positive and negative votes, as well as the number of feedback messages received for that specific documentation page. The content of each feedback message is also presented below the vote count.
  • Additionally, there is a star button located in the ratings area at the bottom of each output page, which allows administrators to quickly navigate to a new ratings information page.
• Notification Email Includes Links to Page Rating Information - In the page rating notification email that site admins receive for each of the rated pages, the number of feedback messages is now displayed as a link that navigates to the admin interface page. This page contains all the rating information registered for that documentation page.
• Display Option to be Contacted for More Information - When creating or editing a site configuration, you now have the option to enable a new feature called Contact by email text. This feature allows a checkbox to be displayed in the output when a user provides negative feedback. By checking this box, the user indicates that they would like to be contacted by email if additional information is needed to address their feedback. The admin also has the ability to configure the default text that is displayed for the checkbox in the output.

Component Updates

• Updated the Apache Lucene libraries to version 9.7.0.
• Updated Apache Tomcat to version 9.0.82.
• Updated the Jackson Databind library to version 2.15.1.
• Updated the spring-boot-dependencies library to version 2.7.17.
• Updated the spring-security framework to version 5.7.10.