Export multiple pages at once to PDF or XAR

Description

Author: XWiki SAS, sponsored by a customer

The XWiki MultiPage Export is an XWiki application that allows you to export multiple pages to PDF or XAR. It particularly allows you to create a list of pages to export and then run the export. You can automatically concatenate a page with its children, view it in HTML or export it to PDF in one big report. This is a very powerful application for exporting from your wiki and for creating reports.

You can search all pages within the Wiki by matching either the page title, name, content, or associated tags. When the search is complete and the required content is located you can check the boxes corresponding to the pages you wish to export. Clicking the ">>" button will add them to the "Selected pages".

After you have added more than one page to the "Selected pages" list you may change the page order by checking the box in front of the page and clicking the "Up" or "Down" buttons.

Having finished selecting the pages you can either save your list by clicking the "Save" button, or click directly on "Export". You will need to provide a "Package Name" and choose between the different export types:

• HTML
• PDF
• XAR with versions
• XAR without versions

Click "Export" and you're done.

Prerequisites & Installation Instructions

We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.

You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:

1. Log in the wiki with a user having Administration rights
2. Go to the Administration page and select the Import category
3. Follow the on-screen instructions to upload the downloaded XAR
4. Click on the uploaded XAR and follow the instructions
5. You'll also need to install all dependent Extensions that are not already installed in your wiki

• The MultiPageExport requires the xwiki-collection plugin to be installed:
  • For XWiki 2.0: xwiki-plugin-collection-1.1-xwiki20.jar
  • For XWiki 2.7: xwiki-plugin-collection-1.1-xwiki27.jar
  • For XWiki 3.1+: application-multipageexport-plugin-1.2.jar
• Add com.xpn.xwiki.plugin.collection.CollectionPlugin to the list of plugins in xwiki.cfg
• Import the XAR on your wiki
• Visit the MultiPageExport.Install page to finish the installation
• The following templates are needed in your xwiki/templates folder (validated for XWiki 2.7, 3.1 & 4.1):
  • printmulti.vm
  • pdfmulti.vm

Building

• Repository for the collection plugin: http://www.github.com/xwiki-contrib/xwiki-plugin-collection
• To build this plugin use Maven and copy the jar inside your webapps/xwiki/WEB-INF/lib folder
• Repository for the MultiPage Export XAR: http://www.github.com/xwiki-contrib/application-multipageexport
• To build this XAR use Maven
• After you have built the XAR import it in your wiki and visit MultiPageExport.Install to finish the installation

Release Notes

v1.2

This version is validated for XWiki 3.1 to 4.1.

To install:

• Copy application-multipageexport-plugin-1.2.jar to your WEB-INF/lib folder
• Edit xwiki.cfg and add the com.xpn.xwiki.plugin.collection.CollectionPlugin in the plugin configuration
• Add printmulti.vm & pdfmulti.vm to your xwiki/templates folder
• Import application-multipageexport-1.2.xar in your wiki
• Go to MultiPageExport.Install and follow the instructions

v1.1

Version validated for XWiki 2.7.

v1.0

Version validated for XWiki 2.0 to 2.2.