| Category | Macro |
| Active Installs | 296 |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
| Minimal XWiki version supported | XWiki 8.4 |
| Sources | Issues |
The PDF Viewer Macro allows users to load and view PDF files inside a wiki page. The Viewer supports a double full screen mode: first going full screen in your browser and then going full screen on your computer if your browser supports that mode. The PDF location could be the current wiki page, another wiki page or an external URL.
Parameters
Below are described the parameters of the PDF Viewer Macro that need be used in order to define the way a PDF file is displayed in a wiki page.
| Name | Pretty name | Mandatory? | Default | Description |
|---|---|---|---|---|
| asauthor | Delegate my view right |  | 0 | If this value is true (or 1 or yes) and the viewing user has no access to the document containing the PDF file, the PDF file could still be viewed on behalf of your view right (as long as you have view right on the containing document obviously). |
| document | Document | | current document | Reference to the XWiki document to which the file is attached (e.g. xwiki:Path.To.Document). The xwiki: part can be ignored if the file is located in the current wiki). If file argument is an absolute URL, this argument is ignored. |
| file | File |  | N/A | Name or the absolute URL of the PDF file. |
| height | Height | | 1000 | The viewer height, accepts values in pixels or in percentage. |
| width | Width | | 100% | The viewer width, accepts values in pixels or in percentage. |
Using the macro from WYSIWYG editor
Edit a wiki page in WYSIWYG mode and look in the tool bar for the icon (XWiki Macro), search for PDF Viewer Macro and fill in the parameters values.
Using the macro from wiki editor (code)
PDF file attached to a wiki page
To note that when using this option to display a PDF on a wiki page, the URL for the PDF will be generated using the XWiki API which can handle different setups for the wiki (path based, domain based, alias updates, etc).
PDF file attached to a terminal wiki page
When having a PDF file attached to a terminal page, the syntax is slightly different, leaving out the "WebHome" mention.
PDF accessed from an external resource via URL
When using an absolut/explicit URL to display the PDF on a wiki page, keep in mind that you might need to update the URL if the alias of the source where the PDF is located will be changed.
Display multiple PDF files in the same page using a tab system layout
Add more PDF files, separated by comma.
Installation Steps
This paid extensions requires XWiki 8.4 or above. In order to install the extension, follow the next steps inside your XWiki instance (on cloud or on premise).
Navigate to the Extension Manager
In the Applications Panel click on "More Applications..." and then "Install new applications...". Alternatively navigate directly to the Administration and select the "Extensions" section.
Install the Extension
Search for the extension you wish to install and use the Install button to install it.
Get a License
Navigate to the "Licenses" section of the Administration, fill your details, look for the extension you just installed in the live table and click the buttons to get a trial license or to buy a license.
Install the License
If you have selected a trial license then you're good and there's nothing else to do. Your trial license is automatically installed.
However if you've selected to buy a license you'll be redirected to a page to perform the payment. At the end you need to come back to the "Licenses" administration section and click on the "Check for Updates" button. This will download and apply the license you bought.
Use the Extension
Start using the Extension! Refer to the extension's documentation to know how to use it.
Installing Paid Apps on Subwikis
If you want to install an application on the whole farm (main wiki + subwikis), you can do so directly from the main wiki’s Extension Manager, as seen below:
Extensions can also be installed only on a particular subwiki by global admins. Subwiki admins will not be able to install these extensions due to their limited rights.
Options
The price is per year and varies depending on the support level and the number of users.
| Support / Users | 10 | 25 | 50 | 100 | 250 | 500 | 1000 | 2500 | 5000 | 10000 | 20000 |
|---|---|---|---|---|---|---|---|---|---|---|---|
| Silver |
Benefits
What do you get when you purchase an XWiki extension?
1 year license
By purchasing an XWiki extension license, you'll benefit from it during one year.
Free updates
You benefit from all the extension updates during one year. You are always up to date.
Support included
If you are facing an issue, you can reach the XWiki support. Our team is always available to help.
How to Buy
To buy, install this extension from inside your XWiki instance and follow the instructions.
Release notes
v2.1
Bugs fixed:
#15 External PDFs are not displayed.
Improvements:
#10-1 Open the links inside the PDF documents in a new tab.
#10-2 Allow author of the macro to delegate its view right on the PDF document.
#16 Update PDF.js version from 2.1.266 to v2.5.207. Release notes: https://github.com/mozilla/pdf.js/releases/tag/v2.5.207
#13 Update XWiki parent version to 9.11
v2.0.3
Update the Licensing dependency to version 1.14.4.
v2.0.2
Update the Licensing dependency to version 1.14.3.
v2.0.1
Bugs fixed:
#11 Some attachments don't work as expected anymore.
v2.0
Update the PDF.js dependency from version 1.1.3 to version 2.1.266. Full list of changes on https://github.com/mozilla/pdf.js/releases.
v1.9.4
Update the Licensing dependency to version 1.13.8.
v1.9.3
Update the Licensing dependency to version 1.13.4.
v1.9.2
Update the Licensing dependency to version 1.13.3.
v1.9.1
Update the Licensing dependency to version 1.13.2.
v1.9
Improvement:
#5 Display several PDF files using a tab system layout.
v1.8.3
Update the Licensing dependency to version 1.13.
v1.8.2
Update the Licensing dependency to version 1.12.2.
v1.8.1
Update the Licensing dependency to version 1.12.1.
v1.8
Improve the message displayed when there is no valid license.
v1.7
Initial paid version.
Extension details
License
- GNU Lesser General Public License 2.1
Sources
Issues
Type
- xar
Developed by
Compatibility
- Requires XWiki 8.4 or above.
Dependencies
- com.xwiki.licensing:application-licensing-licensor-api 1.16