This page is part of the guide on Developing Technical Documentation on Confluence Wiki.

Confluence is a platform for publishing online documentation. It also provides an export to PDF feature for producing PDF versions of your documentation, allowing you to print it, or to provide a copy to customers who are unable to access the online version. This guide describes how to export your technical documentation to PDF using Confluence's built-in PDF export, and introduces a third-party plugin that provides additional PDF layout and style functionality.

Quick guide to PDF exports

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

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

On this page:

Customising the PDF Layout and Style

If you plan to create PDF versions of your documentation, you may want to customise the PDF layout and styles for your space. These customisations will be applied every time you export documentation to PDF.

Under PDF layout you can add HTML to customise the PDF title page, and page headers and footers. Under 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. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、

Editing the PDF Stylesheet

[Unable to render {include} The included page could not be found. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、

Examples of PDF Customisation

Below are 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. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、

Adding Headers and Footers

[Unable to render {include} The included page could not be found. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、

Adding Page Numbering to a Header or Footer

[Unable to render {include} The included page could not be found. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、

Exporting to PDF

You can use the built-in Confluence PDF export to export a single page, a selection of pages or an entire space to a single PDF file.

Exporting a Single Page to PDF

[Unable to render {include} The included page could not be found. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、

Exporting a Selection of Pages or a Space to PDF

[Unable to render {include} The included page could not be found. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、



Using the Scroll PDF Exporter Plugin to Export to PDF (Not applicable to Confluence OnDemand.)

The Scroll PDF Exporter provides flexible themes for configuring PDF layout and styles. You can select one of Scroll PDF Exporter's built-in themes and configure your table of contents, header and title pages. For even more flexibility, see the section HowTos in the Scroll PDF Exporter documentation.

For this advanced PDF export functionality, you will need to install the Scroll PDF Exporter plugin to your Confluence site. 

注意

  • Permissions required to export a space: 
    [Unable to render {include} The included page could not be found. ({include} をレンダリングできません。ページが見つかりませんでした)] を選択し、
  • Installing plugins: If you decide to use additional plugins, your site administrator will need to install the plugins to your Confluence site. Refer to the documentation on installing plugins. (Not applicable to Confluence OnDemand.)
  • 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.

関連トピック

Developing Technical Documentation on Confluence Wiki
Customising Exports to PDF
Exporting Confluence Pages and Spaces to PDF
Scroll PDF Exporter 
Installing Add-ons (Not applicable to Confluence OnDemand.)

次のステップ

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

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