Wiki source code of Exports
Version 59.1 by Thomas Mortagne on 2016/02/09
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
29.2 | 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} |
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
 |
1.1 | 4 | |
 |
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". |
| |
16.1 | 6 | |
| |
46.1 | 7 | {{image reference="ExportFlamingo.png"/}} |
 |
25.1 | 8 | |
| |
46.1 | 9 | {{image reference="ExportFlamingoPDF.png"/}} |
| |
16.1 | 10 | |
| |
46.1 | 11 | // "Export" as it appears using the Flamingo Skin. // |
| 12 | |||
| |
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}} | ||
| |
3.1 | 16 | |
| |
18.2 | 17 | = PDF Export = |
| |
1.1 | 18 | |
 |
40.2 | 19 | Starting with XWiki Enterprise 3.1, PDF Export has also an UI interface to manage the PDF Export |
| |
34.1 | 20 | |
| |
40.1 | 21 | {{image reference="pdfExportOptions.png"/}} |
| |
34.1 | 22 | |
| |
12.1 | 23 | To export a page as PDF use the action menu as explained above or use the following type of URL: |
| |
3.1 | 24 | |
| |
29.2 | 25 | {{code language="none"}} |
| 26 | http://server/xwiki/bin/export/Space/Page?format=pdf | ||
| 27 | {{/code}} | ||
| |
12.1 | 28 | |
| |
32.1 | 29 | To export several pages as PDF use the following type of URL (see the ##pages## parameter below): |
| 30 | |||
 |
31.1 | 31 | {{code language="none"}} |
| |
32.1 | 32 | http://server/xwiki/bin/export/Space/Page?format=pdf&pages=Admin.Page_A&pages=Admin.Page_B&pages=Admin.Page_C... |
| |
31.1 | 33 | {{/code}} |
| 34 | |||
| |
3.1 | 35 | In addition the following URL parameters can be added to refine what should be exported: |
 |
18.1 | 36 | |
| |
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}} | ||
| |
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. |
| |
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. | ||
| |
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 | |||
 |
17.1 | 45 | {{info}} |
| |
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]] |
| |
17.1 | 47 | {{/info}} |
| |
3.1 | 48 | |
| |
35.2 | 49 | = ODT Export = |
| 50 | |||
 |
54.1 | 51 | {{info}} |
| |
56.1 | 52 | ODT Export is available starting with XWiki Enterprise 6.3. |
| |
54.1 | 53 | {{/info}} |
| |
53.1 | 54 | |
| |
46.1 | 55 | {{image reference="ExportFlamingoPDF.png"/}} |
| |
35.2 | 56 | |
| |
46.1 | 57 | 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). |
| |
35.2 | 58 | |
| |
41.1 | 59 | {{info}} |
| 60 | 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. | ||
| 61 | {{/info}} | ||
| 62 | |||
| |
18.2 | 63 | = RTF Export = |
| |
4.2 | 64 | |
| |
41.1 | 65 | The RTF export works in the same manner as the PDF export. |
| |
4.1 | 66 | |
| |
41.1 | 67 | {{info}}XWiki 6.2{{/info}} Similar to the ODT export, you need an office server started to see the RTF export option. |
| 68 | |||
| |
18.2 | 69 | = XAR Export = |
| |
1.1 | 70 | |
| |
14.1 | 71 | 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. |
| |
12.3 | 72 | |
| |
48.2 | 73 | 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): |
| |
4.1 | 74 | |
| |
29.2 | 75 | {{code language="none"}} |
| |
48.1 | 76 | http://server/xwiki/bin/export/Space/Page?format=xar&pages=Space.Page |
| |
29.2 | 77 | {{/code}} |
| |
12.1 | 78 | |
| |
4.1 | 79 | In addition the following URL parameters can be added to refine what should be exported: |
| |
12.1 | 80 | |
| |
47.1 | 81 | * ##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:((( |
 |
