No categories assigned

BlueSpiceUniversalExport

< Manual:Extension(Redirected from Manual:Extension/UniversalExport)

BlueSpiceUniversalExport allows for exporting wiki pages to various formats. It incorporates various modules, each serving as exporter for a particular export type.

The export menu

Every content page on the wiki can be exported. Export fuctions are located in the general page tools under the menu item Export. The available export options depend on your wiki configuration. Clicking one of the links downloads the page content in the selected format.

Export options
Export options

Modules

The extension BlueSpiceUniversalExport contains several modules:

  • BlueSpiceUEModulePDF: module for exporting pages in PDF (.pdf) format. It downloads the current page (PDF single page), the current page including all its subpages (PDF page with subpages), or the current page and the pages that are linked from that page (PDF page with linked pages).
  • BlueSpiceUEModuleHTML: module for exporting pages as an html zip-archive (option HTML single page).
  • BlueSpiceUEModuleBookPDF: module for exporting books. This module is only availble if BlueSpiceBookmaker is installed. It exports entire books in PDF format (available in the Book Manager).

Configuration

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 contents: only applies to exporting books. Select how the ToC should be constructed (as a ToC for the entire book or for each page individually).
  • Hide namespace prefix in HTML: removes namespace prefixes when displaying page titles in HTML exports.
  • Hide namespace prefix in PDF: removes namespace prefixes 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).
Configuration options
Configuration options

Landscape printing

To print a PDF page in landscape format, the following tag can be inserted in the wiki page in source editing mode at any position:

<bs:ueparams template="BlueSpice_Landscape" />

To make it easier for the user to add this tag with the visual editor, this tag can be added to a wikitext-template, for example, {{LandscapeFormatExport}}. The element can be inserted anywhere on the page.

Note: This tag only works for the PDF single page export.

Within a wiki page, individual areas can be marked separately (e.g. wide tables). This way, the output in the export can be landscape or extra-wide. This is possible using the following css classes:

  • "bs-rotated" -> landscape format
  • "bs-narrow" -> 0,33 x A4 portrait
  • "bs-ultrawide" -> 2 x A4 landscape

These classes can also be combined. Example:

<div class="bs-rotated bs-ultrawide">...</div>

The start and end div tags can also be added to templates (e.g., {{LandscapeStart}} and {{LandscapeEnd}}) to allow users to insert the tags using the visual editor.

Note: Display of header and footer areas could be problematic when using these tags.

These css classes also work for the book export.

Printing

MediaWiki, by default, provides a print view for the pages. This command is also available in the Export menu (option Print).


Related info

Attachments

Discussions