• 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 item to be inserted and select it

  3. Select Insert

You can also type / on the page to bring up the same list you'd see by selecting from the toolbar.

To edit the PDF macro:

  1. Select the macro placeholder. The floating toolbar appears.

  2. Select Edit. The right panel opens.

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

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

Parameters

Parameters are options that you can set to control the content or format of the macro output. 

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