What's New in Oxygen XML Webhelp 25.0
October 13, 2022
Oxygen XML WebHelp version 25.0 is the latest major release for the modern XML publishing system that is used to produce stylish WebHelp output from DITA or DocBook source content. Some of the most interesting enhancements added in this version include the ability to generate Google Structured Data in the output and to control the search support. New transformation parameters were added to specify a custom search engine, to change the default search engine, or to replace the main page with your own custom page. Customization possibilities were added for displaying a custom title in the search results page or for implementing your own custom search filter.
Core
Generate Google Structured Data
You can now generate Google Structured Data in DITA WebHelp Responsive output.
Google uses structured data to better understand the contents of the page and display
special search results in a Google Search. For details about how to do this, see How to Generate Google Structured Data.
Display Custom Title in Search Results
It is possible to display a custom title for topics in the search results page.
This can be achieved by adding the
<searchtitle> element inside the
particular DITA topic (or inside the topic reference within a DITA map). The
<searchtitle> element is used to specify the title that is
displayed by the search tools that locate the topic. For more details, see How to Display Custom Title in Search Results.Scaling in Image Maps Improved
Scaling when working with image maps was improved. Adding the
@scale attribute on the <imagemap> element now
scales both the image and its areas, if defined.Replace Main Page With Your Own Custom Page
A new transformation parameter
(
webhelp.skip.main.page.generation) can have its value set to
true to instruct the transformation engine to skip the default main
page generation. This is helpful if you want to replace the default main page with a topic
page or any other custom page.Search Engine
Implement Your Own Custom Search Filter
It is possible to implement a custom search filter by referencing a custom
JavaScript file in an Oxygen Publishing Template. For details on how to
do this, see How to Implement a Custom Search Filter.
Search Expressions are Preserved in Search Filter
The search expressions that you type in the search filter field are now
preserved after you click on a search result. This makes it more efficient to refine
searches since you can edit or add text to the preserved search expression instead of
starting over.
Use a Custom Search Engine
A new transformation parameter
(
webhelp.fragment.custom.search.engine.script) can be used to specify
the path to an XHTML file that contains scripts required for a custom search engine that
would replace WebHelp's built-in search engine. For more details, see How to Configure a Custom Search Engine.Change Default Operator for the Search Engine
A new transformation parameter
(
webhelp.search.default.operator) makes it possible to change the
default operator for the search engine. If the value is set to and,
multiple word queries result in the search engine only returning results for topics that
contain ALL words. If the value is set to or (default value), multiple
word queries result in the search engine returning results for topics that contain ANY of
the words.Component Updates
Bootstrap 4.6.2
The third-party Bootstrap library was updated to version
4.6.2.
jQuery 3.6.0
The third-party jQuery library was updated to version 3.6.0.
Removed RequireJS Library
Removed the third-party RequireJS library to help prevent
security issues.