Wiki source code of Configure the PDF Export for XWiki Pages
Last modified by Eleni Cojocariu on 2026/08/26 17:33
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | To [[export>>documentation.xs.admin.exports.WebHome]] content in PDF format: | ||
| 2 | |||
| 3 | 1. [[Administer your wiki>>xwiki:documentation.xs.admin.base.content-organization.administer-wiki.WebHome]]. | ||
| 4 | 1. Select "Content", and then select "PDF Export" from the dropdown.((( | ||
| 5 | {{image reference="pdf-export-item.png" size="medium" alt="Content settings dropdown from the Administration user interface"/}} | ||
| 6 | ))) | ||
| 7 | 1. Check the state of the [[PDF Generator>>||anchor="HWhatisaPDFgenerator3F"]]. Depending on the Generator configured, the state can be "Available" or "Currently unavailable".((( | ||
| 8 | {{image reference="status-pdf-export.png" size="large" alt="The state of the PDF generator, displayed next to the Generator setting"/}} | ||
| 9 | ))) | ||
| 10 | 1. Select and configure the settings of the PDF export:((( | ||
| 11 | {{image reference="configuration-pdf-export.png" size="large" alt="The settings of the PDF Export administration section"/}} | ||
| 12 | |||
| 13 | * "Templates": set the list of PDF templates that the users can select from on the [[PDF Export Options modal>>documentation.xs.user.exports.export-page.pdf-modal.WebHome]]. | ||
| 14 | * "Generator": [[select and configure the PDF generator>>documentation.xs.admin.exports.configure-pdf-export.pdf-generator-configuration.WebHome]]. | ||
| 15 | * "Page Ready Timeout": set the number of seconds to wait for the web page to be ready for print before aborting the PDF export. The default value is ##60##. | ||
| 16 | * "Maximum Content Size": set the maximum content size, in kilobytes (KB), that can be included in a PDF export. This limit is taken into account only when exporting multiple wiki Pages. The default value is ##5000##. Disable the limit by setting the value to ##0##. | ||
| 17 | * "Replace FOP": set whether to replace the old PDF export based on Apache Formatting Objects Processor (FOP). It is enabled by default, so the export of this application is labelled "PDF" on the [[Export Modal>>documentation.xs.user.exports.export-page.modal.WebHome]] and the old export is not offered at all. Disabling it labels this export "PDF (Web)" and brings the old one back as "PDF (FOP)". | ||
| 18 | ))) | ||
| 19 | 1. Click on "Save" to save the configurations, or exit the Page to discard. You can also "Reset" the changes to the default. | ||
| 20 | 1. Check that the section reports the settings saved. They apply to the whole wiki, so the next PDF export any user runs uses them:((( | ||
| 21 | {{image reference="pdf-export-saved.png" size="large" alt="The bottom of the PDF Export administration section, with a Saved confirmation under the Save and Reset buttons"/}} | ||
| 22 | ))) |
