Skip to Content
Last modified by Yana Oksner on 2025/07/18 12:19
From version 2.1
edited by Yana Oksner
on 2023/11/13 12:07
Change comment: Install extension [com.xwiki.pro:xwiki-pro-macros/1.12]
To version 5.1
edited by Yana Oksner
on 2025/04/30 10:28
Change comment: Migrated property [featureMandatory] from class [XWiki.WikiMacroParameterClass]

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -PDF Macro
1 +Legacy Confluence Bridge for PDF
Content
... ... @@ -1,3 +1,5 @@
1 +This is a legacy, unprefixed Confluence bridge for the ViewPDF macro. Please use view-file or pdfviewer instead.
2 +
1 1  {{code}}
2 2  {{viewpdf att--filename="PDFExample.pdf"/}}
3 3  {{/code}}
XWiki.WikiMacroClass[0]
Macro code
... ... @@ -1,13 +1,26 @@
1 -{{velocity}}
2 -#set ($hasPDFViewer = $xwiki.exists('XWiki.PDFViewerMacro'))
3 -#set ($unescapedFilename = $xcontext.macro.params.get('att--filename'))
4 -#if (!$unescapedFilename)
5 - #set ($unescapedFilename = $xcontext.macro.params.get('name'))
1 +{{velocity output="false"}}
2 +#macro (executeMacro)
3 + #set ($hasPDFViewer = $xwiki.exists('XWiki.PDFViewerMacro'))
4 + #set ($unescapedFilename = $xcontext.macro.params.get('att--filename'))
5 + #if (!$unescapedFilename)
6 + #set ($unescapedFilename = $xcontext.macro.params.get('name'))
7 + #end
8 + #set($escapedFilename = $services.rendering.escape($unescapedFilename, $xwiki.currentContentSyntaxId))
9 + #if ($hasPDFViewer)
10 + {{pdfviewer file="$escapedFilename" /}}
11 + #else
12 + {{office reference="$escapedFilename" /}}
13 + #end
6 6  #end
7 -#set($escapedFilename = $services.rendering.escape($unescapedFilename, $xwiki.currentContentSyntaxId))
8 -#if ($hasPDFViewer)
9 - {{pdfviewer file="$escapedFilename" /}}
15 +{{/velocity}}
16 +
17 +{{velocity}}
18 +## We need to check if there is a valid license because the macro is registered even if the user doesn't have view right
19 +## on the macro definition page. See XWIKI-14828: Rendering macros defined in wiki pages are available to users that
20 +## don't have view right on those pages.
21 +#if ($services.promacrolicensing.hasLicensureForEntity($xcontext.macro.doc.documentReference))
22 + #executeMacro
10 10  #else
11 - {{office reference="$escapedFilename" /}}
24 + {{missingLicenseMessage extensionName="proMacros.extension.name"/}}
12 12  #end
13 13  {{/velocity}}
Default categories
... ... @@ -1,0 +1,1 @@
1 +Deprecated
Macro description
... ... @@ -1,1 +1,1 @@
1 -View Pdf documents.
1 +Legacy Confluence bridge for View PDF.
Macro name
... ... @@ -1,1 +1,1 @@
1 -View Pdf
1 +Legacy Confluence bridge for View PDF
XWiki.WikiMacroParameterClass[0]
Parameter mandatory
... ... @@ -1,0 +1,1 @@
1 +Yes