Add Title description

Post by **catherine** » Wed Dec 13, 2017 10:52 am

Hi, oxygen experts,
How to add a short description of the webhelp title?
Just like the Oxygen webhelp shows: https://www.oxygenxml.com/doc/versions/19.1/ug-editor/

Title: Introduction
Description: Welcome to the User Manual of Oxygen XML Editor 19.1

When I generate a webhelp, I can only get a title, how to add a short description for my titles?

Plus, how to add logo and title above the search box just like the Oxygen webhelp shows?

Will appreciate for your any suggestion, thanks!

Post by **thedantanner** » Thu Dec 14, 2017 1:02 am

I belive you can accomplish this by adding the element: shortdesc after your title.

<title>The Title</title>
<shortdesc>A short description of the title.</shortdesc>

-d

Post by **bogdan_cercelaru** » Thu Dec 14, 2017 3:53 pm

Hello,

catherine wrote:When I generate a webhelp, I can only get a title, how to add a short description for my titles?

The short description displayed in tiles is gathered from the <shortdesc/> element found in DITA topics.
You can overwrite this short description using the topicmeta/shortdesc element of the <topicref/> element found in the DITA map file.

catherine wrote:Plus, how to add logo and title above the search box just like the Oxygen webhelp shows?

To add an HTML fragment before main page search, you could use the "webhelp.fragment.before.main.page.search" parameter from the transformation scenario to point to a well-formed XML fragment that contains your custom HTML.
The XML file content could be as follow:

Code: Select all

<div id="ug-main-page-search"> <img src="URL_TO_IMG" height="50" width="50" /> Custom text here</div>

More information could be found here:
- WebHelp plugin additional parameters
- How to refer resources in the XML file
- How to copy additional resources to WebHelp output

Regards,
Bogdan