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]. For now please follow 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

1.1.1 Customizing the PDF look & Feel

28

29

TODO: Explain the <tt>pdftemplate</tt> parameter + the <tt>XWiki.PDFClass</tt> class.