Configure the PDF Export for XWiki Pages
Steps
To export content in PDF format:
- Administer your wiki.
- Select "Content", and then select "PDF Export" from the dropdown.
- Check the state of the PDF Generator. Depending on the Generator configured, the state can be "Available" or "Currently unavailable".
- Select and configure the settings of the PDF export:
- "Templates": set the list of PDF templates that the users can select from on the PDF Export Options modal.
- "Generator": select and configure the PDF generator.
- "Page Ready Timeout": set the page ready timeout, that is the number of seconds to wait for the web page to be ready for print before aborting the PDF export.
- "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 5MB. Disable the maximum content size by setting its value to 0.
- "Replace FOP": set whether to replace the old PDF export based on Apache Formatting Objects Processor (FOP) or not; the label displayed on the Export Modal depends on this setting: "PDF" vs. "PDF (Web)"
- Click on "Save" to save the configurations, or exit the Page to discrad. You can also "Reset" the changes to the default.
FAQ
What is a PDF generator?
A PDF generator is a tool or software that converts various data formats (e.g., text, images, web pages) into a PDF file. It helps create standardized printable documents.
What happens if I leave the list of templates empty in the configuration?
Leaving the list of templates empty will effectively disable the browser-based PDF export feature. This means users will not be able to export pages to PDF directly from the browser interface.
Why can't users export pages to PDF?
If the user trying to export doesn't have view right to any of the configured PDF templates, they won't be able to export Pages to PDF. Ensure that the user has the appropriate permissions to access the templates in order to enable PDF export functionality.
Is there any other way to configure the PDF generator?
Yes, you can configure the PDF generator by modifying the xwiki.properties file.
More
To find more about the current topic, you can search or use the table below and filter the columns to narrow your choices.
