• Products
  • Documentation
  • Resources

Insert the PDF macro

The PDF macro displays the content of a PDF document on a page. First attach the document to a page, then use the macro to display the document.

Use the PDF macro

To add the PDF macro:

  1. When editing, select from the toolbar

  2. Find the macro by name and select it

  3. Configure it as needed

You can also type / on the page to bring up the same list you'd see by selecting from the toolbar. Continue typing the name of the macro to filter the list.

To edit the PDF macro:

  1. Select the macro placeholder.

  2. Select the Edit icon to open the configuration panel.

  3. Configure the parameters. Your changes are saved as you go.

  4. Resume editing the page, and the panel closes.

You can also select the centered , medium-width , and full-width icons to adjust the width of some macros. Select the trashcan iconto remove the macro.

Parameters

Parameters are options that you can set to control what and how content from the macro appears on the page. 

If the parameter name used in Confluence Cloud storage format or wikimarkup is different than the label used when inserting macros using the browser or the slash command, it will be listed below in brackets (example).

Parameter name

Required

Default

Parameter description and accepted values

name

Yes

(None.)

The file name of the PDF document to be displayed. The document must be attached to a page on your Confluence site.

page

No

The page containing the macro

The name of a Confluence page to which the PDF document is attached.


Wiki markup example

Wiki markup is only supported in the legacy editor.

Wiki markup is useful when you need to add a macro outside the editor, for example as custom content in the sidebar, header or footer of a space.

Macro name: viewpdf

Macro body: None.

1 2 3 4 {viewpdf:page=Docs|name=My document.pdf}

 

Additional Help