From version < 2.1 >
edited by Vincent Massol
on 2008/05/26
To version < 3.1 >
edited by Vincent Massol
on 2008/05/26
< >
Change comment: Added explanation for PDF exports

Summary

Details

Page properties
Content
... ... @@ -7,8 +7,27 @@
7 7  
8 8  {image:export.png}
9 9  
10 +#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.")
11 +
10 10  1.1 PDF Export
11 11  
14 +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.
30 +
12 12  1.1 RTF Export
13 13  
14 14  1.1 XAR Export

Exports

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

Invalid macro parameters used for the "toc" macro. Cause: [Failed to validate bean: [must be greater than or equal to 1]]. Click on this message for details.

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.

export.png

Right now we don't have any user interface for exporting a set of wiki pages. This is a work in progress. For now please follow 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/Spave/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 each page exported.
  • 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).

Customizing the PDF look & Feel

TODO: Explain the pdftemplate parameter + the XWiki.PDFClass class.

RTF Export

XAR Export

HTML Export

Get Connected