Difference between revisions of "Manual:Extension/BlueSpiceUniversalExport"

{{DISPLAYTITLE:Export options}}
        
        
        
        '''BlueSpiceUniversalExport''' allows 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 [[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.
        
        
        
        
        <br />
        
        
        
        [[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 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 [[Manual:Extension/BlueSpiceBookmaker|BlueSpiceBookmaker]] is installed. It exports entire books in PDF format (available in the Book Manager).
        
        
        
        ==Configuration==
        
        
        
        Configuration of UniversalExport (and its modules) can be done in the [[Manual:Extension/BlueSpiceConfigManager|Config manager]] in the ''Export'' section. 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).
        
        
        
        [[File:UniversalExport2a.png|Configuration options|alt=Configuration options|center|650x650px|link=https://en.wiki.bluespice.com/wiki/File:UniversalExport2a.png|thumb]]<br />
        
        
        
        ==Tags==
        
        If the following tags are included in a page, they are applied both to the PDF book export and to the PDF single page export.
        
        
        
        ===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.
        
        
        
        ===PDF-specific styling===
        
        To style classes or IDs only in the PDF output, you can include the following tag at the beginning of a page:<syntaxhighlight lang="text">
        
        
        <bs:uemeta body-class=class-name-here/>
        
        
        </syntaxhighlight>
        
        
        
        
        
        Example''': Coloring the page background'''
        
        
        
        #Insert the tag  <code><nowiki><bs:uemeta body-class=bg-grey bg-yellow no-header-image no-footer-text/></nowiki></code> at the top of your wiki page.
        
        #To define the page background, add the following CSS to  <code>MediaWiki:Common.css</code> ein (admin rights needed):<syntaxhighlight lang="css">
        
        /*PDF output*/
        
        .bg-grey { background-color:#EDEDED !important;} /*sets the page background. There will be a white margin around it.*/
        
        .bg-yellow .bs-page-content { background-color:#F7F0C6; padding:10px;}  /*sets the background color for the content and adds padding*/
        
        .no-header-image #bs-runningheaderfix { background:none;} /*removes the PDF header*/
        
        .no-footer-text #bs-runningfooterleft, .no-footer-text #bs-runningfootercenter, .no-footer-text #bs-runningfooterright  { display:none;} /*removes the text from the PDF footer*/
        
        
        </syntaxhighlight>Compare the page before inserting the tag and after inserting the tag: <br />
        
        
        <gallery widths="250px" heights="400px">
        
        File:pdf-class-output-vorher.png
        
        File:pdf-class-output-nachher.png
        
        
        </gallery>
        
        
        
        {{Box Note|boxtype=important|Note text=The tag is only taken applied in the single page export (including linked pages and subpages). The tag from individual pages is ignored in the book export. The tag can, however, be inserted on the corresponding book page in the ''Book:'' namespace and is then applied to all pages in the book.}}<br />
        
        ==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]]
        
        |Topic2=[[Reference:BlueSpiceUEModulePDF]]
        
        |Topic3=[[Reference:BlueSpiceUEModuleBookPDF]]
        
        |Topic4=[[Reference:BlueSpiceUEModuleHTML]]
        
        |Topic5=[[Manual:Extension/BlueSpiceBookshelf|Creating books]]
        
        }}
        
        
        
        {{Translation}}
        
        
        
        [[Category:Page tools]]