You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 2 Next »

This page is part of the guide to developing technical documentation on Confluence Wiki. Confluence itself is an excellent platform for publishing online documentation. In some cases, though, you may need to produce PDF versions of your documentation for printing, or to supply to customers who cannot access the online version.

Confluence itself provides an export to PDF. Plugins provide additional functionality.

Quick guide to PDF exports

  • Customise the PDF layout (title page, header and footer) and stylesheet, for use each time you export your documentation.
  • Export a single page to PDF.
  • Export an entire space or a selection of pages to PDF.
  • Consider installing a third-party plugin for advanced functionality.

The rest of this page gives more details of the above procedures.

On this page:

Customising the PDF Layout and Stylesheet

If you are planning to provide PDF versions of your documentation, you may want to customise the PDF layout and styles for your space. These customisations will apply each time you export your documentation to PDF.

In the PDF layout, you can add your own HTML to customise the title page, page headers and page footers in the PDF output. In the PDF stylesheet, you can adjust the appearance of the PDF pages.

Editing the PDF Layout

Unable to render {include} The included page could not be found.

Editing the PDF Stylesheet

Unable to render {include} The included page could not be found.

Some Useful Examples

Below are the typical customisations you may want to make for your technical documentation. For more examples, see Customising Exports to PDF.

Adding a Title Page

Unable to render {include} The included page could not be found.

Adding Headers and Footers

Unable to render {include} The included page could not be found.

Adding Page Numbering to a Header or Footer

Unable to render {include} The included page could not be found.

Exporting a Single Page to PDF

Unable to render {include} The included page could not be found.

Exporting a Space or a Selection of Pages to PDF

Using the built-in Confluence PDF export, you can export a single page, a selection of pages or an entire space into a single PDF file.

Unable to render {include} The included page could not be found.



Exporting a Spaces or Pages to PDF via a Plugin

For advanced PDF export, consider installing the Scroll Wiki Exporter plugin onto your Confluence site. Scroll provides flexible themes for configuring PDF layout and styles. You can select one of Scroll's built-in themes and configure your table of contents, header and title pages.

Advanced techniques for Scroll Wiki Exporter. For even more flexibility, you can add your own theme plugins. Scroll supports themes based on DocBook XSL stylesheets. See the Scroll developer's guide.

Notes

  • Permissions required to export a space.
    Unable to render {include} The included page could not be found.
  • Installing plugins. If you decide to use additional plugins, your site administrator will need to install the plugins into your Confluence site. Refer to the Universal Plugin Manager Documentation.
  • Plugin support. Before installing an add-on (also called a plugin) into your Confluence site, please check the add-on's information page to see whether it is supported by Atlassian, by another vendor, or not at all. See our guidelines on add-on support.
Next Steps

Now you know all about providing PDF versions of your documentation. What next? See other ways of Exporting and Printing Technical Documentation.

  • No labels

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.