Manual:Extension/BlueSpiceUniversalExport

What is UniversalExportBlueSpiceUniversalExport?

UniversalExport enables the single page export to PDF.

Where to find UniversalExport?

BlueSpiceUniversalExport allows for exporting wiki page content to various formats. It incorporates various modules, each serving as exporter for particular format or type of export.

Exporting pages

UniversalExport provides also a widget (UNIVERSALEXPORT ) called "Export", which includes links to various export modules. Which modules are displayed depends on the settings of the respective modules and on the permissions of universalexport-export. Access to an export module can also be granted and withheld depending on namespaces.

The functionality of UniversalExport

Export options

Every content page on the wiki is exportable. Export fuction can be found in the right navigation, under "Tools" tab (wrench icon). In "Export" section of this tab, all availble export formats can be found. Particular set of formats available depends on the wiki configuration. Clicking one of the provided options will download the page content in selected format.

Modules

Information on the special page

The export modules installed and their status can be viewed at Special:UniversalExport. The information displayed depends on the individual modules.

Settings

UniversalExport and the individual modules can be configured under "WikiAdmi > Preferences".

Configuration variables

Following settings can be configured for UniversalExport and its submodules

Universal Export

Setting	Description
Metadata (standard, JSON format)	Additional metadata to include in the template in JSON format, for example: {"creator":"Hallo Welt! Medienwerkstatt GmbH"}. This data can later be accessed from the template
Metadaten (overriding, JSON format)	Metadata values to override existing metadata keys

UniversalExport PDF module

Setting	Description
Standard template	Default template to use for exporting to PDF
Backend URL	URL to bshtml2pdf service
Hide namespace prefix in PDF	Whether to hide namespace part of page name when exporting to PDF
Template directory	Directory path to where PDF templates are located

UniversalExport Book PDF Module

As mentined above, BlueSpiceUniversalExport contains several modules:

• BlueSpiceUEModulePDF - module for exporting pages in PDF (.pdf) format. It offers downloading single page that is currently being viewed (option PDF single page), or current page including all its subpages (option PDF page with subpages).
• BlueSpiceUEModuleHTML - module for exporting pages in HTML format (option HTML single page)
• BlueSpiceUEModuleBookPDF - module for exporting books. This module is only availble if BlueSpiceBookmaker is installed. It provides exporting entire books in PDF format (available from BookManager).

Settings

Setting

Description

Configuration options

Table of Contents

How should TOC appear in the book. This setting has following settings:

• Only article titles (indent by page)

• Enbed article TOCs (no indent of article titles

Standard template

Default template to use for exporting to PDF

Template directory

Directory path to where PDF templates are located

UniversalExport HTML Module

Setting	Description
Hide namespace prefix in HTML	Whether to hide namespace prefix of pages when exporting to HTML
Path to templates	Directory path to where HTML templates are located

Tips for working with UniversalExport

• Shoutbox comments are not included when a page is exported.

Classical export with MediaWiki

Configuration of BlueSpiceUniversalExport (and its modules) can be done using BlueSpiceConfigManager. BlueSpiceUniversalExport and each of the modules provide separate entries in list of extensions. Available settings include:

• Table of content - provided by BlueSpiceUEModuleBookPDF export and therefore only applies to exporting books. Select how ToC should be constructed (as a ToC for the entire book or by each page individualy)
• Hide namespace prefix in HTML - should namespace prefixes be shown when displaying page titles in HTML exports.
• Hide namespace prefix in PDF - should namespace prefixes be shown when displaying page titles in PDF exports.
• Metadata (standard, JSON) - additional data to be passed to the rendering template in JSON format. This data will be avalible for usage in the template (advanced users).
• Metadata (override, JSON) - offers overriding standard data sent to the rendering template. Values that are set by default can be overriden by using this option (JSON format) (advanced users).

Printing from Export menu

MediaWiki itself only offers the export of content pages in a proprietary XML format. There are, however, extensions which make the creation of ODF, PDF or DocBook files possibleby default provides print view for the pages. This is also availble from "Export" menu (option "Print").

See also

Our reference Reference page for this extension.