PDF embed
The PDF embed (Capable) macro shows a PDF in a viewer on the page, so readers can page through it, zoom and, if you allow it, download it or open it bigger. Insert it by typing /PDF in the editor. The settings below are in Configure PDF embed; the display options appear once the macro has a PDF.
#Settings
Setting | Values | Default | What it changes |
|---|---|---|---|
Types of file | Public URL, Existing Page Attachment, New File Upload | Public URL | Where the PDF comes from. Switching clears the previous source. See Three ways to supply a PDF. |
PDF URL | A direct https link to a .pdf file | empty | Public URL only. Fetched through Capable's proxy, up to 2.5 MB. |
Attached File | The page's PDF attachments | none selected | Existing Page Attachment only. Read with each reader's Confluence permissions. |
Upload a PDF | A PDF from your computer | none | New File Upload only, while editing. Attaches the file to the page, then switches to Existing Page Attachment. |
Viewer Options | Slider, Scroller | Slider | Slider shows one page with Previous page, Next page and a page box. Scroller shows all pages one under another. See Slider and Scroller layouts. |
Initial Page | 1 to the number of pages | 1 | Slider only. The page the viewer opens on. |
Height | 1 to the number of pages | 1 | Scroller only. How many pages show before the viewer scrolls. The list fills in once the preview has counted the pages. |
Download | on, off | off | Adds a Download button to the toolbar. |
Popup | on, off | off | Adds Open in popup, which opens the PDF in a larger window over the page. |
Fullscreen | on, off | off | Adds a Fullscreen button. |
Render Text Layer | on, off | off | Lays the PDF's text over each page so it can be selected and copied. Also helps when some text does not show. |
Types of render | Default, Canvas | Default | How pages are drawn. Try Canvas if a document renders badly. Older macros set to SVG are treated as Canvas. |
#The viewer toolbar
Button | When it shows |
|---|---|
Zoom out, Zoom in | Always. Zoom runs from 20% to 200%, and pinch works on touch screens. |
Previous page, page box, Next page | Slider layout. |
Download, Open in popup, Fullscreen | When the matching setting is on. |
#Messages the macro can show
Message | What happened |
|---|---|
PDF not configured | No PDF has been chosen yet. |
Sign in to view this PDF / PDF unavailable | The reader is not signed in to Confluence. |
This PDF could not be loaded, This PDF could not be found, This PDF is too large, This file does not look like a PDF, This PDF is password protected | The file could not be read. Each message says what to do. See Plain-English load errors. |
You cannot view this PDF | The reader has no permission to view the attachment. |
#A few things that catch people out
Pasting a PDF link into the editor does not create the macro. Insert the macro first.
Signed-out readers never see the document, even on a public page.
Exporting the page to PDF or Word leaves a gap where the embed was.
Changing Types of file clears the PDF you had chosen.
#Related
One macro, documented properly.
