Exports (XWiki.org)

1

1 Exports

2

3

XWiki offers the ability to export a single wiki page or a set of wiki pages into several formats:

4

#toc("" "" "")

5

6

To perform a page export simply go to the page, select the "Print" menu (in the Albatross/Toucan skins - if you use another skin it may be located somewhere else) and select the type of export you wish to perform as shown in the following screenshot.

{image:export.png}

#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.")

1.1 PDF Export

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

15

{code:none}

16

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

17

{code}

18

19

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

20

* <tt>pages</tt>: There can be several such parameters, each representing a page to export. For example: <tt>&pages=Main.WebHome&pages=Blog.WebHome</tt>.

21

* <tt>includechilds</tt>: the value is a number specifying the depth of children pages to include in the PDF export. For example <tt>&includechilds=2</tt> 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.

22

* <tt>includelinks</tt>: the value is a number specifying the depth of linked pages to include in the PDF export. For example <tt>&includelinks=2</tt> will include all pages linked from the page to export and the links in the linked pages.

23

* <tt>pagebreaks</tt>: if the value is set to <tt>1</tt> then a page break is inserted between each page exported.

24

* <tt>comments</tt>: if set to <tt>1</tt> then also export the comments.

25

* <tt>attachments</tt>: if set to <tt>1</tt> then also export the attachments (only if they are images).

26

27

#info("It's also possible to [customize how the generated PDF looks like>platform:AdminGuide.Configuration#HCustomizingthePDFexportLook26Feel].")

1.1 RTF Export

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

1.1 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>platform:AdminGuide.ImportExport] pages and applications into/from XWiki instances.

36

37

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

38

{code:none}

39

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

40

{code}

41

42

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

43

* <tt>pages</tt>: There can be several such parameters, each representing a page to export. For example: <tt>&pages=Main.WebHome&pages=Blog.WebHome</tt>.

44

* <tt>history</tt>: If defined then also export the page's history. Example: <tt>&history=true</tt>

45

* <tt>backup</tt>: If defined then the export is considered a backup pack...

46

* <tt>author</tt>: If defined, specifies the author's name in the XAR export which can later be viewed when reimporting into a XWiki instance.

47

* <tt>description</tt>: If defined, gives a description added to the XAR export which can later be viewed when reimporting into a XWiki instance.

48

* <tt>license</tt>: If defined, specifies the license to the XAR export which can later be viewed when reimporting into a XWiki instance.

49

* <tt>version</tt>: If defined, specifies the version of the export to the XAR.

1.1 HTML Export

The HTML export allows exporting page as statics HTML,CSS, JavaScript... pages independent from xwiki engine. All pages are exported in view mode. That way you can export a whole space containing documentation and access it in your computer without any web server.

54

55

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

56

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

57

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

58

* name: The name of the generated ZIP package.

59

* description: The comment in the generated ZIP package.

60

* pages: There can be several such parameters, each representing a pattern of pages to export. Here is the form of an export pattern : \[wikinamepattern:\]PageFullNamePattern

61

** wikinamepattern : the name of the wiki based on JAVA regular expressions (See http://java.sun.com/j2se/1.5.0/docs/api/java/util/regex/Pattern.html#construct for details on syntax)

62

** PageFullNamePatern : the full name pattern of the page based on HQL ?LIKE? comparator (See http://www.techonthenet.com/sql/like.php for details on syntax). Remember that the character % has to be converted in %25 in an URL.

Some examples :

* http://server/xwiki/bin/export/Space/Page?format=html : export the current page from the current wiki

68

* http://server/xwiki/bin/export/Space/Page?format=html&name=packagename : export the current page from the current wiki in packagename.zip

69

* http://server/xwiki/bin/export/Space/Page?format=html&pages=Space.%25 : export al the page from space ?Space? from the current wiki

70