From version < 12.2 >
edited by Oana Florea
on 2009/10/06
To version < 12.3 >
edited by Silvia Macovei
on 2009/10/06
< >
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.OanaTabaranu
1 +XWiki.SilviaRusu
Content
... ... @@ -2,7 +2,7 @@
2 2  
3 3  XWiki offers the ability to export a single wiki page or a set of wiki pages into several formats:
4 4  
5 -{{toc numbered=true/}}
5 +{{toc start=2 depth=6 numbered=false scope=page /}}
6 6  
7 7  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.
8 8  
... ... @@ -16,15 +16,14 @@
16 16  
17 17  {{code language="none"}}http://server/xwiki/bin/export/Spave/Page?format=pdf{{/code}}
18 18  
19 -{{html clean="false" wiki="true"}}
20 20  In addition the following URL parameters can be added to refine what should be exported:
21 -* <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>.
22 -* <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.
23 -* <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.
24 -* <tt>pagebreaks</tt>: if the value is set to <tt>1</tt> then a page break is inserted between each page exported.
25 -* <tt>comments</tt>: if set to <tt>1</tt> then also export the comments.
26 -* <tt>attachments</tt>: if set to <tt>1</tt> then also export the attachments (only if they are images).
27 -<p/>
20 +* ##pages##: There can be several such parameters, each representing a page to export. For example: ##&pages=Main.WebHome&pages=Blog.WebHome##.
21 +* ##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.
22 +* ##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.
23 +* ##pagebreaks##: if the value is set to ##1## then a page break is inserted between each page exported.
24 +* ##comments##: if set to ##1## then also export the comments.
25 +* ##attachments##: if set to ##1## then also export the attachments (only if they are images).
26 +
28 28  {{info}}It's also possible to [[customize how the generated PDF looks like>>platform:AdminGuide.Configuration#HCustomizingthePDFexportLook26Feel]].{{/info}}
29 29  
30 30  == RTF Export ==
... ... @@ -34,7 +34,7 @@
34 34  == XAR Export ==
35 35  
36 36  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.
37 -<p/>
36 +
38 38  To export a page as a XAR use the action menu as explained above or use the following type of URL:
39 39  
40 40  {{code language="none"}}http://server/xwiki/bin/export/Spave/Page?format=xar{{/code}}
... ... @@ -41,18 +41,18 @@
41 41  
42 42  In addition the following URL parameters can be added to refine what should be exported:
43 43  
44 -* <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>.
45 -* <tt>history</tt>: If defined then also export the page's history. Example: <tt>&history=true</tt>
46 -* <tt>backup</tt>: If defined then the XWiki document author of each page remain the same as the one exported when reimporting into a XWiki instance.
47 -* <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.
48 -* <tt>description</tt>: If defined, gives a description added to the XAR export which can later be viewed when reimporting into a XWiki instance.
49 -* <tt>license</tt>: If defined, specifies the license to the XAR export which can later be viewed when reimporting into a XWiki instance.
50 -* <tt>version</tt>: If defined, specifies the version of the export to the XAR.
43 +* ##pages##: There can be several such parameters, each representing a page to export. For example: ##&pages=Main.WebHome&pages=Blog.WebHome##.
44 +* ##history##: If defined then also export the page's history. Example: ##&history=true##
45 +* ##backup##: If defined then the XWiki document author of each page remain the same as the one exported when reimporting into a XWiki instance.
46 +* ##author##: If defined, specifies the author's name in the XAR export which can later be viewed when reimporting into a XWiki instance.
47 +* ##description##: If defined, gives a description added to the XAR export which can later be viewed when reimporting into a XWiki instance.
48 +* ##license##: If defined, specifies the license to the XAR export which can later be viewed when reimporting into a XWiki instance.
49 +* ##version##: If defined, specifies the version of the export to the XAR.
51 51  
52 52  == HTML Export ==
53 53  
54 54  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.
55 -<p/>
54 +
56 56  To export a page as HTML use the action menu as explained above or use the following type of URL:
57 57  
58 58  {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html{{/code}}
... ... @@ -59,12 +59,12 @@
59 59  
60 60  In addition the following URL parameters can be added to refine what should be exported:
61 61  
62 -* <tt>name</tt>: The name of the generated Zip file.
63 -* <tt>description</tt>: The comment in the generated Zip file.
64 -* <tt>pages</tt>: There can be several such parameters, each representing a pattern of pages to export. Here is the format of an export pattern: <tt>[[wikinamepattern:]]pageFullNamePattern</tt>
65 - ** <tt>wikinamepattern</tt>: 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]]
66 - ** <tt>pageFullNamePatern</tt>: 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.
67 -<p/>
61 +* ##name##: The name of the generated Zip file.
62 +* ##description##: The comment in the generated Zip file.
63 +* ##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##
64 + ** ##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]]
65 + ** ##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.
66 +
68 68  Some examples :
69 69  
70 70  * Exports the current page from the current wiki:
... ... @@ -71,16 +71,15 @@
71 71  
72 72  {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html{{/code}}
73 73  
74 -* Exports the current page from the current wiki in <tt>packagename.zip</tt>:
73 +* Exports the current page from the current wiki in ##packagename.zip##:
75 75  
76 76  {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&name=packagename{{/code}}
77 77  
78 -* Exports all the pages from the <tt>Space</tt> space as well as the <tt>Space2.Page</tt> page from the current wiki:
77 +* Exports all the pages from the ##Space## space as well as the ##Space2.Page## page from the current wiki:
79 79  
80 80  {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=Space.%25&pages=Space2.Page{{/code}}
81 81  
82 -* Exports all the pages from the <tt>Space</tt> space located in the <tt>wiki2</tt> subwiki:
83 -{{/html}}
81 +* Exports all the pages from the ##Space## space located in the ##wiki2## subwiki:
84 84  
85 85  {{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=wiki2:Space.%25{{/code}}
86 86  

Exports

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

  1. Exports
    1. PDF Export

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. 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/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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • attachments: if set to 1 then also export the attachments (only if they are images).

RTF Export

RTF Export

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

XAR 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.

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:

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/Spave/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.
  • 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
  • history: If defined then also export the page's history. Example: &history=true
  • backup: If defined then the XWiki document author of each page remain the same as the one exported when reimporting into a XWiki instance.
  • backup: If defined then the XWiki document author of each page remain the same as the one exported when reimporting into a XWiki instance.
  • author: If defined, specifies the author's name in the XAR export which can later be viewed when reimporting into a XWiki instance.
  • author: If defined, specifies the author's name in the XAR export which can later be viewed when reimporting into a XWiki instance.
  • description: If defined, gives a description added to the XAR export which can later be viewed when reimporting into a XWiki instance.
  • description: If defined, gives a description added to the XAR export which can later be viewed when reimporting into a XWiki instance.
  • license: If defined, specifies the license to the XAR export which can later be viewed when reimporting into a XWiki instance.
  • license: If defined, specifies the license to the XAR export which can later be viewed when reimporting into a XWiki instance.
  • version: If defined, specifies the version of the export to the XAR.
  • version: If defined, specifies the version of the export to the XAR.

HTML Export

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.

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:

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:

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

  • name: The name of the generated Zip file.
  • name: The name of the generated Zip file.
  • description: The comment in 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: wikinamepattern:pageFullNamePattern
    • wikinamepattern: the name of the wiki based on Java regular expressions
    • 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 :
  • 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

Some examples : 

  • Exports the current page from the current wiki:

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

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

  • Exports the current page from the current wiki in packagename.zip:
  • 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:
  • 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

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:
  • 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
  • Exports all the pages from all wikis/subwikis:
http://server/xwiki/bin/export/Space/Page?format=html&pages=.*:%25

Get Connected