49.1 | 82 | {{code language="none"}} |
| 83 | wikiid:pageFullNamePattern | ||
| 84 | {{/code}} | ||
| |
47.1 | 85 | |
| |
49.1 | 86 | * ##wikiid##: the name of the wiki from where to get the wiki pages |
| |
42.1 | 87 | * ##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. |
| |
50.1 | 88 | ))) |
| |
56.3 | 89 | * ##name##: the name of the exported XAR file. If not specified, a default name will be used. |
| |
50.1 | 90 | * ##history##: if defined then also export the page's history. Example: ##&history=true## |
| 91 | * ##backup##: if defined then the XWiki document author of each page remains the same as the one exported when reimporting into an XWiki instance. | ||
| 92 | * ##author##: if defined, specifies the author's name in the XAR export which can later be viewed when reimporting into an XWiki instance. | ||
| 93 | * ##description##: if defined, gives a description added to the XAR export which can later be viewed when reimporting into an XWiki instance. | ||
| 94 | * ##license##: if defined, specifies the license to the XAR export which can later be viewed when reimporting into an XWiki instance. | ||
| 95 | * ##version##: if defined, specifies the version of the export to the XAR. | ||
| |
42.1 | 96 | |
| 97 | Some examples: | ||
| |
47.1 | 98 | |
| |
49.1 | 99 | * Exports all pages in the ##Main## space:((( |
| |
42.1 | 100 | {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.%25{{/code}} |
| 101 | ))) | ||
| 102 | * Exports all pages in the current wiki:((( | ||
| |
47.1 | 103 | {{code language="none"}} |
| 104 | http://server/xwiki/bin/export/Space/Page?format=xar&pages=%25.%25 | ||
| 105 | {{/code}} | ||
| |
42.1 | 106 | ))) |
| 107 | * Exports the pages ##Main.WebHome## and ##Blog.WebHome##:((( | ||
| |
47.1 | 108 | {{code language="none"}} |
| 109 | http://server/xwiki/bin/export/Space/Page?format=xar&pages=Main.WebHome&pages=Blog.WebHome | ||
| 110 | {{/code}} | ||
| |
42.1 | 111 | ))) |
| |
4.1 | 112 | |
| |
18.2 | 113 | = HTML Export = |
| |
1.1 | 114 | |
| |
55.1 | 115 | {{info}} |
| 116 | HTML Export is available starting with XWiki Entreprise 6.3. | ||
| 117 | {{/info}} | ||
| |
12.3 | 118 | |
| |
55.1 | 119 | 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. |
| 120 | |||
| |
10.1 | 121 | To export a page as HTML use the action menu as explained above or use the following type of URL: |
| |
9.1 | 122 | |
| |
29.2 | 123 | {{code language="none"}} |
| 124 | http://server/xwiki/bin/export/Space/Page?format=html | ||
| 125 | {{/code}} | ||
| |
12.1 | 126 | |
| |
5.1 | 127 | In addition the following URL parameters can be added to refine what should be exported: |
| |
12.1 | 128 | |
| |
12.6 | 129 | * ##name##: the name of the generated Zip file. |
| 130 | * ##description##: the comment in the generated Zip file. | ||
| |
48.1 | 131 | * ##pages##: there can be several such parameters, each representing a pattern of pages to export. Here is the format of an export pattern:((( |
| |
49.1 | 132 | {{code language="none"}} |
| 133 | wikiid:pageFullNamePattern | ||
| 134 | {{/code}} | ||
| |
48.1 | 135 | |
| |
49.1 | 136 | * ##wikiid##: the name of the wiki from where to get the wiki pages |
| |
42.1 | 137 | * ##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. |
| |
50.1 | 138 | ))) |
| |
12.3 | 139 | |
| |
42.1 | 140 | Some examples: |
| |
47.1 | 141 | |
| |
29.2 | 142 | * Exports the current page from the current wiki:((( |
| |
12.1 | 143 | {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html{{/code}} |
| |
18.2 | 144 | ))) |
| |
29.2 | 145 | * Exports the current page from the current wiki in ##packagename.zip##:((( |
| 146 | {{code language="none"}} | ||
| 147 | http://server/xwiki/bin/export/Space/Page?format=html&name=packagename | ||
| 148 | {{/code}} | ||
| |
18.2 | 149 | ))) |
| |
29.2 | 150 | * Exports all the pages from the ##Space## space as well as the ##Space2.Page## page from the current wiki:((( |
| |
12.1 | 151 | {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=Space.%25&pages=Space2.Page{{/code}} |
| |
18.2 | 152 | ))) |
| |
29.2 | 153 | * Exports all the pages from the ##Space## space located in the ##wiki2## subwiki:((( |
| 154 | {{code language="none"}} | ||
| 155 | http://server/xwiki/bin/export/Space/Page?format=html&pages=wiki2:Space.%25 | ||
| 156 | {{/code}} | ||
| |
18.2 | 157 | ))) |
