Wiki source code of Exports

Last modified by Oana Florea on 2020/07/01

Hide last authors
Raluca Moisa 29.2 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Vincent Massol 1.1 4
Vincent Massol 65.2 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, then click "Export as PDF".
Silvia Macovei 16.1 6
Silvia Macovei 46.1 7 {{image reference="ExportFlamingo.png"/}}
Sorin Burjan 25.1 8
Thomas Mortagne 78.1 9 {{image reference="ExportFlamingoPDF.png"/}}
Silvia Macovei 16.1 10
Silvia Macovei 46.1 11 // "Export" as it appears using the Flamingo Skin. //
12
Vincent Massol 74.3 13 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 14
Raluca Moisa 29.2 15 {{warning}}
Thomas Mortagne 70.1 16 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 by following the instructions below for each export format, through some custom URLs.
Raluca Moisa 29.2 17 {{/warning}}
Vincent Massol 3.1 18
Silvia Macovei 18.2 19 = PDF Export =
Vincent Massol 1.1 20
Ecaterina Moraru (Valica) 73.1 21 Starting with XWiki 3.1, PDF Export has also an UI interface to manage the PDF Export
Sorin Burjan 34.1 22
Silvia Macovei 40.1 23 {{image reference="pdfExportOptions.png"/}}
Sorin Burjan 34.1 24
Silvia Macovei 12.1 25 To export a page as PDF use the action menu as explained above or use the following type of URL:
Vincent Massol 3.1 26
Raluca Moisa 29.2 27 {{code language="none"}}
28 http://server/xwiki/bin/export/Space/Page?format=pdf
29 {{/code}}
Silvia Macovei 12.1 30
Vincent Massol 32.1 31 To export several pages as PDF use the following type of URL (see the ##pages## parameter below):
32
Thibaut Camberlin 31.1 33 {{code language="none"}}
Vincent Massol 32.1 34 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 35 {{/code}}
36
Vincent Massol 3.1 37 In addition the following URL parameters can be added to refine what should be exported:
Thomas Mortagne 18.1 38
Manuel Smeria 40.3 39 * ##pages##: there can be several such parameters, each representing a page to export. For example: ##&pages=Main.WebHome&pages=Blog.WebHome##.
40 {{info}}When ##pages## parameters are specified, the current document specified in the URL isn't used{{/info}}
Silvia Macovei 12.3 41 * ##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 42 * ##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.
43 * ##pagebreaks##: if the value is set to ##1## then a page break is inserted between all exported pages.
Silvia Macovei 12.3 44 * ##comments##: if set to ##1## then also export the comments.
45 * ##attachments##: if set to ##1## then also export the attachments (only if they are images).
46
Guillaume Lerouge 17.1 47 {{info}}
Vincent Massol 65.3 48 Notes:
Sakthivel Muthu 75.1 49
Vincent Massol 65.3 50 * It's also possible to [[customize how the generated PDF looks like>>platform:AdminGuide.Configuration#HCustomizingthePDFexportLook26Feel]].
51 * There's also a contributed panel that provides [[an UI for PDF Export options.>>extensions:Extension.PDF Export Panel Application]]
Guillaume Lerouge 17.1 52 {{/info}}
Vincent Massol 3.1 53
Sorin Burjan 35.2 54 = ODT Export =
55
Iulia Balan 54.1 56 {{info}}
Ecaterina Moraru (Valica) 74.1 57 ODT Export is available starting with XWiki 6.3.
Iulia Balan 54.1 58 {{/info}}
Iulia Balan 53.1 59
Silvia Macovei 46.1 60 {{image reference="ExportFlamingoPDF.png"/}}
Sorin Burjan 35.2 61
Ecaterina Moraru (Valica) 73.1 62 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 63
Vincent Massol 41.1 64 {{info}}
65 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.
66 {{/info}}
67
Silvia Macovei 18.2 68 = RTF Export =
Vincent Massol 4.2 69
Vincent Massol 41.1 70 The RTF export works in the same manner as the PDF export.
Vincent Massol 4.1 71
Vincent Massol 41.1 72 {{info}}XWiki 6.2{{/info}} Similar to the ODT export, you need an office server started to see the RTF export option.
73
Silvia Macovei 18.2 74 = XAR Export =
Vincent Massol 1.1 75
Ludovic Dubost 14.1 76 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 77
Guillaume Delhumeau 63.1 78 To export a page as a XAR use the action menu as explained above:
Vincent Massol 4.1 79
Guillaume Delhumeau 63.1 80 (((
Oana Florea 89.2 81 {{image reference="ExportFlamingoXAR.png"/}}
Guillaume Delhumeau 63.1 82 )))
83
Oana Florea 89.2 84 A tree will be displayed to allow you to chose children pages that you want to export along with the current page. Starting with XWiki 11.10 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 85
86 {{info}}
87 Naturally, this tree is not displayed if the current page is terminal, which means it cannot have children.
88 {{/info}}
89
Eduard Moraru 86.3 90 Notes:
91
92 * The "Export XAR" option will only appear if you are logged in with an admin user.
93 * To import back a XAR file, you also need to be an admin user and use the [[Import section in Administration>>Documentation.AdminGuide.ImportExport]]
94
Guillaume Delhumeau 65.1 95 == Advanced ==
96
Guillaume Delhumeau 63.1 97 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):
98
Raluca Moisa 29.2 99 {{code language="none"}}
Thomas Mortagne 48.1 100 http://server/xwiki/bin/export/Space/Page?format=xar&pages=Space.Page
Raluca Moisa 29.2 101 {{/code}}
Silvia Macovei 12.1 102
Vincent Massol 4.1 103 In addition the following URL parameters can be added to refine what should be exported:
Silvia Macovei 12.1 104
Thomas Mortagne 47.1 105 * ##pages##: there can be several such parameters, each representing a pattern of pages to export (prior to XWiki 6.3, only fixed page names could be specified, not patterns). Here is the format of an export pattern:(((
Marius Dumitru Florea 49.1 106 {{code language="none"}}
107 wikiid:pageFullNamePattern
108 {{/code}}
Thomas Mortagne 47.1 109
Marius Dumitru Florea 49.1 110 * ##wikiid##: the name of the wiki from where to get the wiki pages
Vincent Massol 42.1 111 * ##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 112 )))
Simon Urli 85.1 113 * (Since {{info}}10.9RC1{{/info}}) ##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 114 * ##name##: the name of the exported XAR file. If not specified, a default name will be used.
Marius Dumitru Florea 50.1 115 * ##history##: if defined then also export the page's history. Example: ##&history=true##
116 * ##backup##: if defined then the XWiki document author of each page remains the same as the one exported when reimporting into an XWiki instance.
117 * ##author##: if defined, specifies the author's name in the XAR export which can later be viewed when reimporting into an XWiki instance.
118 * ##description##: if defined, gives a description added to the XAR export which can later be viewed when reimporting into an XWiki instance.
119 * ##license##: if defined, specifies the license to the XAR export which can later be viewed when reimporting into an XWiki instance.
120 * ##version##: if defined, specifies the version of the export to the XAR.
Vincent Massol 42.1 121
122 Some examples:
Thomas Mortagne 47.1 123
Marius Dumitru Florea 49.1 124 * Exports all pages in the ##Main## space:(((
Oana Florea 89.2 125 {{code language="none"}}
126 http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.%25
127 {{/code}}
Vincent Massol 42.1 128 )))
129 * Exports all pages in the current wiki:(((
Thomas Mortagne 47.1 130 {{code language="none"}}
131 http://server/xwiki/bin/export/Space/Page?format=xar&pages=%25.%25
132 {{/code}}
Vincent Massol 42.1 133 )))
134 * Exports the pages ##Main.WebHome## and ##Blog.WebHome##:(((
Thomas Mortagne 47.1 135 {{code language="none"}}
136 http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.WebHome&pages=Blog.WebHome
137 {{/code}}
Simon Urli 86.1 138 )))
139
140 Since {{info}}10.9RC1{{/info}}:
141
Simon Urli 83.2 142 * Exports all pages in the ##Main## space except pages under ##Main.Space1## space, and all pages under ##Other## space:(((
Oana Florea 89.2 143 {{code language="none"}}
144 http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.%25&excludes=Main.Space1.%25&pages=Other.%25
145 {{/code}}
Simon Urli 83.2 146 )))
147 * Exports all pages in the ##subwiki:Main## space except a page named ##subwiki:Main.Excluded&Other## and ##subwiki:Main.WebHome##:(((
148 {{code language="none"}}
149 http://server/xwiki/bin/export/Space/Page?format=xar&pages=subwiki:Main.%25&excludes=subwiki%3AMain.Excluded%26Other&subwiki%3AMain.WebHome
150 {{/code}}
151 )))
Simon Urli 85.1 152 * Exports all pages in the ##Main## space and all in the ##Other## space except ##Other.Excluded## (see the empty excludes for respecting the order):(((
153 {{code language="none"}}
154 http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.%25&excludes=&pages=Other.%25&excludes=Other.Excluded
155 {{/code}}
156 )))
Vincent Massol 4.1 157
Silvia Macovei 18.2 158 = HTML Export =
Vincent Massol 1.1 159
Iulia Balan 55.1 160 {{info}}
161 HTML Export is available starting with XWiki Entreprise 6.3.
162 {{/info}}
Silvia Macovei 12.3 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 68.1 168 {{image reference="ExportFlamingoXAR.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 )))
Simon Urli 86.1 200 * (Since {{info}}10.9RC1{{/info}}) ##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
225 Since {{info}}10.9RC1{{/info}}:
226
227 * Exports all pages in the ##Main## space except pages under ##Main.Space1## space, and all pages under ##Other## space:(((
Oana Florea 89.2 228 {{code language="none"}}
229 http://server/xwiki/bin/export/Space/Page?format=html&pages=Main.%25&excludes=Main.Space1.%25&pages=Other.%25
230 {{/code}}
Simon Urli 86.1 231 )))
232 * Exports all pages in the ##subwiki:Main## space except a page named ##subwiki:Main.Excluded&Other## and ##subwiki:Main.WebHome##:(((
233 {{code language="none"}}
234 http://server/xwiki/bin/export/Space/Page?format=html&pages=subwiki:Main.%25&excludes=subwiki%3AMain.Excluded%26Other&subwiki%3AMain.WebHome
235 {{/code}}
236 )))
237 * Exports all pages in the ##Main## space and all in the ##Other## space except ##Other.Excluded## (see the empty excludes for respecting the order):(((
238 {{code language="none"}}
239 http://server/xwiki/bin/export/Space/Page?format=html&pages=Main.%25&excludes=&pages=Other.%25&excludes=Other.Excluded
240 {{/code}}
241 )))

Get Connected