Wiki source code of Import/Export
Version 33.1 by Vincent Massol on 2020/08/17
Hide last authors
| author | version | line-number | content |
|---|---|---|---|
 |
13.2 | 1 | {{box cssClass="floatinginfobox" title="**Contents**"}} |
| 2 | {{toc/}} | ||
| 3 | {{/box}} | ||
 |
1.1 | 4 | |
| |
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. |
| |
1.1 | 6 | |
 |
16.2 | 7 | {{warning}} |
| 8 | This feature doesn't replace a [[proper backup>>Backup]]. | ||
| 9 | {{/warning}} | ||
| |
16.1 | 10 | |
| |
33.1 | 11 | = Importing wiki pages = |
| |
1.3 | 12 | |
| |
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]]. |
 |
27.1 | 14 | |
| |
33.1 | 15 | = Exporting wiki pages = |
 |
8.1 | 16 | |
| |
1.4 | 17 | Prerequisites: |
| |
18.1 | 18 | |
 |
30.4 | 19 | * A configured database and Servlet Container. If you don't have them, see the [[Installation guide>>Documentation.AdminGuide.Installation]]. |
| |
1.4 | 20 | |
| |
16.2 | 21 | Follow these steps: |
| |
18.1 | 22 | |
| |
1.4 | 23 | * Ensure your database and container are started |
| |
18.1 | 24 | * Point your browser to ##http:~/~/localhost:8080/xwiki/bin/admin/XWiki/XWikiPreferences## |
| |
16.2 | 25 | * Click "Export" and fill the form |
| |
18.1 | 26 | * Click "Export"((( |
 |
24.1 | 27 | {{image reference="ExportPackageFlamingo.png"/}} |
| |
17.2 | 28 | ))) |
| |
18.1 | 29 | |
| |
11.4 | 30 | == Customizing a XAR == |
 |
1.7 | 31 | |
| |
30.4 | 32 | 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>>platform:Features.Exports||anchor="HXARExport"]]. |
| |
1.7 | 33 | |
| |
26.1 | 34 | 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: |
| |
18.1 | 35 | |
| |
1.8 | 36 | * Unzip the file |
| 37 | * Keep the pages you want to put in your archive | ||
| |
16.2 | 38 | * Edit ##package.xml## to delete the pages you do not want to be in the archive |
| 39 | * 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 | ||
| 40 | * You're done! You can now import this specific set of pages to any XWiki instance | ||
| |
1.9 | 41 | |
| |
13.2 | 42 | {{info}} |
| |
14.1 | 43 | 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]]. |
| |
13.2 | 44 | {{/info}} |
| |
26.1 | 45 | |
| |
26.2 | 46 | = XAR Format = |
| |
26.1 | 47 | |
| |
28.1 | 48 | See [[XAR Format specifications>>extensions:Extension.XAR Module Specifications]]. |
