Edit online

How to Add a Link to PDF Documentation

It is possible to add a component in your WebHelp output that links to an external PDF resource. For example, it could link to the PDF equivalent of the documentation. This is achieved by configuring some transformation parameters and the link component is added in the header/breadcrumb stripe, next to the navigation links.
Important:
The external PDF must already be created beforehand. This procedure does not generate the PDF, just the component that links to a specified PDF resource.

Add a Link to a PDF Using a Publishing Template

To embed a component that links to an external PDF resource in the DITA Map WebHelp Responsive output using an Oxygen Publishing Template, follow this procedure:
  1. If you have not already created a Publishing Template, see Working with Publishing Templates.
  2. Open the template descriptor file associated with your publishing template and add the following parameters:
    webhelp.pdf.link.url
    Specifies the target URL for the PDF link component.
    webhelp.pdf.link.text
    Specifies the text for the PDF link component.
    webhelp.pdf.link.icon.path
    Specifies the path or URL of the image icon to be used for the PDF link component. If not specified, a default icon is used.
    webhelp.show.pdf.link
    Specifies whether or not the PDF link component is shown in the WebHelp Responsive output. Allowed values are: yes (default) and no.
    webhelp.pdf.link.named.destination.enabled
    Specifies whether or not the current topic ID should be appended as named destination at the end of the PDF link. Allowed values are: yes (default) and no.
  3. Open the DITA Map WebHelp Responsive transformation scenario.
  4. Click the Choose Custom Publishing Template link and select your template.
  5. Click OK to save the changes to the transformation scenario.
  6. Run the transformation scenario.

Result: In the WebHelp output, the link component is added in the header/breadcrumb stripe, next to the navigation links.

Add a Link to a PDF by Directly Setting Parameters in a Transformation Scenario

To embed a component that links to an external PDF resource in the DITA Map WebHelp Responsive output using a transformation scenario from within Oxygen XML Editor/Author, follow this procedure:
  1. Edit a DITA Map WebHelp Responsive transformation scenario and open the Parameters tab.
  2. Set values for the following parameters:
    webhelp.pdf.link.url
    Specifies the target URL for the PDF link component.
    webhelp.pdf.link.text
    Specifies the text for the PDF link component.
    webhelp.pdf.link.icon.path
    Specifies the path or URL of the image icon to be used for the PDF link component. If not specified, a default icon is used.
    webhelp.show.pdf.link
    Specifies whether or not the PDF link component is shown in the WebHelp Responsive output. Allowed values are: yes (default) and no.
    webhelp.pdf.link.named.destination.enabled
    Specifies whether or not the current topic ID should be appended as named destination at the end of the PDF link. Allowed values are: yes (default) and no.
  3. Run the transformation scenario.

Result: In the WebHelp output, the link component is added in the header/breadcrumb stripe, next to the navigation links.