Latest revision as of 17:24, 9 August 2022

Extension: BlueSpiceUEModulePDF

Overview
Description:	Enables MediaWiki to export pages into PDF format
State:	stable	Dependency:	BlueSpice
Developer:	HalloWelt	License:	GPL-3.0-only
Type:	BlueSpice	Category:	Export
Edition:	BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud	Version:	4.1+

Features

BlueSpiceUEModulePDF enables the output of a wiki page as Adobe Portable Document Format (PDF).

The user chooses an export function in the widget bar:

Single page
Single page with linked pages
Single page with subpages

Administrators can change the following setting in the Configuration manager, under Function>Export or Extension>BlueSpiceUEModulePDF. Here wiki administrators can configure:

Hide namespace prefix in PDF: The namespace is not shown for page titles in the PDF.

The wiki page can be printed to PDF in landscape format by adding the following tag anywhere in source view:

<bs:ueparams template="BlueSpice_Landscape" />

Technical Information

This information applies to BlueSpice 4. Technical details for BlueSpice Cloud can differ in some cases.

Requirements

MediaWiki: 1.36.0

BlueSpiceFoundation: 4.1

BlueSpiceUniversalExport: 4.1

Integrates into

BlueSpiceUEModulePDF
BlueSpiceUniversalExport

Special pages

Permissions

Name	Description	Role
uemodulepdf-export	Export a page to PDF	reader
uemodulepdfrecursive-export	Export a page, including all linked pages, to PDF	reader
uemodulepdfsubpages-export	Export a page, including all sub pages, to PDF	reader

Configuration

Name	Value
UEModulePDFAllowPartialExport	false
UEModulePDFDefaultTemplate	'BlueSpice'
UEModulePDFExportDialogExcludeTemplates	array ( )
UEModulePDFFileResolver	'standard-resolver'
UEModulePDFPdfServiceURL	'http://127.0.0.1:8080/BShtml2PDF'
UEModulePDFSuppressNS	false
UEModulePDFTemplatePath	'extensions/BlueSpiceUEModulePDF/data/PDFTemplates'

Hooks

Accessibility

Test status:	2-testing complete
Checked for:	Web
Last test date:	2022-08-09
WCAG level:	AA
WCAG support:	does not support (workaround: no)
Comments:	fails most PAC3 checks.
Extension type:	export
Extension focus:	reader

To submit feedback about this documentation, visit our community forum.

@@ Line 1: / Line 1: @@
-<div class="wcaginfo">
+{{BSExtensionInfo
-==Evaluated extensions ({{#ask: [[wcagStatus::+]][[extensionType::!backend]]|format=count}})==
+|status=stable
-===Reader: core ({{#ask: [[Reference:+]][[Modification date::+]][[wcagStatus::+]][[extensionFocus::reader]][[extensionType::core]]|format=count}})===
+|developer=HalloWelt
-{{wcagResults|reader|core}}
+|type=BlueSpice
+|edition=BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud
+|compatible=BlueSpice
+|category=Export
+|features='''BlueSpiceUEModulePDF''' enables the output of a wiki page as Adobe Portable Document Format (PDF).
-===Reader: extended ({{#ask: [[Reference:+]][[Modification date::+]][[wcagStatus::+]][[extensionFocus::reader]][[extensionType::extended]]|format=count}})===
+The user chooses an export function in the widget bar:
-{{wcagResults|reader|extended}}
-===Editor: core ({{#ask: [[Reference:+]][[Modification date::+]][[wcagStatus::+]][[extensionFocus::editor]][[extensionType::core]]|format=count}})===
+*Single page
-{{wcagResults|editor|core}}
+*Single page with linked pages
+*Single page with subpages
-===Editor: extended ({{#ask: [[Reference:+]][[Modification date::+]][[wcagStatus::+]][[extensionFocus::editor]][[extensionType::extended]]|format=count}})===
+Administrators can change the following setting in the [[Reference:BlueSpiceConfigManager{{!}}Configuration manager]], under Function>Export or Extension>BlueSpiceUEModulePDF. Here wiki administrators can configure:
-{{wcagResults|editor|extended}}
-===Organizer / maintainer: core ({{#ask: [[Reference:+]][[Modification date::+]][[wcagStatus::+]][[extensionFocus::organizer]][[extensionType::core]]|format=count}})===
+*''Hide namespace prefix in PDF'': The namespace is not shown for page titles in the PDF.
-{{wcagResults|organizer|core}}
-===Organizer / maintainer: extended ({{#ask: [[Reference:+]][[Modification date::+]][[wcagStatus::+]][[extensionFocus::organizer]][[extensionType::extended]]|format=count}})===
+The wiki page can be printed to PDF in landscape format by adding the following tag anywhere in  source view:
-{{wcagResults|organizer|extended}}
+ <nowiki><bs:ueparams template="BlueSpice_Landscape" /></nowiki>
+|desc=Enables the output as Adobe Portable Document Format (PDF).
-===Admin core ({{#ask: [[Reference:+]][[Modification date::+]][[wcagStatus::+]][[extensionFocus::admin]][[extensionType::core]]|format=count}})===
-{{wcagResults|admin|core}}
-===Admin: extended ({{#ask: [[Reference:+]][[Modification date::+]][[wcagStatus::+]][[extensionFocus::admin]][[extensionType::extended]]|format=count}})===
-{{wcagResults|admin|extended}}
-===Export({{#ask: [[Reference:+]][[Modification date::+]][[wcagStatus::+]][[extensionType::export]]|format=count}})===
-Exported PDFs currently do not meet accessibility criteria.
-{{#ask: [[Reference:+]][[Modification date::+]][[extensionType::export]]
-|?wcagSupport
-|?wcagWorkaround
-|format=list
-|introtemplate=wcagListIntro
-|template=wcagList
-|outrotemplate=wcagListOutro
 }}
+{{wcagCheck
-==Excluded extensions ({{#ask: [[extensionType::backend]]|format=count}})==
+|wcagStatus=2-testing complete
-The following extensions have no corresponding functionality in the user interface and are therefore considered as "not applicable":
+|wcagCheckedfor=Web
-{{#ask: [[Reference:+]][[Modification date::+]][[extensionType::backend]]
+|wcagTestdate=2022-08-09
-|?wcagSupport
+|wcagLevel=AA
-|?wcagWorkaround
+|wcagSupport=does not support
-|format=list
+|wcagWorkaround=no
-|introtemplate=wcagListIntro
+|wcagComments=fails most PAC3 checks.
-|template=wcagList
+|extensionType=export
-|outrotemplate=wcagListOutro
+|extensionFocus=reader
 }}
-</div>
-[[Category:Accessibility]]

Accessibility/Extensions and Reference:BlueSpiceUEModulePDF: Difference between pages