From version < 17.1 >
edited by Guillaume Lerouge
on 2009/10/21
To version < 18.2 >
edited by Silvia Macovei
on 2010/02/24
< >
Change comment: Fixed Title; Changed TOC; Aligned Code

Summary

Details

Page properties
Title
... ... @@ -1,0 +1,1 @@
1 +Exports
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.GuillaumeLerouge
1 +XWiki.SilviaRusu
Content
... ... @@ -1,12 +1,5 @@
1 +{{box cssClass="floatinginfobox" title="**Contents**"}}{{toc/}}{{/box}}
1 1  
2 -(% class="floatinginfobox" %)(((
3 -**Contents**
4 -
5 -{{toc start=2 depth=3 numbered=false scope=page /}}
6 -)))
7 -
8 -= Exports =
9 -
10 10  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:
11 11  
12 12  image:export.png
... ... @@ -19,7 +19,7 @@
19 19  
20 20  {{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}}
21 21  
22 -== PDF Export ==
15 += PDF Export =
23 23  
24 24  To export a page as PDF use the action menu as explained above or use the following type of URL:
25 25  
... ... @@ -26,6 +26,7 @@
26 26  {{code language="none"}}http://server/xwiki/bin/export/Spave/Page?format=pdf{{/code}}
27 27  
28 28  In addition the following URL parameters can be added to refine what should be exported:
22 +
29 29  * ##pages##: there can be several such parameters, each representing a page to export. For example: ##&pages=Main.WebHome&pages=Blog.WebHome##.
30 30  * ##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.
31 31  * ##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.
... ... @@ -38,11 +38,11 @@
38 38  There's a panel that provides [[an UI for PDF Export options.>>code:Applications.PDFExportPanelApplication]]
39 39  {{/info}}
40 40  
41 -== RTF Export ==
35 += RTF Export =
42 42  
43 43  The RTF export works exactly in the same manner as the PDF export.
44 44  
45 -== XAR Export ==
39 += XAR Export =
46 46  
47 47  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.
48 48  
... ... @@ -60,7 +60,7 @@
60 60  * ##license##: if defined, specifies the license to the XAR export which can later be viewed when reimporting into an XWiki instance.
61 61  * ##version##: if defined, specifies the version of the export to the XAR.
62 62  
63 -== HTML Export ==
57 += HTML Export =
64 64  
65 65  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.
66 66  
... ... @@ -72,28 +72,25 @@
72 72  
73 73  * ##name##: the name of the generated Zip file.
74 74  * ##description##: the comment in the generated Zip file.
75 -* ##pages##: there can be several such parameters, each representing a pattern of pages to export. Here is the format of an export pattern: ##wikinamepattern:pageFullNamePattern##
76 - ** ##wikinamepattern##: the name of the wiki based on [[Java regular expressions>>http://java.sun.com/j2se/1.5.0/docs/api/java/util/regex/Pattern.html#construct]]
77 - ** ##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.
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.
78 78  
79 79  Some examples :
80 80  
81 81  * Exports the current page from the current wiki:
82 -
76 +(((
83 83  {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html{{/code}}
84 -
78 +)))
85 85  * Exports the current page from the current wiki in ##packagename.zip##:
86 -
80 +(((
87 87  {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&name=packagename{{/code}}
88 -
82 +)))
89 89  * Exports all the pages from the ##Space## space as well as the ##Space2.Page## page from the current wiki:
90 -
84 +(((
91 91  {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=Space.%25&pages=Space2.Page{{/code}}
92 -
86 +)))
93 93  * Exports all the pages from the ##Space## space located in the ##wiki2## subwiki:
94 -
88 +(((
95 95  {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=wiki2:Space.%25{{/code}}
96 -
97 -* Exports all the pages from all wikis/subwikis:
98 -
99 -{{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=.*:%25{{/code}}
90 +)))

Get Connected