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 PDF is not generated by this procedure. It must be manually created or
copied beforehand.
The transformation parameters used for generating a PDF link component in the WebHelp Responsive output are:
- 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.