Common tasks
Rather than a tour, this is the list of things people do, with the route to each.
#What you can do
Task | Where | Notes |
|---|---|---|
Install it | Atlassian Marketplace, or get it as part of | No account, sign-in or API key follows. Existing re:solution PDF embed installs upgrade in place and keep working. |
Approve the app's Confluence permissions | Confluence admin > Apps > Manage apps, at in | It asks for read access to content, spaces, users and groups, plus attachment and file write so it can list, download and upload PDF attachments. |
Insert the macro on a page | Confluence editor: type / and search "PDF em | Identical whether you have the standalone app or the Suite. |
Embed a PDF from a public web address | Macro config > Types of file = Public URL > | Must be a valid https address. Fetched through Capable's proxy, capped at 2.5 MB. Signed-out readers will not see it. |
Embed a PDF already attached to the page | Macro config > Types of file = Existing Page | Lists up to 250 attachments from the current page. Readers need Confluence permission on the attachment. |
Upload a new PDF and embed it | Macro config > Types of file = New File Uplo | Attaches the file to the page you are editing (drafts included) and then switches the macro to attachment mode automatically. This is the reliable route for large or restricted files. |
Choose one page at a time or continuous scrolling | Macro config > Viewer Options | Slider adds previous/next and a page box and enables Initial Page. Scroller shows all pages and enables Height instead. |
Let readers download, pop out or view fullscreen | Macro config > Download / Popup / Fullscreen | All three are off by default and each adds one button to the toolbar. |
Make the text selectable and searchable | Macro config > Render Text Layer | Off by default. Turn it on if text looks missing or readers need to copy from the document. Not carried into a published Capable Site. |
Approve an external domain so large or restricted PDFs load dire | Capable Suite admin > Capable settings > Egr | Suite only, up to 10 domains, admin-only. Approved hosts bypass the proxy and its size cap, but only work if that host allows browsers on other domains to read the file. Attaching the PDF to |
Check what signed-out readers of a public page will see | Open the page while logged out | They see "Sign in to view this PDF" (attachment) or "PDF unavailable" (link), never the document. Plan for this on externally shared spaces. |
Publish a page containing a PDF embed to a Capable Site | Capable Sites deploy | The document is copied into the published site and rendered there. Zoom, Slider page navigation and Download carry over; pop-out, fullscreen and selectable text do not. |
#A few things worth knowing
Some tasks need an administrator. The Where column says so.
Anything relying on search needs the page to have been indexed first.
Macro names differ slightly between the standalone app and the suite.
#Related
What people actually do.
