Difference between revisions of "Reference:BlueSpiceUEModuleBookPDF"

m
(Tag: 2017 source edit)
BlueSpiceUEModuleBookPDF
export books to PDF format.
Status: stable
Developer: HalloWelt
Extension type: BlueSpice
Edition: BlueSpice pro
Dependencies: BlueSpice
License: GPL v3 only
Activated: Yes
Category: Book

Description[edit | edit source]

UEModuleBookPDF export books to PDF format.

Usage / Features[edit | edit source]

  • Creates a PDF book based on the data from the Universal Export.
  • Underlying is an HTML / PHP template, which is also customizable by the user.
  • Metadata is embedded in the PDF.
  • Numbering of chapters and the table of contents is generated.
  • Files are attached.
  • The pages of the PDF Book are printed on the model of the PDF single pages.
  • When exporting a title page and a table of contents should be generated.
    • The cover sheet contains company logo and date of creation and is freely designable.
    • The table of contents is generated automatically, is clickable and allows the direct jump to the desired position within the document.
  • In addition, a summary of the changes under the term "last changes" will appear. It contains the relevant changes (ie not minor changes in the system) of the articles within the last two years. If required, the date (format: dd.mm.yyyy, sort order descending), article name and change note of the released statuses should appear.
  • References to uploaded documents are included in the PDF book as an attachment ("merge" in the sense of readable articles and non-attachment). Footnotes from wiki articles should be placed at the end of the PDF page and should not appear at the end of the article.
  • Breakthroughs of text, tables and images are intelligent to implement (not a single line of a new paragraph as the last line of a page, on the following page continuous tables get the table header again, images are only on one page to represent).
  • As the chapter numbering is shown in the header, a page break is required when changing to another chapter.
  • Hyperlinks are clickable and refer to the desired position within the document (also applies to attachments), external links are included in the pdf as a hyperlink.
UE1.PNG

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". Here wiki administrators can configure:

  • How Table of content should be shown.
  • Default template.
  • 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]

UEModuleBookPDF requires BlueSpiceFoundation and UniversalExport.

User manual[edit | edit source]

UEModuleBookPDF is a module that allows export to PDF format. Read more on UniversalExport.

Try free our BlueSpice[edit | edit source]

BlueSpiceDemo.

{{BSExtensionInfobox
        
        |desc=export books to PDF format.
        
        |status=stable
        
        |developer=HalloWelt
        
        |type=BlueSpice
        
        |edition=BlueSpice pro
        
        |active=Yes
        
        |compatible=BlueSpice
        
        |category=Book
        
        |license=GPL v3 only
        
        |package=Bookmaker
        
        }}
        
        __TOC__
        

        ==Description==
        

        '''UEModuleBookPDF''' export books to PDF format.
        

        ==Usage / Features==
        

        * Creates a PDF book based on the data from the Universal Export.
        
        * Underlying is an HTML / PHP template, which is also customizable by the user.
        
        * Metadata is embedded in the PDF.
        
        * Numbering of chapters and the table of contents is generated.
        
        * Files are attached.
        
        * The pages of the PDF Book are printed on the model of the PDF single pages.
        
        * When exporting a title page and a table of contents should be generated.
        
        ** The cover sheet contains company logo and date of creation and is freely designable.
        
        ** The table of contents is generated automatically, is clickable and allows the direct jump to the desired position within the document.
        
        * In addition, a summary of the changes under the term "last changes" will appear. It contains the relevant changes (ie not minor changes in the system) of the articles within the last two years. If required, the date (format: dd.mm.yyyy, sort order descending), article name and change note of the released statuses should appear.
        
        * References to uploaded documents are included in the PDF book as an attachment ("merge" in the sense of readable articles and non-attachment). Footnotes from wiki articles should be placed at the end of the PDF page and should not appear at the end of the article.
        
        * Breakthroughs of text, tables and images are intelligent to implement (not a single line of a new paragraph as the last line of a page, on the following page continuous tables get the table header again, images are only on one page to represent).
        
        * As the chapter numbering is shown in the header, a page break is required when changing to another chapter.
        
        * Hyperlinks are clickable and refer to the desired position within the document (also applies to attachments), external links are included in the pdf as a hyperlink.
        

        ::: [[File:UE1.PNG|500x395px]]
        

        == Technical information==
        

        ===Configuration===
        
        Some aspects of this extension can be configured on Special:BlueSpicePreferences, under section "Universal export PDF module". Here wiki administrators can configure: 
        

        * How Table of content should be shown.
        
        * Default template.
        
        * Template directory (physical path to the directory holding the templates).
        

        ===Rights (permissions)===
        
        This extension does not require any special rights. 
        

        ===Requirements===
        

        UEModuleBookPDF requires [[Reference:BlueSpiceFoundation|BlueSpiceFoundation]] and [[Reference:UniversalExport|UniversalExport]].
        

        ==User manual==
        

        UEModuleBookPDF is a module that allows export to PDF format. Read more on [[Reference:UniversalExport|UniversalExport]].
        

        ==Try free our BlueSpice==
        

        [https://en.demo.bluespice.com/wiki/Main_Page BlueSpiceDemo.]
        

            


            [[de:Referenz:{{PAGENAME}}]][[en:Reference:{{PAGENAME}}]]{{Translation}}
        

        [[Category:BlueSpice_pro]]
        
        [[Category:Extension]]
Line 60: Line 60:
 
[https://en.demo.bluespice.com/wiki/Main_Page BlueSpiceDemo.]
 
[https://en.demo.bluespice.com/wiki/Main_Page BlueSpiceDemo.]
  
 
+
{{Translation}}
 
 
 
 
 
 
[[de:Referenz:{{PAGENAME}}]][[en:Reference:{{PAGENAME}}]]
 
  
 
[[Category:BlueSpice_pro]]
 
[[Category:BlueSpice_pro]]
 
[[Category:Extension]]
 
[[Category:Extension]]

Attachments

Discussions