Wiki source code of Export Content in XAR format
Last modified by superadmin on 2026/04/14 15:54
Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 1 | To [[export>>documentation.xs.admin.]] content in [[##XAR## format>>extensions:Extension.XAR Module Specifications]]: | ||
| 2 | |||
| 3 | 1. [[Administer your wiki>>xwiki:documentation.xs.admin.base.content-organization.administer-wiki.WebHome]]. | ||
| 4 | 1. Select "Content", and then select "Export" from the dropdown.((( | ||
| 5 | {{image reference="export-item.png" size="medium" alt="Content settings dropdown from the Administration user interface"/}} | ||
| 6 | ))) | ||
| 7 | 1. Select the Pages to export:((( | ||
| 8 | * Use the "all/none" to select/deselect, or use the box with the Tick icon.((( | ||
| 9 | {{image reference="[email protected]" size="large" alt="The None and All buttons in the Export modal"/}} | ||
| 10 | ))) | ||
| 11 | * If the Page/s you want to export include extension Pages, it is useful to use the "Select from" dropdown described in the [[Export modal>>documentation.xs.user.exports.export-page.modal.WebHome]] Page. | ||
| 12 | ))) | ||
| 13 | 1. Configure the following settings as needed. These additional settings for exporting ##XARs## are not available when [[exporting directly from viewing a Page>>documentation.xs.admin.exports.WebHome]].((( | ||
| 14 | {{image reference="additional-settings-export-xar.png" size="large" alt="Additional export settings for XARs"/}} | ||
| 15 | |||
| 16 | * "With history": You can include the [[Page history>>documentation.xs.user.base.page.view-page.view-history.history-tab.WebHome]] in the export. If not checked, only the [[latest version>>documentation.xs.user.base.page.view-page.view-history.major-minor-versions.WebHome]] of a Page is exported. | ||
| 17 | * "Target XWiki version": You can choose the [[version of XWiki>>dev:Community.VersioningAndReleasePractices.WebHome]] where you want then to [[import the Pages>>documentation.xs.admin.imports.WebHome]]: | ||
| 18 | ** If you're exporting content from XWiki ##12.0## or later and plan to import it into an older version (e.g., ##11.x##, ##10.x##, ##9.x##), selecting the "Below ##12.0##" option will ensure that [[attachment history>>Documentation.AdminGuide.Attachments||anchor="HVersions"]] is included in the export. Without selecting this option, the export will not be compatible with versions before ##12.0##, and the attachment history will be lost. | ||
| 19 | * "File name": Set a name for the ##XAR## file. | ||
| 20 | ))) | ||
| 21 | 1. Configure "More options" for exporting ##XARs##:((( | ||
| 22 | {{image reference="options-export-xar.png" size="large" alt="More options to configure exporting XARs"/}} | ||
| 23 | |||
| 24 | * "Description*: The package description that will be displayed when [[importing the package>>documentation.xs.admin.imports.WebHome]]. | ||
| 25 | * "Author": The [[author>>documentation.xs.user.base.page.authors-page.WebHome]] displayed when importing. | ||
| 26 | * "License": This refers to the content license applied to the package, which defines the terms under which the content can be used, modified, and distributed. Examples of licenses include LGPL, GPLv2, etc. | ||
| 27 | * "Version": This refers to the version of the package, which is stored in the package descriptor. It indicates the specific version of the package and helps track updates or changes made to it. | ||
| 28 | * "Backup package": This option ensures that the page author is preserved during the import process. It does not affect the exported content itself and can be modified before the import if needed. | ||
| 29 | ))) | ||
| 30 | 1. Click on "Export" to export in ##XAR## format, or exit the Page to discard. |
