Revision as of 11:33, 20 July 2023

Extension: BlueSpiceUEModuleDOCX

Overview
Description:	Export function for a book including metadata and table of contents to DOCX
State:	stable	Dependency:	BlueSpice
Developer:	HalloWelt	License:	GPL-3.0-only
Type:	BlueSpice	Category:	Export
Edition:	BlueSpice free (deactivated), BlueSpice pro (deactivated), BlueSpice Farm (deactivated)"BlueSpice Farm (deactivated)" is not in the list (BlueSpice free, BlueSpice free (deactivated), BlueSpice pro, BlueSpice pro (deactivated), BlueSpice farm, BlueSpice farm (deactivated), BlueSpice cloud, BlueSpice cloud (deactivated)) of allowed values for the "BSExtensionInfoEdition" property.	Version:	4.1+
For more info, visit Mediawiki.

Features

UEModuleDOCX exports pages and books to the docx-format. This extension requires an external license.

This extension allows the output of a wiki page or book to Office Open XML. The content is inserted in a user-defined, freely selectable template. The conversion is done via an external tool, which is requires a license.

Conditions:
- If possible, the conversion should be based on HTML template.
- CSS / inline-styles should be supported. Here is the floating in pictures a bit critical.
- Running headers and footers are necessary.
- Images are embedded.
- Attachments are not possible.
- The template is a docx-file. The generated content from the wiki is inserted into the template at the place where the variable $WIKICONTENT$ is located.
- Meta information is stored in the docx-document (author, generator, etc).

Technical Information

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

Requirements

MediaWiki: 1.39.0

BlueSpiceFoundation: 4.3

BlueSpiceUniversalExport: 4.3

Integrates into

BlueSpiceUniversalExport

Special pages

Permissions

Name	Description	Role
uemoduledocx-export	⧼right-uemoduledocx-export⧽	reader
uemoduledocxsubpages-export	⧼right-uemoduledocxsubpages-export⧽	reader

Configuration

Name	Value
UEModuleDOCXDOCXServiceSecret	'$1$DP0.QV2.$BPGuGZOMuWwuc5DlGI1lK/'
UEModuleDOCXDOCXServiceURL	'http://localhost/BShtml2DOCX'
UEModuleDOCXDefaultTemplate	'BlueSpice.docx'
UEModuleDOCXSuppressNS	false
UEModuleDOCXTemplatePath	'extensions/BlueSpiceUEModuleDOCX/data/templates'

Hooks

BSMigrateSettingsFromDeviatingNames

@@ Line 1: / Line 1: @@
-{{BSExtensionInfobox
+{{BSExtensionInfo
 |desc=This extension outputs a wiki page to Office Open XML.
 |status=stable
@@ Line 9: / Line 9: @@
 |license=GPL v3 only
 |docu=https://www.mediawiki.org/wiki/Extension:UEModuleDOCX
-}}
+|features='''UEModuleDOCX''' exports pages and books to the docx-format. This extension requires an [https://www.phpdocx.com/features external license].
-'''UEModuleDOCX''' exports pages and books to the docx-format. This extension requires an [https://www.phpdocx.com/features external license].
 This extension allows the output of a wiki page or book to [http://en.wikipedia.org/wiki/Office_Open_XML Office Open XML]. The content is inserted in a user-defined, freely selectable template. The conversion is done via an external tool, which is requires a [https://www.phpdocx.com/features license].
@@ Line 22: / Line 21: @@
 **The template is a docx-file. The generated content from the wiki is inserted into the template at the place where the variable <code>$WIKICONTENT$</code> is located.
 **Meta information is stored in the docx-document (author, generator, etc).
+}}

Reference:BlueSpiceUEModuleDOCX: Difference between revisions