How to create a page break function in Confluence to control pagination in PDF exports

Still need help?

The Atlassian Community is here for you.

Ask the community

This Knowledge Base article was written specifically for the Atlassian Server platform and may be self applied.

If you are an Atlassian Cloud customer this procedure cannot be performed due to application customization, which includes the creation of User Macros being unsupported: Functional differences in Confluence Cloud

Currently, Confluence does not have a Page Break function to control pagination in PDF exports.

An improvement request for this matter has been made:  CONF-28115 - Getting issue details... STATUS  

Feel free to vote for it if you would like to see the request implemented in the future.

In the meantime, Confluence users with System Administrator permissions are able to create a custom user macro for the same purpose. 

This article falls under the category of User Customization and is not supported by Atlassian.

Create A Custom User Macro:

  1. Go to "Configuration >> User Macros" in Confluence Administration
  2. Click "Create a User Macro"
  3. Enter the Macro Title field with a title that you will call this macro with
  4. Fill the rest of the field as per described below. In this example, the macro will be named "pagebreak"

    Field
    Value
    Macro namepagebreak
    VisibilityVisible to all users in the Macro Browser
    Macro Titlepagebreak
    DescriptionGives page break upon PDF export
    CategoriesConfluence Content
    Icon URLYou can leave this field blank
    Documentation URLYou can leave this field blank
    Macro body processingNo macro body
    Template

    Enter the code below in the template field.


    ## @noparams
    <div style="page-break-before:always;"> </div>

  5. Click "Save" 

For more information about creating your own user macros, go to the following documentation:


Calling the new pagebreak macro on the page:

Now you can add the macro to your Confluence page by typing the macro name inside curly brackets. 

For example, if you have titled your macro as 'pagebreak', typing the following will automatically call the macro.

{pagebreak}

The macro should appear as so:

Upon exporting to PDF, page breaks will appear in the exported PDF where the macro is placed


Last modified on Apr 24, 2022

Was this helpful?

Yes
No
Provide feedback about this article
Powered by Confluence and Scroll Viewport.