hw>Mlink-rodrigue No edit summary |
m (Text replacement - "BlueSpice Cloud" to "BlueSpice cloud") |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{BSExtensionInfo | {{BSExtensionInfo | ||
|status=stable | |status=stable | ||
|developer=HalloWelt | |developer=HalloWelt | ||
|type=BlueSpice | |type=BlueSpice | ||
|edition=BlueSpice pro, BlueSpice | |edition=BlueSpice pro, BlueSpice farm, BlueSpice cloud | ||
|compatible=BlueSpice | |compatible=BlueSpice | ||
|category=Book | |category=Book | ||
|features='''UEModuleBookPDF''' export books to PDF format. | |features='''UEModuleBookPDF''' export books to PDF format. | ||
* Creates a PDF book based on the data from the Universal Export. | *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. | *Underlying is an HTML / PHP template, which is also customizable by the user. | ||
* Metadata is embedded in the PDF. | *Metadata is embedded in the PDF. | ||
* Numbering of chapters and the table of contents is generated. | *Numbering of chapters and the table of contents is generated. | ||
* Files are attached. | *Files are attached. | ||
* The pages of the PDF Book are printed on the model of the PDF single pages. | *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. | *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 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. | **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. | *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. | *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). | *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. | *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. | *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. | ||
Some aspects of this extension can be configured on Special:BlueSpiceConfigManager, under section "Universal export PDF module". Here wiki administrators can configure: | Some aspects of this extension can be configured on Special:BlueSpiceConfigManager, under section "Universal export PDF module". Here wiki administrators can configure: | ||
* How Table of content should be shown. | *How Table of content should be shown. | ||
|desc=export books to PDF format. | |||
|active=Yes | |||
}} | |||
{{wcagCheck | |||
|wcagStatus=2-testing complete | |||
|wcagCheckedfor=Web | |||
|wcagTestdate=2022-08-09 | |||
|wcagLevel=AA | |||
|wcagSupport=does not support | |||
|wcagWorkaround=no | |||
|wcagComments=based on PAC3: no screenreader support, to many errors. | |||
|extensionType=export | |||
|extensionFocus=reader | |||
}} | }} | ||
Latest revision as of 10:49, 7 June 2024
Extension: BlueSpiceUEModuleBookPDF
| Overview | |||
|---|---|---|---|
| Description: |
Enables BlueSpice export hierarchical collections of articles to Adobe® Portable Document Format (PDF). | ||
| State: | stable | Dependency: | BlueSpice |
| Developer: | HalloWelt | License: | GPL-3.0-only |
| Type: | BlueSpice | Category: | Book |
| Edition: | BlueSpice pro, BlueSpice farm, BlueSpice cloud | Version: | 4.1+ |
Features
UEModuleBookPDF export books to PDF format.
- 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.
Some aspects of this extension can be configured on Special:BlueSpiceConfigManager, under section "Universal export PDF module". Here wiki administrators can configure:
- How Table of content should be shown.
Technical Information
This information applies to BlueSpice 4. Technical details for BlueSpice cloud can differ in some cases.
Requirements
- MediaWiki: 1.39.0
- BlueSpiceBookshelf: 4.3
BlueSpiceFoundation: 4.3 BlueSpiceUEModulePDF: 4.3 BlueSpiceUniversalExport: 4.3
Integrates into
- BlueSpiceBookshelf
- BlueSpiceUniversalExport
Special pages
Permissions
| Name | Description | Role |
|---|---|---|
| uemodulebookpdf-export | Export a page to PDF as part of a book | reader |
Configuration
| Name | Value |
|---|---|
| UEModuleBookPDFBookExportTOC | 'only-articles' |
| UEModuleBookPDFDefaultTemplate | 'BlueSpice Book' |
| UEModuleBookPDFExportDialogExcludeTemplates | array ( ) |
| UEModuleBookPDFTemplatePath | 'extensions/BlueSpiceUEModuleBookPDF/data/PDFTemplates' |
Hooks
Accessibility
| Test status: | 2-testing complete |
|---|---|
| Checked for: | Web |
| Last test date: | 2022-08-09 |
| WCAG level: | AA |
| WCAG support: | does not support (workaround: no) |
| Comments: |
based on PAC3: no screenreader support, to many errors. |
| Extension type: | export |
| Extension focus: | reader |
