|
Confluence administrators and space administrators can customise the PDF exports for individual spaces. Possible customisations include:
|
|
|
Please take note of the following points:
You can add your own HTML to customise the title page, page headers and page footers in the PDF output.
To customise the PDF layout:
You can adjust the appearance of the PDF pages by editing the CSS stylesheet.
To customise the PDF Stylesheet:
There are two PDF export methods (see Exporting Confluence Pages and Spaces to PDF):
To make your PDF layout customisations apply to a single page exported to PDF, either:
This section provides examples of typical customisations that you can add to your PDF stylesheet. Once you are familiar these basic customisations, you may wish to try some advanced customisations.
Modifications to page and margin sizes are made in the @page CSS rule. To make changes to this rule, implement the following type of code in the PDF stylesheet.
@page
{
/*Page specific styles (that is, customisations of properties) go here*/
}
|
The default page size is based on the locale of your Confluence server. For example, if this server is located in the US then the default paper size of your PDF export will be US Letter size (8.5 inches wide by 11 inches long). If the server is located in Australia, the default paper size will be A4 (210 mm wide by 297 mm high).
To modify the page size to A4, add a size property to the top of the rule like this:
@page
{
/*The A4 paper size is 210 mm wide by 297 mm high*/
size: 210mm 297mm;
}
|
More information about paper sizes can be found on Wikipedia.
To add a margin of 15 mm to a paper size of A4, your CSS @page rule would look like this:
@page
{
size: 210mm 297mm;
margin: 15mm;
}
|
By default, a table of contents will be generated after the title page, or at the beginning of the document if no title page is defined in the PDF layout. To make changes to the look and layout of the table of contents, define the appropriate CSS rules in the PDF stylesheet.
For details about the default CSS rules applied to the table of contents, download the default CSS rules (from the link above) and examine the specific rules with toc in their name.
To prevent the table of contents from being generated in your PDF document, add the div.toc rule to the PDF stylesheet and set its display property to none:
div.toc
{
display: none;
}
|
The leader character is used to link the name of a heading in the table of contents with its page number. The page number is usually aligned to the right-hand margin of the page. By default, the leader character is the '.' (dot) character. You can change it by customising the leader character CSS rule span.toclead:before and adding this to the PDF stylesheet.
To change the leader character to a solid line, modify the CSS rule to:
span.toclead:before
{
content: leader(solid);
}
|
To change the leader character to spaces, modify the CSS rule to:
span.toclead:before
{
content: leader(space);
}
|
(Be aware that using a space as a leader character can make the table of contents difficult to read.)
In order to break long words or words that are not separated by whitespace, add a selector to the PDF stylesheet containing the word-wrap property with a value of break-word:
div {
word-wrap: break-word;
}
|
You can use the stylesheet to customise the output of just about anything else that will influence the look and feel of the final document. This includes fonts, tables, line spacing, macros, etc. The export engine works directly from the HTML output produced by Confluence. Therefore, the first step in customising something is to find a selector for the HTML element produced by Confluence or the Confluence macro. Then add a CSS rule to the PDF stylesheet. Your customisation will appear in the PDF export.
h1, h2, and so on. Due to the hierarchical manner in which a space is exported, Confluence will modify the heading elements to generate a uniform appearance for the entire space export. This means that headings will be demoted. This will affect the application of custom PDF Stylesheets. It is possible to calculate the amount by which a heading will be demoted in order to have the correct CSS styling applied. A heading will be demoted by the value of its depth in the export tree. A page at the first level will be demoted by 1 (all <h1> elements will become <h2> elements, and so on). A page at the second level will be demoted by 2, and so on.Advanced PDF Stylesheet Customisations