Last edited 4 weeks ago
by Redaktion

Migrating existing cloud templates

BlueSpice 4 cloud has one standard template that can be customized in the wiki. Its elements are defined in the following pages:

  • MediaWiki:UniversalExport/PDF/Default/Header.html
  • MediaWiki:UniversalExport/PDF/Default/Footer.html
  • MediaWiki: UniversalExport/PDF/Default/Cover page.html
  • MediaWiki: UniversalExport/PDF/Default/Styles.less

These pages have been replaced in BlueSpice 5. You need to transfer the content of these pages to one or more new PDF layouts.

To move the content:

  1. Open the page MediaWiki:PDFCreator.
  2. Select the template you want to edit or create a new one.
  3. Add the content of your templates to the appropriate tabs:
    1. Header.html -> Header tab
    2. Footer.html -> Footer tab
    3. Cover page -> Document prefixtab
    4. Styles.less -> Styles tab
  4. Correct the style-references for the header and footer wrappers:


Comparison of the default template content of BlueSpice 4 cloud and BlueSpice 5 cloud:

BlueSpice 4 BlueSpice 5
Header 
{|
| {{{logo}}} || || {{{title}}}
|}
Note:
  • The header-wrapper was created in the background and marked by the id="runningheaderfix". This ID no longer exists, but could be added manually to the new wrapper element.
 The page header of each PDF page. The basic structure is:
<div class="pdfcreator-runningheaderfix">
	<table>
		<tr>
			<td>
				<div class="pdfcreator-runningheader-logo">
					{{{logo}}}
				</div>
			</td>
			<td>
				<h1 class="title">{{{title}}}</h1>
			</td>
		</tr>
	</table>
</div>
Content The content layout. The basic structure is:
{{{content}}}
Footer 
{|
| {{{exportdate}}} || {{int:universal-export-pdf-default-disclaimer}} || {{{currentpagenumber}}} / {{{totalpagescount}}}
|}
Note:
  • The footer-wrapper was created in the background and marked by the id="runningfooterfix". This ID no longer exists, but could be added manually to the new wrapper element.
  • The parameter {{{exportdate}}} no longer exists. It can be replaced with the parser function {{#time:m/d/Y|now}} or with the MediaWiki magic words {{CURRENTMONTH}}/{{CURRENTDAY}}/{{CURRENTYEAR}}
 
<div class="pdfcreator-runningfooterfix">
	<table>
		<tr>
			<td>
				<span>{{int:pdfcreator-pdf-disclaimer}}</span>
			</td>
			<td>
				<span>{{int:pdfcreator-pdf-export-time}}:{{#time:d.m.Y|now}}</span>
			</td>
			<td>
				<span>{{int:pdfcreator-pdf-param-currentpagenumber-label}} </span>{{{currentpagenumber}}} 
				<span> {{int:pdfcreator-pdf-param-totalpagescount-label}} </span>{{{totalpagescount}}}
			</td>
		</tr>
	</table>
</div>
Document preface 
{| style="width: 100%; text-align: right;"
|{{{logo}}}
|}
{| style="margin-top: 10cm;"
| <span style="font-size: 18px; font-weight:bold;">{{{title}}}</span>
|-
|{{{subtitle}}}
|-
|}
Note:
  • the parameter {{{backgroundcover}}} was available to set a background image for the cover sheet. This parameter no longer exists.
  • The background image is now set when the wrapper <div class="pdfcreator-intro">...</div>exists:
    • It shows the default cover image defined in the Config manager settings. If no image is set, no background image is printed unless
    • a bookshelf-image is defined in the metadata for a book.
 
<div class="pdfcreator-intro">
	<div class="pdfcreator-intro-title">{{{title}}}</div>
</div>
Note: If you do not want to use a predefined cover background image in a template (e.g. from the configuration manager setting or the bookshelf-image of a book), do not use a wrapper with class pdfcreator-intro.
Document appendix n/a The last page of the PDF export. It has no predefined basic structure.
Styles default styles. Style declarations for the CSS classes that are used in any of the template elements. There are no predefined styles.
Properties n/a Allows to control some aspects of the PDF output.
Description n/a Allows to document the template and its usage purpose.

​The following parameters no longer exist and need to be replaced with MediaWiki magic words:

Obsolete parameters
Parameter Description Replace with
url URL of the wiki page {{fullurl:{{FULLPAGENAME}}}}
exportdate date of PDF-creation {{CURRENTMONTH}}/{{CURRENTDATE}}/{{CURRENTYEAR}}
exporttime time of PDF-creation {{CURRENTTIME}}
subtitle Subtitle of the book {{{book-subtitle}}}



To submit feedback about this documentation, visit our community forum.

Retrieved from "https://en.wiki5.bluespice.com/w/index.php?title=Manual:Extension/PDFCreator/Migrating_existing_cloud_templates&oldid=11096"