Wiki source code of Exports
Version 22.1 by Sorin Burjan on 2010/06/02
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
18.2 | 1 | {{box cssClass="floatinginfobox" title="**Contents**"}}{{toc/}}{{/box}} |
 |
1.1 | 2 | |
| |
16.1 | 3 | XWiki offers the ability to export a single wiki page or a set of wiki pages into several formats. To perform a page export simply go to the page, select the "Print" menu (in the Albatross/Toucan skins) and select the type of export you wish to perform as shown in the following screenshot: |
| 4 | |||
| |
12.1 | 5 | image:export.png |
| |
16.1 | 6 | // "Print" as it appears using the Toucan Skin // |
| |
1.1 | 7 | |
| |
16.2 | 8 | If you are using the Colibri skin to perform a page export go to the page, hover over the "Export" menu and select the type of export you wish to perform as you can see in the following screenshot: |
| |
16.1 | 9 | |
 |
20.1 | 10 | image:ColibriExportScreen.png |
| |
21.1 | 11 | // "Export" as it appears using the Colibri Skin when the user is logged in // |
| |
16.1 | 12 | |
| |
12.1 | 13 | {{warning}}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.{{/warning}} |
| |
3.1 | 14 | |
| |
18.2 | 15 | = PDF Export = |
| |
1.1 | 16 | |
| |
12.1 | 17 | To export a page as PDF use the action menu as explained above or use the following type of URL: |
| |
3.1 | 18 | |
| |
12.1 | 19 | {{code language="none"}}http://server/xwiki/bin/export/Spave/Page?format=pdf{{/code}} |
| 20 | |||
| |
3.1 | 21 | In addition the following URL parameters can be added to refine what should be exported: |
 |
18.1 | 22 | |
| |
12.5 | 23 | * ##pages##: there can be several such parameters, each representing a page to export. For example: ##&pages=Main.WebHome&pages=Blog.WebHome##. |
| |
12.3 | 24 | * ##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 | 25 | * ##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. |
| 26 | * ##pagebreaks##: if the value is set to ##1## then a page break is inserted between all exported pages. | ||
| |
12.3 | 27 | * ##comments##: if set to ##1## then also export the comments. |
| 28 | * ##attachments##: if set to ##1## then also export the attachments (only if they are images). | ||
| 29 | |||
 |
17.1 | 30 | {{info}} |
| 31 | It's also possible to [[customize how the generated PDF looks like>>platform:AdminGuide.Configuration#HCustomizingthePDFexportLook26Feel]]. | ||
| 32 | There's a panel that provides [[an UI for PDF Export options.>>code:Applications.PDFExportPanelApplication]] | ||
| 33 | {{/info}} | ||
| |
3.1 | 34 | |
| |
18.2 | 35 | = RTF Export = |
| |
4.2 | 36 | |
| |
4.1 | 37 | The RTF export works exactly in the same manner as the PDF export. |
| 38 | |||
| |
18.2 | 39 | = XAR Export = |
| |
1.1 | 40 | |
 |
14.1 | 41 | 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 | 42 | |
| |
4.1 | 43 | To export a page as a XAR use the action menu as explained above or use the following type of URL: |
| 44 | |||
| |
12.1 | 45 | {{code language="none"}}http://server/xwiki/bin/export/Spave/Page?format=xar{{/code}} |
| 46 | |||
| |
4.1 | 47 | In addition the following URL parameters can be added to refine what should be exported: |
| |
12.1 | 48 | |
| |
12.6 | 49 | * ##pages##: there can be several such parameters, each representing a page to export. For example: ##&pages=Main.WebHome&pages=Blog.WebHome##. |
| 50 | * ##history##: if defined then also export the page's history. Example: ##&history=true## | ||
| |
12.8 | 51 | * ##backup##: if defined then the XWiki document author of each page remains the same as the one exported when reimporting into an XWiki instance. |
| 52 | * ##author##: if defined, specifies the author's name in the XAR export which can later be viewed when reimporting into an XWiki instance. | ||
| 53 | * ##description##: if defined, gives a description added to the XAR export which can later be viewed when reimporting into an XWiki instance. | ||
| 54 | * ##license##: if defined, specifies the license to the XAR export which can later be viewed when reimporting into an XWiki instance. | ||
| |
12.6 | 55 | * ##version##: if defined, specifies the version of the export to the XAR. |
| |
4.1 | 56 | |
| |
18.2 | 57 | = HTML Export = |
| |
1.1 | 58 | |
| |
10.2 | 59 | 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. |
| |
12.3 | 60 | |
| |
10.1 | 61 | To export a page as HTML use the action menu as explained above or use the following type of URL: |
| |
9.1 | 62 | |
| |
12.1 | 63 | {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html{{/code}} |
| 64 | |||
| |
5.1 | 65 | In addition the following URL parameters can be added to refine what should be exported: |
| |
12.1 | 66 | |
| |
12.6 | 67 | * ##name##: the name of the generated Zip file. |
| 68 | * ##description##: the comment in the generated Zip file. | ||
| |
18.1 | 69 | * ##pages##: there can be several such parameters, each representing a pattern of pages to export. Here is the format of an export pattern: ##wikiid:pageFullNamePattern## |
| 70 | ** ##wikiid##: the name of the wiki from where to get the wiki pages | ||
| 71 | ** ##pageFullNamePatern##: the full name pattern of the page based on [[HQL "LIKE" comparator>>http://www.techonthenet.com/sql/like.php]]. Remember that the character % has to be converted in %25 in an URL. | ||
| |
12.3 | 72 | |
| |
5.1 | 73 | Some examples : |
| 74 | |||
| |
12.1 | 75 | * Exports the current page from the current wiki: |
| |
18.2 | 76 | ((( |
| |
12.1 | 77 | {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html{{/code}} |
| |
18.2 | 78 | ))) |
| |
12.3 | 79 | * Exports the current page from the current wiki in ##packagename.zip##: |
| |
18.2 | 80 | ((( |
| |
12.1 | 81 | {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&name=packagename{{/code}} |
| |
18.2 | 82 | ))) |
| |
12.3 | 83 | * Exports all the pages from the ##Space## space as well as the ##Space2.Page## page from the current wiki: |
| |
18.2 | 84 | ((( |
| |
12.1 | 85 | {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=Space.%25&pages=Space2.Page{{/code}} |
| |
18.2 | 86 | ))) |
| |
12.3 | 87 | * Exports all the pages from the ##Space## space located in the ##wiki2## subwiki: |
| |
18.2 | 88 | ((( |
| |
12.1 | 89 | {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=wiki2:Space.%25{{/code}} |
| |
18.2 | 90 | ))) |
