Heretto Portal PDF Handling
You can publish PDF files to Heretto Portal by adding them to a map or referencing them in a topic. PDFs publish as downloadable resources that open in a new tab in the browser.
Publishing PDF files to portal is especially useful to:
Provide a PDF version of a document for your audience to download and use offline.
Provide additional, third-party resources to your audience.
PDF files can be:
Added to maps with the
topicref
element that contains theformat="pdf"
attribute. For example:<map> <title>(...)</title> <topicref format="pdf" href="pdf_file.pdf"></topicref> </map>
Referenced in topics with the
xref
element that contains theformat="pdf"
attribute. For example:<topic> <title>(...)</title> <body> <p>To download a PDF version of this document, go to <xref format="pdf" href="pdf-file.pdf"/>.</p> </body> </topic>
Important Considerations
PDF handling supports publishing PDFs hosted only in Heretto CCMS.
PDF handling is supported in maps, bookmaps, and sitemaps, as well as in any topic type.
PDF files published to portal are not indexed or returned in search results.
By default, the PDF file name is used as the navigation menu text or the link text. Custom text can be specified in the
navtitle
element for maps and in thetopicref
element in topics.When using the Next and Previous buttons in portal to navigate between pages, PDF files are skipped.
PDF files added to a map as the first element in a
sitesection
ortopichead
element do not consistently open the PDF in a new browser tab. This is a known limitation. We do not recommend using this structure.An example of this structure in a sitemap:
<sitemap> <title>Sitemap</title> <sitesection> <topicref format="pdf" href="pdf_file.pdf"></topicref> <topicref href="dita_file.dita"></topicref> </sitesection> </sitemap>
Add a PDF File to a Map
You can add a PDF file to a map, sitemap, or bookmap and publish it to Heretto Portal.
Upload a PDF file to Heretto CCMS
Add the PDF file to a map, sitemap, or bookmap
Once the map is published to portal, the PDF file becomes visible in the portal navigation menu. When a user clicks the navigation menu item associated with the PDF, the PDF file opens in a new tab.
Add a PDF File to a Topic
You can reference a PDF file with the cross-reference (xref
) element in any topic type.
Upload a PDF file to Heretto CCMS
Add the PDF file to a topic
In portal output, clicking the link opens the PDF file in a new tab.