Changes for page Exports
Last modified by Vincent Massol on 2024/01/05
From version 11.3
edited by Silvia Macovei
on 2009/10/06
on 2009/10/06
Change comment:
There is no comment for this version
To version 12.1
edited by Silvia Macovei
on 2009/10/06
on 2009/10/06
Change comment:
Document converted from syntax xwiki/1.0 to syntax xwiki/2.0
Summary
-
Page properties (2 modified, 0 added, 0 removed)
Details
- Page properties
-
- Syntax
-
... ... @@ -1,1 +1,1 @@ 1 -XWiki 1.01 +XWiki 2.0 - Content
-
... ... @@ -1,76 +1,89 @@ 1 - 1Exports1 += Exports = 2 2 3 3 XWiki offers the ability to export a single wiki page or a set of wiki pages into several formats: 4 -#toc("" "" "") 5 5 5 +{{toc start="" depth="" numbered=""/}} 6 + 6 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. 7 7 8 - {image:export.png}9 +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]. However it's possible to export a set of pages by following the instructions below for each export format.")11 +{{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}} 11 11 12 - 1.1PDF Export13 +== PDF Export == 13 13 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} 15 +To export a page as PDF use the action menu as explained above or use the following type of URL: 18 18 17 +{{code language="none"}}http://server/xwiki/bin/export/Spave/Page?format=pdf{{/code}} 18 + 19 +{{html clean="false" wiki="true"}} 19 19 In addition the following URL parameters can be added to refine what should be exported: 20 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 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>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 23 * <tt>pagebreaks</tt>: if the value is set to <tt>1</tt> then a page break is inserted between each page exported. 24 24 * <tt>comments</tt>: if set to <tt>1</tt> then also export the comments. 25 25 * <tt>attachments</tt>: if set to <tt>1</tt> then also export the attachments (only if they are images). 27 +<p/> 28 +{{info}}It's also possible to [[customize how the generated PDF looks like>>platform:AdminGuide.Configuration#HCustomizingthePDFexportLook26Feel]].{{/info}} 26 26 27 - #info("It'salso possible to [customize how the generated PDFlooks like>platform:AdminGuide.Configuration#HCustomizingthePDFexportLook26Feel].")30 +== RTF Export == 28 28 29 -1.1 RTF Export 30 - 31 31 The RTF export works exactly in the same manner as the PDF export. 32 32 33 - 1.1XAR Export34 +== XAR Export == 34 34 35 -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 - 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/> 37 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 41 40 +{{code language="none"}}http://server/xwiki/bin/export/Spave/Page?format=xar{{/code}} 41 + 42 42 In addition the following URL parameters can be added to refine what should be exported: 43 + 43 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 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 XWiki document author of each page remain sthe same as the one exported when reimporting into a XWiki instance.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. 46 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 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 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 49 * <tt>version</tt>: If defined, specifies the version of the export to the XAR. 50 50 51 - 1.1HTML Export52 +== HTML Export == 52 52 53 53 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. 54 - 55 +<p/> 55 55 To export a page as HTML use the action menu as explained above or use the following type of URL: 56 -{code:none} 57 -http://server/xwiki/bin/export/Space/Page?format=html 58 -{code} 59 59 58 +{{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html{{/code}} 59 + 60 60 In addition the following URL parameters can be added to refine what should be exported: 61 + 61 61 * <tt>name</tt>: The name of the generated Zip file. 62 62 * <tt>description</tt>: The comment in the generated Zip file. 63 -* <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>64 - ** <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] 65 - ** <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. 66 - 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/> 67 67 Some examples : 68 68 69 -* Exports the current page from the current wiki:{code:none}http://server/xwiki/bin/export/Space/Page?format=html{code} 70 -* Exports the current page from the current wiki in <tt>packagename.zip</tt>:{code:none}http://server/xwiki/bin/export/Space/Page?format=html&name=packagename{code} 71 -* Exports all the pages from the <tt>Space</tt> space as well as the <tt>Space2.Page</tt> page from the current wiki:{code:none}http://server/xwiki/bin/export/Space/Page?format=html&pages=Space.%25&pages=Space2.Page{code} 72 -* Exports all the pages from the <tt>Space</tt> space located in the <tt>wiki2</tt> subwiki:{code:none}http://server/xwiki/bin/export/Space/Page?format=html&pages=wiki2:Space.%25{code} 73 -* Exports all the pages from all wikis/subwikis:{code:none}http://server/xwiki/bin/export/Space/Page?format=html&pages=.*:%25{code} 70 +* Exports the current page from the current wiki: 74 74 72 +{{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html{{/code}} 75 75 74 +* Exports the current page from the current wiki in <tt>packagename.zip</tt>: 76 76 76 +{{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&name=packagename{{/code}} 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: 79 + 80 +{{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=Space.%25&pages=Space2.Page{{/code}} 81 + 82 +* Exports all the pages from the <tt>Space</tt> space located in the <tt>wiki2</tt> subwiki: 83 +{{/html}} 84 + 85 +{{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=wiki2:Space.%25{{/code}} 86 + 87 +* Exports all the pages from all wikis/subwikis: 88 + 89 +{{code language="none"}}http://server/xwiki/bin/export/Space/Page?format=html&pages=.*:%25{{/code}}