Seitenentwurf:Handbuch:Erweiterung/PDFCreator

Exportieren einer Seite oder eines Buchs

Um eine Seite als PDF zu drucken, klicken Sie in den Seitenwerkzeuge auf das Seitensymbol. Dadurch wird das Dialogfeld „Exportieren“ geöffnet.

Wählen Sie die Exporteinstellungen aus.

• Modus:
  • Nur diese Seite: Druckt die Seite.
  • Seite mit Unterseiten: Druckt die Seite und alle Unterseiten. Diese Option wird nur angezeigt, wenn die Seite Unterseiten hat.
  • Seite mit verknüpften Seiten: Druckt die Seite und die Seiten, die direkt von dieser Seite aus verlinkt sind.
• Vorlage:
  • StandardPDF: Druckt die Seite oder Seiten ohne Deckblatt (es sei denn, die Vorlage wurde bearbeitet).
  • StandardBuchPDF: Fügt dem PDF ein Deckblatt hinzu (es sei denn, die Vorlage wurde bearbeitet).

Standardmäßig zeigt die Vorlage StandardPDF das Logo des Wikis (von der Skin-Einstellungsseite). Wenn keine benutzerdefinierten Einstellungen vorhanden sind, wird das BlueSpice-Logo verwendet.

Datei:StandardPDF template.png

Standard-PDF-Layout

Bestehende PDF-Vorlagen bearbeiten

Sie können die bestehende Standard PDF-Vorlage oder die PDF-Vorlage für Bücher direkt im Wiki bearbeiten. Zusätzlich zu den bestehenden Vorlagen können Sie Ihre eigenen benutzerdefinierten Vorlagen hinzufügen. Beim Drucken einer Seite oder eines Buchs können Benutzerdann zwischen diesen Vorlagen wählen.

Darüber hinaus kann für den Export auf der "Bücher"-Seite

So bearbeiten Sie eine bestehende Vorlage:

1. Öffnen Sie die Seite MediaWiki:PDFCreator.
2. Wählen Sie die Vorlage aus, die Sie bearbeiten möchten. Als Beispiel wählen wir die Vorlage „StandardPDF“.
3. Öffnen Sie die Seite im Bearbeitungsmodus. Dadurch wird Ihnen das aktuelle Layout jedes PDF-Elements angezeigt. Sie können auf eine beliebige Registerkarte klicken, um zwischen den Vorlagenelementen zu wechseln, die Sie anpassen möchten.
4. Klicken Sie auf die Schaltfläche „Hilfe“, um die verfügbaren Parameter anzuzeigen, die Sie jedem PDF-Layoutabschnitt hinzufügen können. Die Parameter mit dem Präfix „Buch“ sind Metadaten, die in Büchern definiert sind und keine Auswirkungen auf Seiten haben, die keinem Buch zugeordnet sind.

Vorlagenelemente

Jede Vorlage besteht aus denselben Elementen:

Kopfzeile	Der Seitenkopf jeder PDF-Seite. Die Grundstruktur ist: <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> Wichtig!Die Klasse .pdfcreator-runningheaderfix ist erforderlich, um den Kopf auf der Seite oben auszurichten. Es funktioniert in Verbindung mit der Klassendeklaration im Reiter „Stile“ der Vorlage. Beide müssen zusammen geändert werden.
Inhalt	Das Inhaltslayout. Die Grundstruktur ist: {{{content}}}
Fußzeile	Die Fußzeile jeder PDF-Seite. Die Grundstruktur ist: <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>
Dokumentenvorspann	Das Deckblatt. Es ist für den Buchexport gedacht, kann aber auch für einen regulären Seitenexport verwendet werden. Die Grundstruktur für ein Deckblatt ist: <div class="pdfcreator-intro"> <div class="pdfcreator-intro-title">{{{title}}}</div> </div> Wichtig!Die Klasse .pdfcreator-intro ist notwendig, um das Bild für den {{{logo}}}-Parameter anzuzeigen. Ohne diese Klasse in der Vorlage hat der {{{logo}}}-Parameter keine Wirkung.
Dokumentenanhang	Die letzte Seite des PDF-Exports. Sie hat keine vordefinierte Grundstruktur.
Styles	Stildeklarationen für die CSS-Klassen, die in einem der Vorlagenelemente verwendet werden. Die Standard styles finden Sie hier.
Beschreibung	Interne Hinweise zur Verwendung dieser Vorlage. Die Beschreibung hat keine Auswirkung auf die Vorlage selbst.

Konfiguration

In der Wiki-Konfiguration können Sie eine Standardvorlage für den PDF-Seitenexport und eine Standard-Hintergrundbild für Deckblätter festlegen.

Datei:PDFCreator config.png

PDFCreator Konfiguration

Standard Exportvorlage für Seiten

Die Standardvorlage wird immer vorausgewählt angezeigt, wenn Benutzer eine Exportvorlage im Modus „Seite“ auswählen. Sie wird auch verwendet, wenn auf den PDF-Link für das Content Droplet „PDF-Link“ geklickt wird.

Vorlagen vom Typ „Seite“ haben normalerweise kein Titelbild definiert.

Datei:PDFCreator config default page template.png

Standardseitenvorlage

Standard Hintergrundbild für das Deckblatt

Administratoren können ein Standardhintergrundbild definieren. Es wird immer dann angewendet, wenn der Dokumentenvorspann der Vorlage den Standard-„Intro“-Wrapper enthält:

<div class="pdfcreator-intro">
....
</div>

Datei:PDFCreator config cover.png

Standardbild für das Deckblatt

Hinweis:Wenn in den Metadaten eines Buchs ein benutzerdefiniertes Bücherregalbild festgelegt ist, wird stattdessen das benutzerdefinierte Bücherregalbild verwendet.

Hinzufügen einer neuen Vorlage

Jede PDF-Vorlage ist eine Unterseite der Seite MediaWiki:PDFCreator.

So erstellen Sie eine neue PDF-Vorlage:

1. Gehen Sie zur Seite MediaWiki:PDFCreator.
2. Fügen Sie eine Unterseite hinzu (zum Beispiel über das Menü der Neu-Schaltfläche des Wikis).
3. Geben Sie das HTML-Layout und die Parameter für jedes Vorlagenelement ein.
4. Speichern Sie die neue Vorlage.

Sie steht nun beim Exportieren von Seiten als Auswahl zur Verfügung.

Benutzerdefiniertes Logo

Standardmäßig zeigt der Parameter {{{logo}}} das Wiki-Logo im PDF an. Sie können auch direkt auf ein hochgeladenes Bild als Logo für verschiedenen PDF-Vorlagen verweisen. Hier fügen wir der Kopfzeile einer Vorlage ein benutzerdefiniertes Logo hinzu:

<div class="pdfcreator-runningheaderfix">
	<table>
		<tr>
			<td>
				<div class="pdfcreator-runningheader-logo">
					[[File:mein-logo.png|alternativtext=mein Logo Name]]
				</div>
			</td>
			<td>
				<h1 class="title">{{{title}}}</h1>
			</td>
		</tr>
	</table>
</div>

Semantische Eigenschaft

Es ist auch möglich, eine semantische Eigenschaft zum Beispiel in der Fußzeile zu drucken. Das folgende Beispiel druckt den Wert der Eigenschaft „Klassifizierung“ einer Seite in der PDF-Fußzeile. Diese semantische Eigenschaft muss im Wiki definiert sein, um einen Wert auszugeben.

<div class="pdfcreator-runningfooterfix">
{{#show:{{FULLPAGENAME}}|?Classification}}
</div>

Hintergrundfarbe für Kopf- und Fußzeile

Fügen Sie auf der Registerkarte „Styles“ Folgendes hinzu:

/* Fügen Sie der Kopf- und Fußzeile eine Hintergrundfarbe hinzu */
.pdfcreator-runningheaderfix, .pdfcreator-runningfooterfix {
background-color: #eee;
}

Dadurch wird eine graue Hintergrundfarbe hinzugefügt.

Unterstreichung aus Kopf- und Fußzeile entfernen

Fügen Sie auf der Registerkarte „Stile“ Folgendes hinzu:

/* Rahmen aus der Kopfzeile entfernen */
.pdfcreator-runningheaderfix > table {
border-bottom: none !important;
}

/* Rahmen aus der Kopfzeile entfernen */
.pdfcreator-runningfooterfix > table {
border-top: none !important;
}

Anpassungsbeispiele für das Deckblatt

Das Deckblatt kann über die Registerkarte „Dokumentenvorspann“ geändert werden. Es wird hauptsächlich für Buchvorlagen verwendet. Die Standardelemente sind:

• Titel
• Logo
• Bücherregalbild: Wenn ein Deckblattbild vom Benutzer explizit festgelegt wird, wird das Deckblattbild automatisch gedruckt. Es hat keinen Parameter. Die automatisch generierten Vorschaubilder im Bücherregal werden nicht auf das PDF-Deckblatt gedruckt.

Dem Logo einen weißen Hintergrund hinzufügen

Hintergrundfarben verwenden

Anstatt Grafiken für ein Deckblatt zu verwenden, können Sie einige Designs definieren, die rein auf Farben basieren.

Wichtig:Wenn ein Buch ein definiertes Bücherregal-Bild hat, wird es über die Elemente gedruckt, die im Dokumentenvorspann definiert sind. Layouts müssen daher in Kombination mit Bücherregal-Bildern getestet werden!

Hier ist ein Beispiel eines Deckblatts welches nur über Farben formatiert wird.

• Manual:Cover-bgcolor-stripe-EN.png

  BookStyle1

BookStyle1

Dokumentenvorspann:

<!-- Logo -->
<div class="pdfcreator-bookStyle1-logo">
{{{logo}}}
</div>
<!-- Color block -->
<div class="pdfcreator-bookStyle1-colorblock">
</div>
<div class="pdfcreator-bookStyle1-colorblock-accent" >
</div>
<!-- Title -->
<div class="pdfcreator-bookStyle1-title">{{{title}}} 
</div>
<!-- Subtitle -->
<div class="pdfcreator-bookStyle1-subtitle">{{{book-subtitle}}}
</div>

Styles:

/* Logo */
.pdfcreator-bookStyle1-logo {margin:1cm; text-align:right}

/* Color block */
.pdfcreator-bookStyle1-colorblock  {position:absolute; height:2cm; width:1.8cm; background-color:#3a3b3c; 
margin:4cm 0 0 0;  z-index:-500}

.pdfcreator-bookStyle1-colorblock-accent {position:absolute; height:2cm; width:24cm; background-color:#3366cc; 
margin:4cm 0 0 1.8cm;  z-index:-500}

/* Title */
.pdfcreator-bookStyle1-title {font-size:28pt;font-weight:bold;margin:8.5cm 1cm 1cm 1.8cm;color:#333333;}

/* Subtitle */
.pdfcreator-bookStyle1-subtitle {font-size:16pt; margin:1cm 1cm 1cm 1.8cm; color:#555555}

Migration vorhandener BlueSpice Cloud PDF-Vorlagen

BlueSpice 4 cloud hat eine Standardvorlage, die im Wiki angepasst werden kann. Ihre Elemente sind auf den folgenden Seiten definiert:

• 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

Diese Seiten wurden in BlueSpice 5 ersetzt. Sie müssen den Inhalt dieser Seiten in ein oder mehrere neue PDF-Layouts übertragen.

So verschieben Sie den Inhalt:

1. Öffnen Sie die Seite MediaWiki:PDFCreator.
2. Wählen Sie die Vorlage aus, die Sie bearbeiten möchten, oder erstellen Sie eine neue.
3. Fügen Sie den Inhalt Ihrer Vorlagen den entsprechenden Registerkarten hinzu:
   1. Header.html -> Registerkarte Kopfzeile
   2. Footer.html -> Registerkarte Fußzeile
   3. Titelseite -> Registerkarte Dokumentenvorspann
   4. Styles.less -> Registerkarte Styles
4. Korrigieren Sie die Stilreferenzen für die Kopf- und Fußzeilen-Wrapper:

​Vergleich des Standard-Vorlageninhalts von BlueSpice 4 cloud und BlueSpice 5 (cloud):

	BlueSpice 4 cloud	BlueSpice 5 (cloud)
Header	{| | {{{logo}}} || || {{{title}}} |} Hinweis: Der Header-Wrapper wurde im Hintergrund erstellt und mit der ID="runningheaderfix" gekennzeichnet. Diese ID existiert nicht mehr, könnte aber manuell zum neuen Wrapper-Element hinzugefügt werden.	Der Seitenkopf jeder PDF-Seite. Die Grundstruktur ist: <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>
Inhalt		Das Inhaltslayout. Die Grundstruktur ist: {{{content}}}
Fußzeile	{| | {{{exportdate}}} || {{int:universal-export-pdf-default-disclaimer}} || {{{currentpagenumber}}} / {{{totalpagescount}}} |} Hinweis: Der Footer-Wrapper wurde im Hintergrund erstellt und mit der ID="runningfooterfix" gekennzeichnet. Diese ID existiert nicht mehr, könnte aber manuell zum neuen Wrapper-Element hinzugefügt werden. Der Parameter {{{exportdate}}} existiert nicht mehr. Es kann durch die Parserfunktion {{#time:m/d/Y|now}} oder durch die MediaWiki-Zauberwörter {{CURRENTMONTH}}/{{CURRENTDAY}}/{{CURRENTYEAR}} ersetzt werden	<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>
Dokumentvorwort	{| style="width: 100%; text-align: right;" |{{{logo}}} |} {| style="margin-top: 10cm;" | <span style="font-size: 18px; font-weight:bold;">{{{title}}}</span> |- |{{{subtitle}}} |- |} Hinweis: Der Header-Wrapper wurde im Hintergrund erstellt und mit der ID="runningheaderfix" gekennzeichnet. Diese ID existiert nicht mehr, konnte aber manuell zum neuen Wrapper-Element hinzugefügt werden.	Der Seitenkopf jeder PDF-Seite. Die Grundstruktur ist: <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>
Inhalt		Das Inhaltslayout. Die Grundstruktur ist: {{{content}}}
Footer	{| | {{{exportdate}}} || {{int:universal-export-pdf-default-disclaimer}} || {{{currentpagenumber}}} / {{{totalpagescount}}} |} Hinweis: Der Footer-Wrapper wurde im Hintergrund erstellt und mit der ID="runningfooterfix" gekennzeichnet. Diese ID existiert nicht mehr, kann aber manuell zum neuen Wrapper-Element hinzugefügt werden. Der Parameter {{{exportdate}}} existiert nicht mehr. Es kann durch die Parserfunktion {{#time:m/d/Y|now}} oder durch die MediaWiki-Zauberwörter {{CURRENTMONTH}}/{{CURRENTDAY}}/{{CURRENTYEAR}} ersetzt werden	<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>
Dokumentvorwort	{| style="width: 100%; text-align: right;" |{{{logo}}} |} {| style="margin-top: 10cm;" | <span style="font-size: 18px; font-weight:bold;">{{{title}}}</span> |- |{{{subtitle}}} |- |} Hinweis: Der Parameter {{{backgroundcover}}} war verfügbar, um ein Hintergrundbild für das Deckblatt festzulegen. Dieser Parameter existiert nicht mehr. Das Hintergrundbild wird jetzt festgelegt, wenn der Wrapper <div class="pdfcreator-intro">...</div>existiert: Es zeigt das in den Konfigurationsmanagereinstellungen definierte Standard-Coverbild. Wenn kein Bild festgelegt ist, wird kein Hintergrundbild gedruckt, es sei denn, in den Metadaten für ein Buch ist ein Bücherregalbild definiert.	<div class="pdfcreator-intro"> <div class="pdfcreator-intro-title">{{{title}}}</div> </div> Hinweis: Wenn Sie in einer Vorlage kein vordefiniertes Cover-Hintergrundbild verwenden möchten (z. B. aus den Einstellungen des Konfigurationsmanagers oder dem Bücherregalbild eines Buches), verwenden Sie keinen Wrapper mit der Klasse pdfcreator-intro.
Dokumentenanhang	n/a	Die letzte Seite des PDF-Exports. Sie hat keine vordefinierte Grundstruktur.
Styles	Standardstile.	Stildeklarationen für die CSS-Klassen, die in einem der Vorlagenelemente verwendet werden.
Beschreibung	n/a	Ermöglicht die Dokumentation der Vorlage und ihres Verwendungszwecks.

​Die folgenden Parameter existieren nicht mehr und müssen durch "Magische Wörter" ersetzt werden:

Veraltete Parameter

Parameter	Beschreibung	Ersetzen durch
url	URL der Wiki-Seite	{{fullurl:{{FULLPAGENAME}}}}
exportdate	Datum der PDF-Erstellung	{{CURRENTMONTH}}/{{CURRENTDATE}}/{{CURRENTYEAR}}
exporttime	Zeit der PDF-Erstellung	{{CURRENTTIME}}
subtitle	Untertitel des Buches	{{{book-subtitle}}}

Cascading Style Sheets. Eine Computersprache für die Gestaltung digitaler, vorwiegend webbasierter Dokumente.

Ein Uniform Resource Locator (Abk. URL; englisch für „einheitlicher Ressourcenverorter“) identifiziert und lokalisiert eine Ressource, beispielsweise eine Webseite, über die zu verwendende Zugriffsmethode (zum Beispiel das verwendete Netzwerkprotokoll wie HTTP oder FTP) und den Ort (englisch location) der Ressource in Computernetzwerken.