Difference between revisions of "Manual:Extension/BlueSpiceUniversalExport"

[unchecked revision]

[quality revision]

Revision as of 10:59, 12 December 2019 (view source)

P technik (talk | contribs)

(Tag: 2017 source edit)

← Older edit

Revision as of 12:33, 29 April 2020 (view source)

Mlink-rodrigue (talk | contribs)

(Reworked content and added info from Ticket 18830)

(Tag: Visual edit)

Newer edit →

Exporting pagesThe export menu[edit | edit source]

Every content page on the wiki is exportablecan be exported. 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 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 provided options will download links downloads the page content in the selected format.

Export options

Modules[edit | edit source]

As mentined above, The extension BlueSpiceUniversalExport contains several modules:

BlueSpiceUEModulePDF - : module for exporting pages in PDF (.pdf) format. It offers downloading single page that is currently being viewed (option downloads the current page (PDF single page), or the current page including all its subpages (option 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 in HTML format as an html zip-archive (option HTML single page).
BlueSpiceUEModuleBookPDF - : module for exporting books. This module is only availble if BlueSpiceBookmaker is installed. It provides exporting exports entire books in PDF format (available from BookManagerin the Book Manager).

Configuration[edit | edit source]

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

Configuration options

Landscape printing[edit | edit source]

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.

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.

These css classes also work for the book export.

Printing[edit | edit source]

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

Related info

        __TOC__
        
        
        
        
        ==What is BlueSpiceUniversalExport?==
            
            
        '''BlueSpiceUniversalExport''' allows for exporting wiki page content pages to various formats. It incorporates various modules, each serving as exporter for a particular format or export type of export.
            
            
            
            ==Exporting pages==
            
            [[File:UniversalExport1a.png|Export options|alt=Export options|border|center|650x650px]]
            
            
        .
            
            
            
            ==The export menu==
            
            
        Every content page on the wiki is exportablecan be exported. 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 thefuctions are located in the general [[Manual:BlueSpice Layout#Page tools|page tools]] under the menu item ''Export''. The available export options depend on your wiki configuration. Clicking one of the provided options will download links downloads the page content in the selected format.
            
            
            
            ==Modules==
            
            As mentined above, BlueSpiceUniversalExport contains several modules:
            
            
            
            *BlueSpiceUEModulePDF - [[File:UniversalExport1a.png|Export options|alt=Export options|center|650x650px|link=https://en.wiki.bluespice.com/wiki/File:UniversalExport1a.png|thumb]]
            
            ==Modules==
            
            The extension ''BlueSpiceUniversalExport'' contains several modules:
            
            
            
            *'''BlueSpiceUEModulePDF:''' module for exporting pages in PDF (.pdf) format. It offers downloading singledownloads the current page that is currently being viewed (option PDF single page), or(PDF single page), the current page including all its subpages (option PDF page with subpages).
            
            *BlueSpiceUEModuleHTML - , or the current page and the pages that are linked from that page (PDF page with linked pages).
            
            *'''BlueSpiceUEModuleHTML:''' module for exporting pages in HTML format as an html zip-archive (option HTML single page)
            
            *BlueSpiceUEModuleBookPDF - .
            
            *'''BlueSpiceUEModuleBookPDF:''' module for exporting books. This module is only availble if [[Manual:Extension/BlueSpiceBookmaker|BlueSpiceBookmaker]] is installed. It provides exporting exports entire books in PDF format (available from BookManager).
            
            
            
            
            
            ==Configuration==
            
            
            
            
            
            [[File:UniversalExport2a.png|Configuration options|alt=Configuration options|border|center|650x650px]]
            
            Configuration in the Book Manager).
            
            
            
            ==Configuration==
            
            
            
            
            
            
            
            Configuration of BlueSpiceUniversalExport (and its modules) can be done using [[Manual:Extension/BlueSpiceConfigManager|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 contents:'''  only applies to exporting books. Select how the ToC should be constructed (as a ToC for the entire book or byfor each page individualy)
            
            *individually).
            
            *'''Hide namespace prefix in HTML - should namespace prefixes be shown :''' removes namespace prefixes when displaying page titles in HTML exports.
        
        *'''Hide namespace prefix in PDF - should namespace prefixes be shown :''' 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).
        
        
        
        
        ==Printing from Export menu==
            
            MediaWiki by default provides [[File:UniversalExport2a.png|Configuration options|alt=Configuration options|center|650x650px|link=https://en.wiki.bluespice.com/wiki/File:UniversalExport2a.png|thumb]]
            
            ==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:
            
             <nowiki><bs:ueparams template="BlueSpice_Landscape" /></nowiki>
            
            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, <code><nowiki>{{LandscapeFormatExport}}</nowiki></code>. The element can be inserted anywhere on the page.{{Box Note|boxtype=note|Note text=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:
            
             <nowiki><div class="bs-rotated bs-ultrawide">...</div></nowiki>
            
            The start and end div tags can also be added to templates (e.g., <code><nowiki>{{LandscapeStart}}</nowiki></code> and <code><nowiki>{{LandscapeEnd}}</nowiki></code>) to allow users to insert the tags using the visual editor.{{Box Note|boxtype=note|Note text=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 availble from "Export" menu (option "Print"available in the ''Export'' menu (option ''Print'').
        
        
        
        {{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceUniversalExport}}
        
        
        
        {{Box Links-en|Topic1=[[Reference:BlueSpiceUniversalExport]]
            
            |Topic2=[[Reference:BlueSpiceUEModulePDF]]
            
            |Topic3=[[Reference:BlueSpiceUEModuleBookPDF]]
            
            |Topic4=[[Reference:BlueSpiceUEModuleHTML]]
            
            
        }}
        
        
        
        {{Translation}}

@@ Line 2: / Line 2: @@
 __TOC__
-==What is BlueSpiceUniversalExport?==
+'''BlueSpiceUniversalExport''' allows for exporting wiki pages to various formats. It incorporates various modules, each serving as exporter for a particular export type.
-'''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==
-[[File:UniversalExport1a.png|Export options|alt=Export options|border|center|650x650px]]
-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.
+==The export menu==
+Every content page on the wiki can be exported. Export fuctions are located in the general [[Manual:BlueSpice Layout#Page tools|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.[[File:UniversalExport1a.png|Export options|alt=Export options|center|650x650px|link=https://en.wiki.bluespice.com/wiki/File:UniversalExport1a.png|thumb]]
 ==Modules==
-As mentined above, BlueSpiceUniversalExport contains several modules:
+The extension ''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).
+*'''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 in HTML format (option HTML single page)
+*'''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 [[Manual:Extension/BlueSpiceBookmaker|BlueSpiceBookmaker]] is installed. It provides exporting entire books in PDF format (available from BookManager).
+*'''BlueSpiceUEModuleBookPDF:''' module for exporting books. This module is only availble if [[Manual:Extension/BlueSpiceBookmaker|BlueSpiceBookmaker]] is installed. It exports entire books in PDF format (available in the Book Manager).
+==Configuration==
-==Configuration==
-[[File:UniversalExport2a.png|Configuration options|alt=Configuration options|border|center|650x650px]]
 Configuration of BlueSpiceUniversalExport (and its modules) can be done using [[Manual:Extension/BlueSpiceConfigManager|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)
+*'''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 - should namespace prefixes be shown when displaying page titles in HTML exports.
+*'''Hide namespace prefix in HTML:''' removes namespace prefixes when displaying page titles in HTML exports.
-*Hide namespace prefix in PDF - should namespace prefixes be shown when displaying page titles in PDF 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 (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).
+*'''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).
+[[File:UniversalExport2a.png|Configuration options|alt=Configuration options|center|650x650px|link=https://en.wiki.bluespice.com/wiki/File:UniversalExport2a.png|thumb]]
+==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:
+ <nowiki><bs:ueparams template="BlueSpice_Landscape" /></nowiki>
+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, <code><nowiki>{{LandscapeFormatExport}}</nowiki></code>. The element can be inserted anywhere on the page.{{Box Note|boxtype=note|Note text=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
-==Printing from Export menu==
+These classes can also be combined. Example:
-MediaWiki by default provides print view for the pages. This is also availble from "Export" menu (option "Print").
+ <nowiki><div class="bs-rotated bs-ultrawide">...</div></nowiki>
+The start and end div tags can also be added to templates (e.g., <code><nowiki>{{LandscapeStart}}</nowiki></code> and <code><nowiki>{{LandscapeEnd}}</nowiki></code>) to allow users to insert the tags using the visual editor.{{Box Note|boxtype=note|Note text=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'').
 {{#dpl:title=Manual:Extension/BlueSpiceConfigManager|include=#BlueSpiceUniversalExport}}
-{{Box Links-en|Topic1=[[Reference:BlueSpiceUniversalExport]]}}
+{{Box Links-en|Topic1=[[Reference:BlueSpiceUniversalExport]]
+|Topic2=[[Reference:BlueSpiceUEModulePDF]]
+|Topic3=[[Reference:BlueSpiceUEModuleBookPDF]]
+|Topic4=[[Reference:BlueSpiceUEModuleHTML]]
+}}
 {{Translation}}

User

Wiki

Participate

Topics

Documentation

General Books

Difference between revisions of "Manual:Extension/BlueSpiceUniversalExport"

Contents

Exporting pagesThe export menu[edit | edit source]

Modules[edit | edit source]

Configuration[edit | edit source]

Landscape printing[edit | edit source]

Printing[edit | edit source]

Related info

Manage page

Associated links

Export

Toolbox

QR code

Mode

Page information

Page assignments

Approval

Difference between revisions of "Manual:Extension/BlueSpiceUniversalExport"

Contents

Exporting pagesThe export menu[edit | edit source]

Modules[edit | edit source]

Configuration[edit | edit source]

Landscape printing[edit | edit source]

Printing[edit | edit source]

Related info

Attachments

Discussions