Wiki source code of Import/Export

Last modified by Thomas Mortagne on 2023/10/10

Hide last authors
Sorin Burjan 13.2 1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
Vincent Massol 1.1 4
Vincent Massol 31.3 5 This feature allows you to export one or several pages from your wiki into a [[**XAR** file>>extensions:Extension.XAR Module Specifications]] (**X**Wiki **AR**chive) or to import one or several pages from an existing XAR file. This is useful for moving wiki pages from one instance to another or to perform lightweight backup of your wiki pages.
Vincent Massol 1.1 6
Manuel Smeria 16.2 7 {{warning}}
8 This feature doesn't replace a [[proper backup>>Backup]].
9 {{/warning}}
Vincent Massol 16.1 10
Vincent Massol 33.1 11 = Importing wiki pages =
Vincent Massol 1.3 12
Vincent Massol 33.1 13 This feature is brought by the [[Administration Application>>extensions:Extension.Administration Application]] and is documented in the [[Import section>>extensions:Extension.Administration Application#HImport]].
Thomas Mortagne 27.1 14
Vincent Massol 33.1 15 = Exporting wiki pages =
Ludovic Dubost 8.1 16
Vincent Massol 34.1 17 This feature is brought by the [[Administration Application>>extensions:Extension.Administration Application]] and is documented in the [[Export section>>extensions:Extension.Administration Application#HExport]].
Dmitry Bakbardin 18.1 18
Silvia Macovei 11.4 19 == Customizing a XAR ==
Guillaume Lerouge 1.7 20
Thomas Mortagne 35.1 21 When doing an export, XWiki pages are saved using the [[XAR format>>Documentation.AdminGuide.ImportExport||anchor="HXARFormat"]]. A typical XAR created when doing an export will include all the pages on your XWiki instance. However you can [[control this using a custom Export URL>>Documentation.UserGuide.Features.Exports||anchor="HXARExport"]].
Guillaume Lerouge 1.7 22
Vincent Massol 26.1 23 That said, it is also possible to create a XAR that will include only the pages you want. This is useful when you want to export only the pages of a specific application for example. Here are the steps:
Dmitry Bakbardin 18.1 24
Guillaume Lerouge 1.8 25 * Unzip the file
26 * Keep the pages you want to put in your archive
Manuel Smeria 16.2 27 * Edit ##package.xml## to delete the pages you do not want to be in the archive
28 * Zip together the modified ##package.xml## file and the pages you want to put together in your archive, naming the file "MyArchive".xar where "MyArchive" is the actual name you want to give it
29 * You're done! You can now import this specific set of pages to any XWiki instance
Vincent Massol 1.9 30
Sorin Burjan 13.2 31 {{info}}
Vincent Massol 14.1 32 In the future XWiki will offer the ability to do selective exports natively. For the moment you'll need to install the [[Multipage Export Extension>>extensions:Extension.Multipage Export Application]].
Sorin Burjan 13.2 33 {{/info}}
Vincent Massol 26.1 34
Vincent Massol 26.2 35 = XAR Format =
Vincent Massol 26.1 36
Thomas Mortagne 28.1 37 See [[XAR Format specifications>>extensions:Extension.XAR Module Specifications]].

Get Connected