Wiki source code of PDF Export Modal
Last modified by Eleni Cojocariu on 2026/03/19 08:02
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | When [[exporting a Page>>documentation.xs.user.exports.export-page.WebHome]] as a PDF as a user, the PDF export modal will appear. | ||
| 2 | {{image reference="pdf-export-options.png" size="medium" alt="The export options modal for the PDF format"/}} | ||
| 3 | |||
| 4 | The [[PDF Export Application>>extensions:Extension.PDF Export Application.WebHome]] provides a default PDF template that controls the information displayed on the cover Page, in the table of contents as well as in the header and footer of each Page. You can configure the following options: | ||
| 5 | |||
| 6 | * "Cover": When checked, a cover Page is included, displaying the following information of the wiki Page where the export was triggered: | ||
| 7 | ** [[Title>>documentation.xs.user.base.page.edit-page.titles-names.WebHome||anchor="PageTitles"]] | ||
| 8 | ** [[Version>>documentation.xs.user.base.page.view-page.view-history.major-minor-versions.WebHome]] | ||
| 9 | ** [[Last author>>documentation.xs.user.base.page.authors-page.WebHome]] | ||
| 10 | ** Modification date | ||
| 11 | * "Table of Contents": When checked, a table of contents will be included, showing the print Page number where each heading appears and provides internal links to those headings. | ||
| 12 | ** For a single wiki Page export, it will display headings up to level 3 from the exported Page. | ||
| 13 | ** For a multi-Page export, it will display aggregated [[headings (up to level 3)>>Documentation.UserGuide.Features.XWikiSyntax.WebHome||anchor="HHeadings"]] from all the exported Pages, including the [[Page titles>>documentation.xs.user.base.page.edit-page.titles-names.WebHome||anchor="PageTitles"]]. | ||
| 14 | * "Header": When checked, he header will display: | ||
| 15 | ** For a single wiki Page export, it shows the title of the wiki Page where the export was triggered. | ||
| 16 | ** For a multi-Page export, it shows the title of the wiki page that provided the content for the current print page. | ||
| 17 | * "Footer": When checked, the footer will display the print Page number and the total number of Pages in the PDF. | ||
| 18 | |||
| 19 | Below is an example of how the exported Pages would look with all the PDF export options enabled: | ||
| 20 | |||
| 21 | {{gallery}} | ||
| 22 | image:cover-pdf-export.png alt="Example result of a cover page of a PDF exported page" | ||
| 23 | image:toc-pdf-export.png alt="Example result of a table of content of a PDF exported page" | ||
| 24 | image:page-content-pdf-export.png alt= "Example result of a page content with header and footer of a PDF exported page" | ||
| 25 | {{/gallery}} | ||
| 26 | |||
| 27 | The PDF can display Page metadata in the header or footer. This metadata includes additional information related to the exported wiki Pages. When multiple wiki Pages are exported, the content of each wiki Page starts on a new print Page in the generated PDF. |
