Skip to Content

Wiki source code of Exports

Version 51.1 by Iulia Balan on 2015/09/22
Hide last authors
Raluca Moisa 29.2 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Vincent Massol 1.1 4
Silvia Macovei 46.1 5 XWiki offers the ability to 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
Silvia Macovei 46.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
Raluca Moisa 29.2 13 {{warning}}
14 Right now we don't have any user interface for exporting a set of wiki pages. This is a [[work in progress>>http://jira.xwiki.org/jira/browse/XWIKI-1289]]. However it's possible to export a set of pages by following the instructions below for each export format.
15 {{/warning}}
Vincent Massol 3.1 16
Silvia Macovei 18.2 17 = PDF Export =
Vincent Massol 1.1 18
Manuel Smeria 40.2 19 Starting with XWiki Enterprise 3.1, PDF Export has also an UI interface to manage the PDF Export
Sorin Burjan 34.1 20
Silvia Macovei 40.1 21 {{image reference="pdfExportOptions.png"/}}
Sorin Burjan 34.1 22
Silvia Macovei 12.1 23 To export a page as PDF use the action menu as explained above or use the following type of URL:
Vincent Massol 3.1 24
Raluca Moisa 29.2 25 {{code language="none"}}
26 http://server/xwiki/bin/export/Space/Page?format=pdf
27 {{/code}}
Silvia Macovei 12.1 28
Vincent Massol 32.1 29 To export several pages as PDF use the following type of URL (see the ##pages## parameter below):
30
Thibaut Camberlin 31.1 31 {{code language="none"}}
Vincent Massol 32.1 32 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 33 {{/code}}
34
Vincent Massol 3.1 35 In addition the following URL parameters can be added to refine what should be exported:
Thomas Mortagne 18.1 36
Manuel Smeria 40.3 37 * ##pages##: there can be several such parameters, each representing a page to export. For example: ##&pages=Main.WebHome&pages=Blog.WebHome##.
38 {{info}}When ##pages## parameters are specified, the current document specified in the URL isn't used{{/info}}
Silvia Macovei 12.3 39 * ##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 40 * ##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.
41 * ##pagebreaks##: if the value is set to ##1## then a page break is inserted between all exported pages.
Silvia Macovei 12.3 42 * ##comments##: if set to ##1## then also export the comments.
43 * ##attachments##: if set to ##1## then also export the attachments (only if they are images).
44
Guillaume Lerouge 17.1 45 {{info}}
Silvia Macovei 46.1 46 It's also possible to [[customize how the generated PDF looks like>>platform:AdminGuide.Configuration#HCustomizingthePDFexportLook26Feel]]. There's a panel that provides [[an UI for PDF Export options.>>extensions:Extension.PDF Export Panel Application]]
Guillaume Lerouge 17.1 47 {{/info}}
Vincent Massol 3.1 48
Sorin Burjan 35.2 49 = ODT Export =
50
Silvia Macovei 46.1 51 {{image reference="ExportFlamingoPDF.png"/}}
Sorin Burjan 35.2 52
Silvia Macovei 46.1 53 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>>http://extensions.xwiki.org/xwiki/bin/view/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 54
Vincent Massol 41.1 55 {{info}}
56 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.
57 {{/info}}
58
Silvia Macovei 18.2 59 = RTF Export =
Vincent Massol 4.2 60
Vincent Massol 41.1 61 The RTF export works in the same manner as the PDF export.
Vincent Massol 4.1 62
Vincent Massol 41.1 63 {{info}}XWiki 6.2{{/info}} Similar to the ODT export, you need an office server started to see the RTF export option.
64
Silvia Macovei 18.2 65 = XAR Export =
Vincent Massol 1.1 66
Ludovic Dubost 14.1 67 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 68
Vincent Massol 48.2 69 To export a page as a XAR use the action menu as explained above or 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):
Vincent Massol 4.1 70
Raluca Moisa 29.2 71 {{code language="none"}}
Thomas Mortagne 48.1 72 http://server/xwiki/bin/export/Space/Page?format=xar&pages=Space.Page
Raluca Moisa 29.2 73 {{/code}}
Silvia Macovei 12.1 74
Vincent Massol 4.1 75 In addition the following URL parameters can be added to refine what should be exported:
Silvia Macovei 12.1 76
Thomas Mortagne 47.1 77 * ##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 78 {{code language="none"}}
79 wikiid:pageFullNamePattern
80 {{/code}}
Thomas Mortagne 47.1 81
Marius Dumitru Florea 49.1 82 * ##wikiid##: the name of the wiki from where to get the wiki pages
Vincent Massol 42.1 83 * ##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 84 )))
85 * ##history##: if defined then also export the page's history. Example: ##&history=true##
86 * ##backup##: if defined then the XWiki document author of each page remains the same as the one exported when reimporting into an XWiki instance.
87 * ##author##: if defined, specifies the author's name in the XAR export which can later be viewed when reimporting into an XWiki instance.
88 * ##description##: if defined, gives a description added to the XAR export which can later be viewed when reimporting into an XWiki instance.
89 * ##license##: if defined, specifies the license to the XAR export which can later be viewed when reimporting into an XWiki instance.
90 * ##version##: if defined, specifies the version of the export to the XAR.
Vincent Massol 42.1 91
92 Some examples:
Thomas Mortagne 47.1 93
Marius Dumitru Florea 49.1 94 * Exports all pages in the ##Main## space:(((
Vincent Massol 42.1 95 {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.%25{{/code}}
96 )))
97 * Exports all pages in the current wiki:(((
Thomas Mortagne 47.1 98 {{code language="none"}}
99 http://server/xwiki/bin/export/Space/Page?format=xar&pages=%25.%25
100 {{/code}}
Vincent Massol 42.1 101 )))
102 * Exports the pages ##Main.WebHome## and ##Blog.WebHome##:(((
Thomas Mortagne 47.1 103 {{code language="none"}}
104 http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.WebHome&pages=Blog.WebHome
105 {{/code}}
Vincent Massol 42.1 106 )))
Vincent Massol 4.1 107
Silvia Macovei 18.2 108 = HTML Export =
Vincent Massol 1.1 109
Iulia Balan 51.1 110 The HTML export, available starting with XWiki 6.3, 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.
Silvia Macovei 12.3 111
Thomas Mortagne 10.1 112 To export a page as HTML use the action menu as explained above or use the following type of URL:
Thomas Mortagne 9.1 113
Raluca Moisa 29.2 114 {{code language="none"}}
115 http://server/xwiki/bin/export/Space/Page?format=html
116 {{/code}}
Silvia Macovei 12.1 117
Thomas Mortagne 5.1 118 In addition the following URL parameters can be added to refine what should be exported:
Silvia Macovei 12.1 119
Silvia Macovei 12.6 120 * ##name##: the name of the generated Zip file.
121 * ##description##: the comment in the generated Zip file.
Thomas Mortagne 48.1 122 * ##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 123 {{code language="none"}}
124 wikiid:pageFullNamePattern
125 {{/code}}
Thomas Mortagne 48.1 126
Marius Dumitru Florea 49.1 127 * ##wikiid##: the name of the wiki from where to get the wiki pages
Vincent Massol 42.1 128 * ##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 129 )))
Silvia Macovei 12.3 130
Vincent Massol 42.1 131 Some examples:
Thomas Mortagne 47.1 132
Raluca Moisa 29.2 133 * Exports the current page from the current wiki:(((
Silvia Macovei 12.1 134 {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html{{/code}}
Silvia Macovei 18.2 135 )))
Raluca Moisa 29.2 136 * Exports the current page from the current wiki in ##packagename.zip##:(((
137 {{code language="none"}}
138 http://server/xwiki/bin/export/Space/Page?format=html&name=packagename
139 {{/code}}
Silvia Macovei 18.2 140 )))
Raluca Moisa 29.2 141 * Exports all the pages from the ##Space## space as well as the ##Space2.Page## page from the current wiki:(((
Silvia Macovei 12.1 142 {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=Space.%25&pages=Space2.Page{{/code}}
Silvia Macovei 18.2 143 )))
Raluca Moisa 29.2 144 * Exports all the pages from the ##Space## space located in the ##wiki2## subwiki:(((
145 {{code language="none"}}
146 http://server/xwiki/bin/export/Space/Page?format=html&pages=wiki2:Space.%25
147 {{/code}}
Silvia Macovei 18.2 148 )))

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected