Skip to Content

Wiki source code of Exports

Version 111.1 by Marius Dumitru Florea on 2022/11/28
Hide last authors
Raluca Moisa 29.2 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Vincent Massol 1.1 4
Marius Dumitru Florea 108.1 5 As a user, you can export a single wiki page or a set of wiki pages into several formats. To perform a page export click on "Export" in the "More actions" menu.
Silvia Macovei 16.1 6
Marius Dumitru Florea 108.1 7 {{image reference="ExportFlamingo.png" /}}
Sorin Burjan 25.1 8
Marius Dumitru Florea 108.1 9 This opens the Export Modal from where you can select the export format.
Silvia Macovei 16.1 10
Marius Dumitru Florea 108.1 11 {{image reference="exportDialog.png" /}}
Silvia Macovei 46.1 12
Marius Dumitru Florea 108.1 13 The next step depends on whether the selected format supports multi-page export or not:
14
15 * if multi-page export is supported, like in the case of XAR export, then the Export Tree Modal is shown(((
16 {{image reference="exportTreeModal.png" /}}
17 )))
18 * otherwise the user is taken directly to the dedicated page for the selected export format
19
Vincent Massol 74.3 20 In addition, Admins can also export all the pages of the wiki through the [[Import/Export Admin feature>>platform:AdminGuide.ImportExport]].
Vincent Massol 65.2 21
Silvia Macovei 18.2 22 = PDF Export =
Vincent Massol 1.1 23
Vincent Massol 90.1 24 {{info}}
25 {{version since="14.2"}}
26 An experimental [[client-side PDF export extension>>extensions:Extension.PDF Export Application.WebHome]] is available and is meant to replace the current server-side one.
27 {{/version}}
28 {{/info}}
Sorin Burjan 34.1 29
Vincent Massol 93.4 30 {{image reference="exportAsPDF.png"/}}
31
Vincent Massol 90.1 32 The PDF Export has a UI interface to manage the export:
33
Silvia Macovei 40.1 34 {{image reference="pdfExportOptions.png"/}}
Sorin Burjan 34.1 35
Vincent Massol 90.1 36 To export a page as PDF, use the action menu as explained above or use the following type of URL:
Vincent Massol 3.1 37
Raluca Moisa 29.2 38 {{code language="none"}}
39 http://server/xwiki/bin/export/Space/Page?format=pdf
40 {{/code}}
Silvia Macovei 12.1 41
Vincent Massol 93.4 42 Right now we don't have any user interface for exporting an arbitrary set of wiki pages. This is a [[work in progress>>https://jira.xwiki.org/browse/XWIKI-1289]]. However it's possible to export a set of pages, using the following type of URL:
Vincent Massol 32.1 43
Thibaut Camberlin 31.1 44 {{code language="none"}}
Vincent Massol 32.1 45 http://server/xwiki/bin/export/Space/Page?format=pdf&pages=Admin.Page_A&pages=Admin.Page_B&pages=Admin.Page_C...
Thibaut Camberlin 31.1 46 {{/code}}
47
Vincent Massol 3.1 48 In addition the following URL parameters can be added to refine what should be exported:
Thomas Mortagne 18.1 49
Manuel Smeria 40.3 50 * ##pages##: there can be several such parameters, each representing a page to export. For example: ##&pages=Main.WebHome&pages=Blog.WebHome##.
51 {{info}}When ##pages## parameters are specified, the current document specified in the URL isn't used{{/info}}
Silvia Macovei 12.3 52 * ##includechilds##: the value is a number specifying the depth of children pages to include in the PDF export. For example ##&includechilds=2## will include all children pages of the page to export, all its children (i.e. pages which have the page as its parent) and all the children's children.
Silvia Macovei 12.7 53 * ##includelinks##: the value is a number specifying the depth of linked pages to include in the PDF export. For example ##&includelinks=2## will include all pages linked from the page to export and the links in the linked pages.
54 * ##pagebreaks##: if the value is set to ##1## then a page break is inserted between all exported pages.
Silvia Macovei 12.3 55 * ##comments##: if set to ##1## then also export the comments.
56 * ##attachments##: if set to ##1## then also export the attachments (only if they are images).
57
Guillaume Lerouge 17.1 58 {{info}}
Vincent Massol 65.3 59 Notes:
Sakthivel Muthu 75.1 60
Vincent Massol 93.4 61 * It's also possible to [[customize how the generated PDF looks like>>platform:AdminGuide.Configuration#HCustomizingthePDFexportLook26Feel]].
Vincent Massol 65.3 62 * There's also a contributed panel that provides [[an UI for PDF Export options.>>extensions:Extension.PDF Export Panel Application]]
Guillaume Lerouge 17.1 63 {{/info}}
Vincent Massol 3.1 64
Sorin Burjan 35.2 65 = ODT Export =
66
Vincent Massol 93.2 67 {{image reference="exportAsODT.png"/}}
Sorin Burjan 35.2 68
Ecaterina Moraru (Valica) 73.1 69 If you configure your wiki to work with an office server ([[LibreOffice>>http://www.libreoffice.org/]] or [[OpenOffice>>http://www.openoffice.org/]]) as described in the [[Office Importer Application>>extensions:Extension.Office Importer Application]] you'll notice a new entry in the export modal popup (as long as you are connected to the office server).
Sorin Burjan 35.2 70
Vincent Massol 41.1 71 {{info}}
72 You can tweak the export URL to export to other office formats supported by your office server. For instance ##/xwiki/bin/export/Sandbox/WebHome?format=doc## exports Sandbox.WebHome page to Microsoft Word's proprietary DOC format.
73 {{/info}}
74
Silvia Macovei 18.2 75 = RTF Export =
Vincent Massol 4.2 76
Vincent Massol 41.1 77 The RTF export works in the same manner as the PDF export.
Vincent Massol 4.1 78
Vincent Massol 93.4 79 {{image reference="exportAsRTF.png"/}}
80
Vincent Massol 93.3 81 Similar to the ODT export, you need an office server started to see the RTF export option.
Vincent Massol 41.1 82
Silvia Macovei 18.2 83 = XAR Export =
Vincent Massol 1.1 84
Ludovic Dubost 14.1 85 The XAR export allows exporting pages in the internal XML format used by XWiki. This is the format that you can use to [[Import/Export>>platform:AdminGuide.ImportExport]] pages and applications into/from XWiki instances.
Silvia Macovei 12.3 86
Guillaume Delhumeau 63.1 87 To export a page as a XAR use the action menu as explained above:
Vincent Massol 4.1 88
Vincent Massol 98.4 89 {{image reference="exportAsXAR.png"/}}
Guillaume Delhumeau 63.1 90
Vincent Massol 106.3 91 A tree will be displayed to allow you to chose children pages that you want to export along with the current page. You can filter the tree to exclude extension pages (e.g. //Created pages//, //Created and modified pages// or //All pages//). Check out the [[Administration Application>>extensions:Extension.Administration Application#HExport]] for more information about the export tree.
Guillaume Delhumeau 63.1 92
93 {{info}}
94 Naturally, this tree is not displayed if the current page is terminal, which means it cannot have children.
95 {{/info}}
96
Eduard Moraru 86.3 97 Notes:
98
99 * The "Export XAR" option will only appear if you are logged in with an admin user.
100 * To import back a XAR file, you also need to be an admin user and use the [[Import section in Administration>>Documentation.AdminGuide.ImportExport]]
101
Guillaume Delhumeau 65.1 102 == Advanced ==
103
Guillaume Delhumeau 63.1 104 You could also use the following type of URL (note that the ##Space/Page## part in the URL is ignored and the Export action only takes into account the ##pages## Query String parameter):
105
Raluca Moisa 29.2 106 {{code language="none"}}
Thomas Mortagne 48.1 107 http://server/xwiki/bin/export/Space/Page?format=xar&pages=Space.Page
Raluca Moisa 29.2 108 {{/code}}
Silvia Macovei 12.1 109
Vincent Massol 4.1 110 In addition the following URL parameters can be added to refine what should be exported:
Silvia Macovei 12.1 111
Vincent Massol 106.2 112 * ##pages##: there can be several such parameters, each representing a pattern of pages to export. Here is the format of an export pattern:(((
Marius Dumitru Florea 49.1 113 {{code language="none"}}
114 wikiid:pageFullNamePattern
115 {{/code}}
Thomas Mortagne 47.1 116
Marius Dumitru Florea 49.1 117 * ##wikiid##: the name of the wiki from where to get the wiki pages
Vincent Massol 42.1 118 * ##pageFullNamePattern##: the full name pattern of the page based on [[SQL "LIKE" comparator>>http://www.techonthenet.com/sql/like.php]]. Remember that the character {{{%}}} has to be converted in {{{%25}}} in an URL.
Marius Dumitru Florea 50.1 119 )))
Vincent Massol 106.4 120 * ##excludes##: there can also be several such parameter, each representing a pattern, or list of pages associated to a ##pages## pattern. The format is the same as for pages except all special characters must be encoding in the URL. Also, as the parameter is attached to a ##pages## parameter, be careful with the order. See the examples below.
Vincent Massol 56.3 121 * ##name##: the name of the exported XAR file. If not specified, a default name will be used.
Marius Dumitru Florea 50.1 122 * ##history##: if defined then also export the page's history. Example: ##&history=true##
123 * ##backup##: if defined then the XWiki document author of each page remains the same as the one exported when reimporting into an XWiki instance.
124 * ##author##: if defined, specifies the author's name in the XAR export which can later be viewed when reimporting into an XWiki instance.
125 * ##description##: if defined, gives a description added to the XAR export which can later be viewed when reimporting into an XWiki instance.
126 * ##license##: if defined, specifies the license to the XAR export which can later be viewed when reimporting into an XWiki instance.
127 * ##version##: if defined, specifies the version of the export to the XAR.
Vincent Massol 42.1 128
129 Some examples:
Thomas Mortagne 47.1 130
Marius Dumitru Florea 49.1 131 * Exports all pages in the ##Main## space:(((
Oana Florea 89.2 132 {{code language="none"}}
133 http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.%25
134 {{/code}}
Vincent Massol 42.1 135 )))
136 * Exports all pages in the current wiki:(((
Thomas Mortagne 47.1 137 {{code language="none"}}
138 http://server/xwiki/bin/export/Space/Page?format=xar&pages=%25.%25
139 {{/code}}
Vincent Massol 42.1 140 )))
141 * Exports the pages ##Main.WebHome## and ##Blog.WebHome##:(((
Thomas Mortagne 47.1 142 {{code language="none"}}
143 http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.WebHome&pages=Blog.WebHome
144 {{/code}}
Simon Urli 86.1 145 )))
Simon Urli 83.2 146 * Exports all pages in the ##Main## space except pages under ##Main.Space1## space, and all pages under ##Other## space:(((
Oana Florea 89.2 147 {{code language="none"}}
148 http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.%25&excludes=Main.Space1.%25&pages=Other.%25
149 {{/code}}
Simon Urli 83.2 150 )))
151 * Exports all pages in the ##subwiki:Main## space except a page named ##subwiki:Main.Excluded&Other## and ##subwiki:Main.WebHome##:(((
152 {{code language="none"}}
153 http://server/xwiki/bin/export/Space/Page?format=xar&pages=subwiki:Main.%25&excludes=subwiki%3AMain.Excluded%26Other&subwiki%3AMain.WebHome
154 {{/code}}
155 )))
Simon Urli 85.1 156 * Exports all pages in the ##Main## space and all in the ##Other## space except ##Other.Excluded## (see the empty excludes for respecting the order):(((
157 {{code language="none"}}
158 http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.%25&excludes=&pages=Other.%25&excludes=Other.Excluded
159 {{/code}}
160 )))
Vincent Massol 4.1 161
Silvia Macovei 18.2 162 = HTML Export =
Vincent Massol 1.1 163
Iulia Balan 55.1 164 The HTML export allows exporting wiki pages as static HTML pages independent from the XWiki engine. All pages are exported in view mode. That way you can export a whole space containing documentation and access it on your computer without any web server. The export is done with the current skin.
165
Guillaume Delhumeau 64.1 166 To export a page as HTML use the action menu as explained above:
Thomas Mortagne 9.1 167
Vincent Massol 98.4 168 {{image reference="exportAsHTML.png"/}}
Guillaume Delhumeau 64.1 169
170 A tree will be displayed to allow you to chose children pages that you want to export along with the current page.
171
Vincent Massol 68.1 172 The HTML export is packaged as a ZIP. Here's an example of its content and how it's organized:
173
174 {{image reference="htmlexport-content.png"/}}
175
176 A basic index page is also generated and provides a list (and links) of all pages that have been exported. For example:
177
178 {{image reference="htmlexport-index.png"/}}
179
Guillaume Delhumeau 64.1 180 == Advanced ==
181
182 You could also use the following type of URL:
183
Raluca Moisa 29.2 184 {{code language="none"}}
185 http://server/xwiki/bin/export/Space/Page?format=html
186 {{/code}}
Silvia Macovei 12.1 187
Thomas Mortagne 5.1 188 In addition the following URL parameters can be added to refine what should be exported:
Silvia Macovei 12.1 189
Silvia Macovei 12.6 190 * ##name##: the name of the generated Zip file.
191 * ##description##: the comment in the generated Zip file.
Thomas Mortagne 48.1 192 * ##pages##: there can be several such parameters, each representing a pattern of pages to export. Here is the format of an export pattern:(((
Marius Dumitru Florea 49.1 193 {{code language="none"}}
194 wikiid:pageFullNamePattern
195 {{/code}}
Thomas Mortagne 48.1 196
Marius Dumitru Florea 49.1 197 * ##wikiid##: the name of the wiki from where to get the wiki pages
Vincent Massol 42.1 198 * ##pageFullNamePattern##: the full name pattern of the page based on [[SQL "LIKE" comparator>>http://www.techonthenet.com/sql/like.php]]. Remember that the character {{{%}}} has to be converted in {{{%25}}} in an URL.
Marius Dumitru Florea 50.1 199 )))
Vincent Massol 106.6 200 * ##excludes##: there can also be several such parameter, each representing a pattern, or list of pages associated to a ##pages## pattern. The format is the same as for pages except all special characters must be encoding in the URL. Also, as the parameter is attached to a ##pages## parameter, be careful with the order. See the examples below.
Silvia Macovei 12.3 201
Vincent Massol 42.1 202 Some examples:
Thomas Mortagne 47.1 203
Raluca Moisa 29.2 204 * Exports the current page from the current wiki:(((
Oana Florea 89.2 205 {{code language="none"}}
206 http://server/xwiki/bin/export/Space/Page?format=html
207 {{/code}}
Silvia Macovei 18.2 208 )))
Raluca Moisa 29.2 209 * Exports the current page from the current wiki in ##packagename.zip##:(((
210 {{code language="none"}}
211 http://server/xwiki/bin/export/Space/Page?format=html&name=packagename
212 {{/code}}
Silvia Macovei 18.2 213 )))
Raluca Moisa 29.2 214 * Exports all the pages from the ##Space## space as well as the ##Space2.Page## page from the current wiki:(((
Oana Florea 89.2 215 {{code language="none"}}
216 http://server/xwiki/bin/export/Space/Page?format=html&pages=Space.%25&pages=Space2.Page
217 {{/code}}
Silvia Macovei 18.2 218 )))
Raluca Moisa 29.2 219 * Exports all the pages from the ##Space## space located in the ##wiki2## subwiki:(((
220 {{code language="none"}}
221 http://server/xwiki/bin/export/Space/Page?format=html&pages=wiki2:Space.%25
222 {{/code}}
Silvia Macovei 18.2 223 )))
Simon Urli 86.1 224 * Exports all pages in the ##Main## space except pages under ##Main.Space1## space, and all pages under ##Other## space:(((
Oana Florea 89.2 225 {{code language="none"}}
226 http://server/xwiki/bin/export/Space/Page?format=html&pages=Main.%25&excludes=Main.Space1.%25&pages=Other.%25
227 {{/code}}
Simon Urli 86.1 228 )))
229 * Exports all pages in the ##subwiki:Main## space except a page named ##subwiki:Main.Excluded&Other## and ##subwiki:Main.WebHome##:(((
230 {{code language="none"}}
231 http://server/xwiki/bin/export/Space/Page?format=html&pages=subwiki:Main.%25&excludes=subwiki%3AMain.Excluded%26Other&subwiki%3AMain.WebHome
232 {{/code}}
233 )))
234 * Exports all pages in the ##Main## space and all in the ##Other## space except ##Other.Excluded## (see the empty excludes for respecting the order):(((
235 {{code language="none"}}
236 http://server/xwiki/bin/export/Space/Page?format=html&pages=Main.%25&excludes=&pages=Other.%25&excludes=Other.Excluded
237 {{/code}}
238 )))

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected