View source for Manual:Extension/PDFCreator/Migrating existing cloud templates

== Migrating existing BlueSpice cloud PDF 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:'''
#'''Open''' the page ''MediaWiki:PDFCreator.''
# '''Select''' the template you want to edit or [[Manual:Extension/PDFCreator#Adding a new template|create a new one]]. 
# '''Add''' the content of your templates to the appropriate  tabs: 
## Header.html -> Header tab
## Footer.html -> Footer tab
## Cover page -> Document prefixtab
## Styles.less -> Styles tab
# '''Correct''' the style-references  for the header and footer wrappers:<!-- TABLE HERE -->



Comparison of the default template content of ''BlueSpice 4 cloud'' and ''BlueSpice 5 cloud'':
{| class="wikitable" style="width: 100%;"
! style="" |
! style="" |BlueSpice 4
! style="" |BlueSpice 5
|-
! style="" |Header
| style="" |<syntaxhighlight lang="text">
{|
| {{{logo}}} || || {{{title}}}
|}

</syntaxhighlight>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.
| style="" |The page header of each PDF page. The basic structure is:<syntaxhighlight lang="html">
<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>
</syntaxhighlight>
|-
! style="" |Content
| style="" |
| style="" |The content layout. The basic structure is:<syntaxhighlight lang="html">
{{{content}}}
</syntaxhighlight>
|-
! style="" |Footer
| style="" |<syntaxhighlight lang="text">
{|
| {{{exportdate}}} || {{int:universal-export-pdf-default-disclaimer}} || {{{currentpagenumber}}} / {{{totalpagescount}}}
|}
</syntaxhighlight>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 <code><nowiki>{{{exportdate}}}</nowiki></code> no longer exists.  It can be replaced with the [[mediawikiwiki:Help:Extension:ParserFunctions##time|parser function]] <code><nowiki>{{#time:m/d/Y|now}}</nowiki></code> or with the [[mediawikiwiki:Help:Magic_words#Date_and_time|MediaWiki magic words]] <code><nowiki>{{CURRENTMONTH}}</nowiki>/<nowiki>{{CURRENTDAY}}</nowiki>/<nowiki>{{CURRENTYEAR}}</nowiki></code>
| style="" |<syntaxhighlight lang="html">
<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>
</syntaxhighlight>
|-
! style="" |Document preface
| style="" |<syntaxhighlight lang="html">
{| style="width: 100%; text-align: right;"
|{{{logo}}}
|}
{| style="margin-top: 10cm;"
| <span style="font-size: 18px; font-weight:bold;">{{{title}}}</span>
|-
|{{{subtitle}}}
|-
|}
</syntaxhighlight>Note: 

* the parameter <code><nowiki>{{{backgroundcover}}}</nowiki></code> 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 <nowiki><div class="pdfcreator-intro">...</div></nowiki>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. 
| style="" |<syntaxhighlight lang="html">
<div class="pdfcreator-intro">
	<div class="pdfcreator-intro-title">{{{title}}}</div>
</div>
</syntaxhighlight>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 <code>pdfcreator-intro</code>.
|-
! style="" |Document appendix
| style="" |n/a
| style="" |The last page of the PDF export. It has no predefined basic structure.
|-
! style="" |Styles
| style="" |default styles.
| style="" |Style declarations for the CSS classes that are used in any of the template elements. There are no predefined styles.
|-
! style="" |Properties
| style="" |n/a
| style="" |Allows to control some aspects of the PDF output. 
|-
! style="" |Description
| style="" |n/a
| style="" |Allows to document the template and its usage purpose.
|}

The following parameters no longer exist and need to be replaced with MediaWiki magic words:
{| class="wikitable"
|+Obsolete parameters
! style="" |Parameter
! style="" |Description
! style="" |Replace with
|-
| style="" |url
| style="" |URL of the wiki page
| style="" |<nowiki>{{fullurl:{{FULLPAGENAME}}}}</nowiki>
|-
| style="" |exportdate
| style="" |date of PDF-creation
| style="" |<nowiki>{{CURRENTMONTH}}/{{CURRENTDATE}}/{{CURRENTYEAR}}</nowiki>
|-
| style="" |exporttime
| style="" |time of PDF-creation
| style="" |<nowiki>{{CURRENTTIME}}</nowiki>
|-
| style="" |subtitle
| style="" |Subtitle of the book
| style="" |<nowiki>{{{book-subtitle}}}</nowiki>
|}{{#dpl:title=BlueSpiceConfigManager|include=#PDFCreator}}