Difference between revisions of "Reference:BlueSpiceUEModulePDF"

(Tag: 2017 source edit)
 

Extension: BlueSpiceUEModulePDF


Overview
Description: enables the output as Adobe Portable Document Format (PDF). Enables MediaWiki to export pages into PDF format
State: stable Dependency: BlueSpice
Developer: HalloWelt License:

GPL

v3 only

-3.0-onlyProperty "BSExtensionInfoLicense" (as page type) with input value "</br>GPL-3.0-only" contains invalid characters or is incomplete and therefore can cause unexpected results during a query or annotation process.

Type: BlueSpice Category: Export
Edition: BlueSpice "BlueSpice" is not in the list (BlueSpice pro, BlueSpice free, BlueSpice Farm, BlueSpice Cloud, BlueSpice free (deactivated), BlueSpice pro (deactivated), BlueSpice Farm (deactivated), BlueSpice Cloud (deactivated)) of allowed values for the "BSExtensionInfoEdition" property.

Features

[edit source]1 Extension:

Contents

BlueSpiceUEModulePDF

Description[edit | edit source]

UEModulePDF module for UniversalExport

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

Usage / Features[edit | edit source]

The user chooses an export function in the widget bar:

  • Single page
with attachments.
  • Single page with linked pages
  • Single page
without attachments.

Technical information[edit | edit source]

Configuration[edit | edit source]

