From version < 29.1 >
edited by Raluca Moisa
on 2010/12/16
To version < 29.2 >
edited by Raluca Moisa
on 2010/12/16
< >
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,23 +1,29 @@
1 -{{box cssClass="floatinginfobox" title="**Contents**"}}{{toc/}}{{/box}}
1 +{{box cssClass="floatinginfobox" title="**Contents**"}}
2 +{{toc/}}
3 +{{/box}}
2 2  
3 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 4  
5 -[[image:ToucanExportScreen.png||style="border:1px solid black;]]
7 +[[image:ExportToucan.png]]
6 6  // "Print" as it appears using the Toucan Skin //
7 7  
8 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:
9 9  
12 +[[image:ExportColibri.png]]\\
10 10  
11 -[[image:ColibriExportScreen.png||style="border:1px solid black;]]
12 12  // "Export" as it appears using the Colibri Skin when logged in //
13 13  
14 -{{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}}
16 +{{warning}}
17 +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.
18 +{{/warning}}
15 15  
16 16  = PDF Export =
17 17  
18 18  To export a page as PDF use the action menu as explained above or use the following type of URL:
19 19  
20 -{{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=pdf{{/code}}
24 +{{code language="none"}}
25 +http://server/xwiki/bin/export/Space/Page?format=pdf
26 +{{/code}}
21 21  
22 22  In addition the following URL parameters can be added to refine what should be exported:
23 23  
... ... @@ -43,7 +43,9 @@
43 43  
44 44  To export a page as a XAR use the action menu as explained above or use the following type of URL:
45 45  
46 -{{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=xar{{/code}}
52 +{{code language="none"}}
53 +http://server/xwiki/bin/export/Space/Page?format=xar
54 +{{/code}}
47 47  
48 48  In addition the following URL parameters can be added to refine what should be exported:
49 49  
... ... @@ -61,7 +61,9 @@
61 61  
62 62  To export a page as HTML use the action menu as explained above or use the following type of URL:
63 63  
64 -{{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html{{/code}}
72 +{{code language="none"}}
73 +http://server/xwiki/bin/export/Space/Page?format=html
74 +{{/code}}
65 65  
66 66  In addition the following URL parameters can be added to refine what should be exported:
67 67  
... ... @@ -73,19 +73,19 @@
73 73  
74 74  Some examples :
75 75  
76 -* Exports the current page from the current wiki:
77 -(((
86 +* Exports the current page from the current wiki:(((
78 78  {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html{{/code}}
79 79  )))
80 -* Exports the current page from the current wiki in ##packagename.zip##:
81 -(((
82 -{{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&name=packagename{{/code}}
89 +* Exports the current page from the current wiki in ##packagename.zip##:(((
90 +{{code language="none"}}
91 +http://server/xwiki/bin/export/Space/Page?format=html&name=packagename
92 +{{/code}}
83 83  )))
84 -* Exports all the pages from the ##Space## space as well as the ##Space2.Page## page from the current wiki:
85 -(((
94 +* Exports all the pages from the ##Space## space as well as the ##Space2.Page## page from the current wiki:(((
86 86  {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=Space.%25&pages=Space2.Page{{/code}}
87 87  )))
88 -* Exports all the pages from the ##Space## space located in the ##wiki2## subwiki:
89 -(((
90 -{{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=wiki2:Space.%25{{/code}}
97 +* Exports all the pages from the ##Space## space located in the ##wiki2## subwiki:(((
98 +{{code language="none"}}
99 +http://server/xwiki/bin/export/Space/Page?format=html&pages=wiki2:Space.%25
100 +{{/code}}
91 91  )))

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:

ToucanExportScreen.png
 "Print" as it appears using the Toucan Skin 

ToucanExportScreen.png
 "Print" as it appears using the Toucan Skin 

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:

ExportColibri.png

ColibriExportScreen.png
 "Export" as it appears using the Colibri Skin when logged in 

 "Export" as it appears using the Colibri Skin when logged in 

Right now we don't have any user interface for exporting a set of wiki pages. This is a work in progress. However it's possible to export a set of pages by following the instructions below for each export format.

PDF Export

To export a page as PDF use the action menu as explained above or use the following type of URL:

http://server/xwiki/bin/export/Space/Page?format=pdf

In addition the following URL parameters can be added to refine what should be exported:

  • pages: there can be several such parameters, each representing a page to export. For example: &pages=Main.WebHome&pages=Blog.WebHome.
  • 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.
  • 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.
  • pagebreaks: if the value is set to 1 then a page break is inserted between all exported pages.
  • comments: if set to 1 then also export the comments.
  • attachments: if set to 1 then also export the attachments (only if they are images).

It's also possible to customize how the generated PDF looks like.
There's a panel that provides an UI for PDF Export options.

RTF Export

The RTF export works exactly in the same manner as the PDF export.

XAR Export

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 pages and applications into/from XWiki instances.

To export a page as a XAR use the action menu as explained above or use the following type of URL:

http://server/xwiki/bin/export/Space/Page?format=xar

In addition the following URL parameters can be added to refine what should be exported:

  • pages: there can be several such parameters, each representing a page to export. For example: &pages=Main.WebHome&pages=Blog.WebHome.
  • history: if defined then also export the page's history. Example: &history=true
  • backup: if defined then the XWiki document author of each page remains the same as the one exported when reimporting into an XWiki instance.
  • author: if defined, specifies the author's name in the XAR export which can later be viewed when reimporting into an XWiki instance.
  • description: if defined, gives a description added to the XAR export which can later be viewed when reimporting into an XWiki instance.
  • license: if defined, specifies the license to the XAR export which can later be viewed when reimporting into an XWiki instance.
  • version: if defined, specifies the version of the export to the XAR.

HTML Export

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.

To export a page as HTML use the action menu as explained above or use the following type of URL:

http://server/xwiki/bin/export/Space/Page?format=html

In addition the following URL parameters can be added to refine what should be exported: 

  • name: the name of the generated Zip file.
  • description: the comment in the generated Zip file.
  • 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
    • wikiid: the name of the wiki from where to get the wiki pages
    • pageFullNamePatern: the full name pattern of the page based on HQL "LIKE" comparator. Remember that the character % has to be converted in %25 in an URL.

Some examples : 

  • Exports the current page from the current wiki:

    http://server/xwiki/bin/export/Space/Page?format=html 

  • Exports the current page from the current wiki in packagename.zip:
    http://server/xwiki/bin/export/Space/Page?format=html&name=packagename
  • Exports all the pages from the Space space as well as the Space2.Page page from the current wiki:

    http://server/xwiki/bin/export/Space/Page?format=html&pages=Space.%25&pages=Space2.Page 

  • Exports all the pages from the Space space located in the wiki2 subwiki:
    http://server/xwiki/bin/export/Space/Page?format=html&pages=wiki2:Space.%25

Get Connected