Wiki source code of Exports
Version 84.1 by Simon Urli on 2018/10/03
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} | ||
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
| 4 | |||
| 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". | ||
| 6 | |||
| 7 | {{image reference="ExportFlamingo.png"/}} | ||
| 8 | |||
| 9 | {{image reference="ExportFlamingoPDF.png"/}} | ||
| 10 | |||
| 11 | // "Export" as it appears using the Flamingo Skin. // | ||
| 12 | |||
| 13 | In addition, Admins can also export all the pages of the wiki through the [[Import/Export Admin feature>>platform:AdminGuide.ImportExport]]. | ||
| 14 | |||
| 15 | {{warning}} | ||
| 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. | ||
| 17 | {{/warning}} | ||
| 18 | |||
| 19 | = PDF Export = | ||
| 20 | |||
| 21 | Starting with XWiki 3.1, PDF Export has also an UI interface to manage the PDF Export | ||
| 22 | |||
| 23 | {{image reference="pdfExportOptions.png"/}} | ||
| 24 | |||
| 25 | To export a page as PDF use the action menu as explained above or use the following type of URL: | ||
| 26 | |||
| 27 | {{code language="none"}} | ||
| 28 | http://server/xwiki/bin/export/Space/Page?format=pdf | ||
| 29 | {{/code}} | ||
| 30 | |||
| 31 | To export several pages as PDF use the following type of URL (see the ##pages## parameter below): | ||
| 32 | |||
| 33 | {{code language="none"}} | ||
| 34 | http://server/xwiki/bin/export/Space/Page?format=pdf&pages=Admin.Page_A&pages=Admin.Page_B&pages=Admin.Page_C... | ||
| 35 | {{/code}} | ||
| 36 | |||
| 37 | In addition the following URL parameters can be added to refine what should be exported: | ||
| 38 | |||
| 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}} | ||
| 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. | ||
| 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. | ||
| 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 | |||
| 47 | {{info}} | ||
| 48 | Notes: | ||
| 49 | |||
| 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]] | ||
| 52 | {{/info}} | ||
| 53 | |||
| 54 | = ODT Export = | ||
| 55 | |||
| 56 | {{info}} | ||
| 57 | ODT Export is available starting with XWiki 6.3. | ||
| 58 | {{/info}} | ||
| 59 | |||
| 60 | {{image reference="ExportFlamingoPDF.png"/}} | ||
| 61 | |||
| 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). | ||
| 63 | |||
| 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 | |||
| 68 | = RTF Export = | ||
| 69 | |||
| 70 | The RTF export works in the same manner as the PDF export. | ||
| 71 | |||
| 72 | {{info}}XWiki 6.2{{/info}} Similar to the ODT export, you need an office server started to see the RTF export option. | ||
| 73 | |||
| 74 | = XAR Export = | ||
| 75 | |||
| 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. | ||
| 77 | |||
| 78 | To export a page as a XAR use the action menu as explained above: | ||
| 79 | |||
| 80 | ((( | ||
| 81 | {{image reference="ExportFlamingoXAR.png"/}} | ||
| 82 | ))) | ||
| 83 | |||
| 84 | A tree will be displayed to allow you to chose children pages that you want to export along with the current page. | ||
| 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 | |||
| 90 | == Advanced == | ||
| 91 | |||
| 92 | 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): | ||
| 93 | |||
| 94 | {{code language="none"}} | ||
| 95 | http://server/xwiki/bin/export/Space/Page?format=xar&pages=Space.Page | ||
| 96 | {{/code}} | ||
| 97 | |||
| 98 | In addition the following URL parameters can be added to refine what should be exported: | ||
| 99 | |||
| 100 | * ##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:((( | ||
| 101 | {{code language="none"}} | ||
| 102 | wikiid:pageFullNamePattern | ||
| 103 | {{/code}} | ||
| 104 | |||
| 105 | * ##wikiid##: the name of the wiki from where to get the wiki pages | ||
| 106 | * ##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. | ||
| 107 | ))) | ||
| 108 | * (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. See the examples below. | ||
| 109 | * ##name##: the name of the exported XAR file. If not specified, a default name will be used. | ||
| 110 | * ##history##: if defined then also export the page's history. Example: ##&history=true## | ||
| 111 | * ##backup##: if defined then the XWiki document author of each page remains the same as the one exported when reimporting into an XWiki instance. | ||
| 112 | * ##author##: if defined, specifies the author's name in the XAR export which can later be viewed when reimporting into an XWiki instance. | ||
| 113 | * ##description##: if defined, gives a description added to the XAR export which can later be viewed when reimporting into an XWiki instance. | ||
| 114 | * ##license##: if defined, specifies the license to the XAR export which can later be viewed when reimporting into an XWiki instance. | ||
| 115 | * ##version##: if defined, specifies the version of the export to the XAR. | ||
| 116 | |||
| 117 | Some examples: | ||
| 118 | |||
| 119 | * Exports all pages in the ##Main## space:((( | ||
| 120 | {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.%25{{/code}} | ||
| 121 | ))) | ||
| 122 | * Exports all pages in the current wiki:((( | ||
| 123 | {{code language="none"}} | ||
| 124 | http://server/xwiki/bin/export/Space/Page?format=xar&pages=%25.%25 | ||
| 125 | {{/code}} | ||
| 126 | ))) | ||
| 127 | * Exports the pages ##Main.WebHome## and ##Blog.WebHome##:((( | ||
| 128 | {{code language="none"}} | ||
| 129 | http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.WebHome&pages=Blog.WebHome | ||
| 130 | {{/code}} | ||
| 131 | ))) | ||
| 132 | * Exports all pages in the ##Main## space except pages under ##Main.Space1## space, and all pages under ##Other## space:((( | ||
| 133 | {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.%25&excludes=Main.Space1.%25&pages=Other.%25{{/code}} | ||
| 134 | ))) | ||
| 135 | * Exports all pages in the ##subwiki:Main## space except a page named ##subwiki:Main.Excluded&Other## and ##subwiki:Main.WebHome##:((( | ||
| 136 | {{code language="none"}} | ||
| 137 | http://server/xwiki/bin/export/Space/Page?format=xar&pages=subwiki:Main.%25&excludes=subwiki%3AMain.Excluded%26Other&subwiki%3AMain.WebHome | ||
| 138 | {{/code}} | ||
| 139 | ))) | ||
| 140 | |||
| 141 | = HTML Export = | ||
| 142 | |||
| 143 | {{info}} | ||
| 144 | HTML Export is available starting with XWiki Entreprise 6.3. | ||
| 145 | {{/info}} | ||
| 146 | |||
| 147 | 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. | ||
| 148 | |||
| 149 | To export a page as HTML use the action menu as explained above: | ||
| 150 | |||
| 151 | {{image reference="ExportFlamingoXAR.png"/}} | ||
| 152 | |||
| 153 | A tree will be displayed to allow you to chose children pages that you want to export along with the current page. | ||
| 154 | |||
| 155 | The HTML export is packaged as a ZIP. Here's an example of its content and how it's organized: | ||
| 156 | |||
| 157 | {{image reference="htmlexport-content.png"/}} | ||
| 158 | |||
| 159 | A basic index page is also generated and provides a list (and links) of all pages that have been exported. For example: | ||
| 160 | |||
| 161 | {{image reference="htmlexport-index.png"/}} | ||
| 162 | |||
| 163 | == Advanced == | ||
| 164 | |||
| 165 | You could also use the following type of URL: | ||
| 166 | |||
| 167 | {{code language="none"}} | ||
| 168 | http://server/xwiki/bin/export/Space/Page?format=html | ||
| 169 | {{/code}} | ||
| 170 | |||
| 171 | In addition the following URL parameters can be added to refine what should be exported: | ||
| 172 | |||
| 173 | * ##name##: the name of the generated Zip file. | ||
| 174 | * ##description##: the comment in the generated Zip file. | ||
| 175 | * ##pages##: there can be several such parameters, each representing a pattern of pages to export. Here is the format of an export pattern:((( | ||
| 176 | {{code language="none"}} | ||
| 177 | wikiid:pageFullNamePattern | ||
| 178 | {{/code}} | ||
| 179 | |||
| 180 | * ##wikiid##: the name of the wiki from where to get the wiki pages | ||
| 181 | * ##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. | ||
| 182 | ))) | ||
| 183 | |||
| 184 | Some examples: | ||
| 185 | |||
| 186 | * Exports the current page from the current wiki:((( | ||
| 187 | {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html{{/code}} | ||
| 188 | ))) | ||
| 189 | * Exports the current page from the current wiki in ##packagename.zip##:((( | ||
| 190 | {{code language="none"}} | ||
| 191 | http://server/xwiki/bin/export/Space/Page?format=html&name=packagename | ||
| 192 | {{/code}} | ||
| 193 | ))) | ||
| 194 | * Exports all the pages from the ##Space## space as well as the ##Space2.Page## page from the current wiki:((( | ||
| 195 | {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=Space.%25&pages=Space2.Page{{/code}} | ||
| 196 | ))) | ||
| 197 | * Exports all the pages from the ##Space## space located in the ##wiki2## subwiki:((( | ||
| 198 | {{code language="none"}} | ||
| 199 | http://server/xwiki/bin/export/Space/Page?format=html&pages=wiki2:Space.%25 | ||
| 200 | {{/code}} | ||
| 201 | ))) |