Some aspects of this extension can be configured on Special:BlueSpicePreferences, under section "Universal export PDF module"Whether to hide
  • with subpages

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

  • Default template used
  • Backend URL
    • Hide namespace prefix in PDF
  • Template directory (physical path to the directory holding the templates)
  • Rights (permissions)[edit | edit source]

    This extension does not require any special rights.

    Requirements[edit | edit source]

    UEModulePDF requires BlueSpiceFoundation and UniversalExport.

    User manual[edit | edit source]

    UEModulePDF enables the output as Adobe Portable Document Format (PDF). Read more on UniversalExport.

    Try free our BlueSpice[edit | edit source]

    BlueSpiceDemo.
    • : 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[edit source]

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

    Requirements[edit source]

    • MediaWiki: 1.31
    • BlueSpiceFoundation: 3.2

    BlueSpiceUniversalExport: 3.2

    Integrates into[edit source]

    • BlueSpiceUniversalExport

    Special pages[edit source]

    Permissions[edit source]

    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[edit source]

    Name Value
    UEModulePDFAllowPartialExport false
    UEModulePDFDefaultTemplate 'BlueSpice'
    UEModulePDFPdfServiceURL 'http://127.0.0.1:8080/BShtml2PDF'
    UEModulePDFSuppressNS false
    UEModulePDFTemplatePath 'extensions/BlueSpiceUEModulePDF/data/PDFTemplates'

    Hooks[edit source]

    {{BSExtensionInfoboxBSExtensionInfo
            
            |desc=enablesEnables the output as Adobe Portable Document Format (PDF).
            
            |status=stable
            
            |developer=HalloWelt
            
            |type=BlueSpice
            
            |edition=BlueSpice |active=Yes
                
                
            free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud
                
                
            |compatible=BlueSpice
            
            |category=Export
            
            |license=GPL v3 only
                
                |docu=https://www.mediawiki.org/wiki/Extension%CB%90UniversalExport/UEModulePDF
                
                }}
                
                __TOC__
                
                
                
                ==Description==
                
                
                
                '''UEModulePDF''' module for UniversalExport enables the output features='''BlueSpiceUEModulePDF''' enables the output of a wiki page as Adobe Portable Document Format (PDF).
            
            
            
            
            ==Usage / Features==
                
                
                
                
            The user chooses an export function in the widget bar:
            
            
            
            * Single page
            
            
            with attachments.
                
                * Single page without attachments.
                
                
                
                == Technical information==
                
                
                
                ===Configuration===
                
                Some aspects of this extension can be configured on Special:BlueSpicePreferences, under section "Universal export PDF module"*Single page with linked pages
                
                *Single page with subpages
                
                
                
                Administrators can change the following setting in the [[Reference:BlueSpiceConfigManager|Configuration manager]], under Function>Export or Extension>BlueSpiceUEModulePDF. Here wiki administrators can configure: 
            
            
            
            * Default template used
                
                * Backend URL
                
                * Whether to hide ''Hide namespace prefix in PDF
                
                * Template directory (physical path to the directory holding the templates)
                
                
                
                ===Rights (permissions)===
                
                This extension does not require any special rights. 
                
                
                
                ===Requirements===
                
                
                
                UEModulePDF requires [[BlueSpiceFoundation]] and [[UniversalExport]].
                
                
                
                ==User manual==
                
                
                
                UEModulePDF enables the output as Adobe Portable Document Format (PDF). Read more on [[UniversalExport]].
                
                
                
                ==Try free our BlueSpice==
                
                
                
                [https://en.demo.bluespice.com/wiki/Main_Page BlueSpiceDemo.]
                
                
                
                
                
                [[de:{{FULLPAGENAME}}]][[en:{{FULLPAGENAME}}]]
                
                
                
                [[Category:Extension]]'': 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:
                
                 <nowiki><bs:ueparams template="BlueSpice_Landscape" /></nowiki>
                
                
                
                }}
    (18 intermediate revisions by 4 users not shown)
    Line 1: Line 1:
    {{BSExtensionInfobox
    +
    {{BSExtensionInfo
    |desc=enables the output as Adobe Portable Document Format (PDF).
    +
    |desc=Enables the output as Adobe Portable Document Format (PDF).
     
    |status=stable
     
    |status=stable
     
    |developer=HalloWelt
     
    |developer=HalloWelt
     
    |type=BlueSpice
     
    |type=BlueSpice
    |edition=BlueSpice
    +
    |edition=BlueSpice free, BlueSpice pro, BlueSpice Farm, BlueSpice Cloud
    |active=Yes
     
     
    |compatible=BlueSpice
     
    |compatible=BlueSpice
     
    |category=Export
     
    |category=Export
    |license=GPL v3 only
    +
    |features='''BlueSpiceUEModulePDF''' enables the output of a wiki page as Adobe Portable Document Format (PDF).
    |docu=https://www.mediawiki.org/wiki/Extension%CB%90UniversalExport/UEModulePDF
     
    }}
     
    __TOC__
     
     
     
    ==Description==
     
     
     
    '''UEModulePDF''' module for UniversalExport enables the output as Adobe Portable Document Format (PDF).
     
     
     
    ==Usage / Features==
     
      
     
    The user chooses an export function in the widget bar:
     
    The user chooses an export function in the widget bar:
      
    * Single page with attachments.
    +
    *Single page
    * Single page without attachments.
    +
    *Single page with linked pages
     +
    *Single page with subpages
      
    == Technical information==
    +
    Administrators can change the following setting in the [[Reference:BlueSpiceConfigManager|Configuration manager]], under Function>Export or Extension>BlueSpiceUEModulePDF. Here wiki administrators can configure:
      
    ===Configuration===
    +
    *''Hide namespace prefix in PDF'': The namespace is not shown for page titles in the PDF.
    Some aspects of this extension can be configured on Special:BlueSpicePreferences, under section "Universal export PDF module". Here wiki administrators can configure:
     
      
    * Default template used
    +
    The wiki page can be printed to PDF in landscape format by adding the following tag anywhere in  source view:
    * Backend URL
    +
    <nowiki><bs:ueparams template="BlueSpice_Landscape" /></nowiki>
    * Whether to hide namespace prefix in PDF
     
    * Template directory (physical path to the directory holding the templates)
     
      
    ===Rights (permissions)===
    +
    }}
    This extension does not require any special rights.
     
     
     
    ===Requirements===
     
     
     
    UEModulePDF requires [[BlueSpiceFoundation]] and [[UniversalExport]].
     
     
     
    ==User manual==
     
     
     
    UEModulePDF enables the output as Adobe Portable Document Format (PDF). Read more on [[UniversalExport]].
     
     
     
    ==Try free our BlueSpice==
     
     
     
    [https://en.demo.bluespice.com/wiki/Main_Page BlueSpiceDemo.]
     
     
     
     
     
    [[de:{{FULLPAGENAME}}]][[en:{{FULLPAGENAME}}]]
     
     
     
    [[Category:Extension]]
     

    Attachments

    Discussions