How to Add a Welcome Message in the WebHelp Responsive Main Page

The main page of the WebHelp Responsive output contains a set of empty placeholders that can be used to display customized text fragments. These placeholders are available to you through WebHelp Responsive transformation scenario parameters. For example, the placeholder identified through the webhelp.fragment.welcome parameter displays text content above the search box in the main page.

Using a Publishing Template

To add a customized welcome message in the main page of the WebHelp Responsive output using an Oxygen Publishing Template, follow this procedure:

If you have not already created a Publishing Template, see How to Create a Publishing Template.

Open the template descriptor file associated with your publishing template and add the webhelp.fragment.welcome parameter in the parameters section with its value set to one of the following:

A small well-formed XHTML fragment (such as: <i>Welcome to the User Guide</i>).
A path to a file that contains well-formed XHTML content.

<publishing-template>
    ...
    <webhelp>
        ...                
        <parameters>
            <parameter name="webhelp.fragment.welcome"
                value="path/to/welcome.xhtml" type="filePath"/>
        </parameters>
    </webhelp>

Open the DITA Map WebHelp Responsive transformation scenario.
Click the Choose Custom Publishing Template link and select your template.
Click OK to save the changes to the transformation scenario.
Run the transformation scenario.

Result: In the WebHelp output, your custom message will be displayed above the search box in the main page.

Using a Transformation Scenario in Oxygen XML Editor/Author

Important: Running WebHelp transformations from a script outside of Oxygen XML Editor/Author requires an additional license and some additional setup:

You must have a valid license for the Oxygen XML WebHelp Plugin (https://www.oxygenxml.com/buy_webhelp.html).
The Oxygen XML WebHelp Plugin must be installed and integrated.

To add a customized welcome message in the main page of the WebHelp Responsive output using a transformation scenario from within Oxygen XML Editor/Author, follow this procedure:

Edit the DITA Map WebHelp Responsive transformation scenario and choose a template.
Open the Parameters tab and set the webhelp.fragment.welcome parameter with its value set to one of the following:
- A small well-formed XHTML fragment (such as: <i>Welcome to the User Guide</i>).
- A path to a file that contains well-formed XHTML content.
Click OK to save the changes to the transformation scenario.
Run the transformation scenario.

Result: In the WebHelp output, your custom message will be displayed above the search box in the main page.