Handbuch:Erweiterung/PDFCreator

Seite oder Buch exportieren

Um eine Seite als PDF zu drucken, klicken Sie in den Seitenwerkzeugen auf das Seitensymbol. Das Dialogfeld „Export“ wird geöffnet.

Wählen Sie die Exporteinstellungen.

• Modus:
  • Seite: Druckt die Seite.
  • Seite mit Unterseiten: Druckt die Seite und alle Unterseiten. Diese Option wird nur angezeigt, wenn die Seite Unterseiten enthält.
  • Seite mit allen verlinkten Seiten: Druckt die Seite und die direkt von dieser Seite verlinkten Seiten.
• Vorlage:
  • Standard-PDF: Druckt die Seite(n) ohne Deckblatt (sofern die Vorlage nicht bearbeitet wurde).
  • StandardBuchPDF: Fügt dem PDF ein Deckblatt hinzu (sofern die Vorlage nicht bearbeitet wurde).

Standardmäßig zeigt die Vorlage „StandardPDF“ das Wiki-Logo (aus der Skin-Einstellungsseite). Wenn keine benutzerdefinierten Einstellungen vorgenommen wurden, wird das Standard-BlueSpice-Logo verwendet.

Bestehende PDF-Vorlagen bearbeiten

Sie können die vorhandene Standard-PDF- oder Buch-PDF-Vorlage direkt im Wiki bearbeiten. Zusätzlich zu den vorhandenen Vorlagen können Sie eigene benutzerdefinierte Vorlagen hinzufügen. Beim Drucken einer Seite oder eines Buches können Benutzer zwischen diesen Vorlagen wählen.

Darüber hinaus kann jedem Buch beim Drucken über die Seite „Bücher“ eine bestimmte Vorlage zugeordnet werden.

So bearbeiten Sie eine vorhandene Vorlage:

1. Öffnen Sie die Seite „MediaWiki:PDFCreator“.
2. Wählen Sie die zu bearbeitende Vorlage aus. Als Beispiel wählen wir die Vorlage „StandardPDF“.
3. Öffnen Sie die Seite im Bearbeitungsmodus. Das aktuelle Layout jedes PDF-Elements wird angezeigt. Sie können auf einen beliebigen Reiter klicken, um zwischen den Vorlagenelementen zu wechseln, die Sie anpassen möchten.
4. Klicken Sie auf die Schaltfläche „Hilfe“, um die verfügbaren Vorlagenplätze 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:

Vorlagen-Slot	Beschreibung
Kopfzeile	Die Kopfzeile 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 notwendig, um die Kopfzeile auf der Seite oben auszurichten. Sie arbeitet mit der Klassendeklaration im Reiter „Styles“ der Vorlage zusammen. Beide müssen gemeinsam angepasst werden.
Inhalt	Das Inhaltslayout. Die Grundstruktur lautet: {{{content}}}
Fußzeile	Die Fußzeile jeder PDF-Seite. Die Grundstruktur lautet: <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> Wichtig!Die Die Klasse „.pdfcreator-runningfooterfix“ ist erforderlich, um die Kopfzeile oben auf der Seite auszurichten. Sie arbeitet mit der Klassendeklaration im Reiter „Stile“ der Vorlage zusammen. Beide müssen gemeinsam angepasst werden.
Dokumentenvorspann	Das Deckblatt. Es ist für den Buchexport vorgesehen, kann aber auch für den Seitenexport verwendet werden. Die Grundstruktur eines Buchcovers lautet: <div class="pdfcreator-intro"> <div class="pdfcreator-intro-title">{{{title}}}</div> </div> Wichtig!Die Klasse „.pdfcreator-intro“ ist erforderlich, 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 den Vorlagenelementen verwendet werden. Die Standard-Stile können Sie hier einsehen.
Eigenschaften	Ermöglicht die Steuerung einiger Aspekte der PDF-Ausgabe. Folgende Eigenschaften sind verfügbar (Standardeinstellungen): { "embed-page-toc": true, "no-redirect":false, "attachments": true, "suppress-links": false }
Beschreibung	Interne Hinweise zur Verwendung dieser Vorlage. Die Beschreibung hat keine Auswirkungen auf die Vorlage selbst.

Konfiguration

Die Wiki-Konfiguration ermöglicht die Festlegung einer Standardvorlage für den PDF-Seitenexport und eines Standard-Hintergrundbilds für Titelseiten.

Standard-Exportvorlage für Seiten

Die Standardvorlage wird angezeigt, wenn Benutzer im Modus „Seite“ eine Exportvorlage 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 in der Regel kein definiertes Titelbild.

Standard-Cover-Hintergrundbild

Administratoren können auch ein Standard-Cover-Hintergrundbild festlegen. Es wird angewendet, wenn das Dokumentvorwort der Vorlage den Standard-Intro-Wrapper enthält:

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

Hinweis:Wenn in den Metadaten eines Buches ein benutzerdefiniertes Bücherregalbild festgelegt ist, wird stattdessen dieses verwendet.

Neue Vorlage hinzufügen

Der Inhalt der Standardvorlagen kann derzeit nicht kopiert werden. Jede PDF-Vorlage wird als Unterseite der Seite MediaWiki:PDFCreator gespeichert.

So erstellen Sie eine neue PDF-Vorlage:

1. Gehen Sie zur Seite MediaWiki:PDFCreator.
2. Fügen Sie eine Unterseite hinzu (z. B. über das Menü der Wiki-Schaltfläche „Neu“).
3. Geben Sie das HTML-Layout und die Parameter für jeden Vorlagen-Slot ein, wie im Abschnitt Bearbeiten vorhandener PDF-Vorlagen beschrieben.
4. Speichern Sie die neue Vorlage.

Sie können die Vorlage nur speichern, wenn der Inhalts-Slot mindestens den Inhaltsplatzhalter {{{content}}} enthält. Sobald die neue Vorlage gespeichert ist, steht sie beim Exportieren von Seiten ins PDF-Format zur Auswahl.

Anpassungsbeispiele für Kopf- und Fußzeile

Benutzerdefiniertes Logo

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

1. <div class="pdfcreator-runningheaderfix">
   <table>
   <tr>
   <td>
   <div class="pdfcreator-runningheader-logo">
   [[File:my-logo.png|alt=mein Logoname]]
   </div>
   </td>
   <td>
   <h1 class="title">{{{title}}}</h1>
   </td>
   </tr>
   </table>
   </div>
   

Semantische Eigenschaft

Es ist auch möglich, eine semantische Eigenschaft in die Fußzeile zu drucken. Das folgende Beispiel gibt den Wert der Eigenschaft „Revision_ID“ einer Seite in der PDF-Fußzeile aus.

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

Hintergrundfarbe für Kopf- und Fußzeile

Fügen Sie im Reiter „Stile“ Folgendes hinzu:

/* Hintergrundfarbe für Kopf- und Fußzeile hinzufügen */
.pdfcreator-runningheaderfix, .pdfcreator-runningfooterfix {
background-color: #eee;
}

Dadurch wird eine graue Hintergrundfarbe hinzugefügt.

Unterstreichung von Kopf- und Fußzeile entfernen

Fügen Sie im Reiter „Stile“ Folgendes hinzu:

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

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

Beispiele für die Anpassung des Deckblatts

Das Deckblatt kann im Reiter „Dokumentvorwort“ angepasst werden. Es wird hauptsächlich für Buchvorlagen verwendet. Die Standardelemente sind:

• Titel
• Logo
• Buchregalbild: Wenn ein Buchregalbild explizit vom Benutzer festgelegt wird, wird es automatisch gedruckt. Es verfügt über keinen Parameter. Die automatisch generierten Vorschaubilder im Buchregal werden nicht auf das PDF-Cover gedruckt.

Weißen Hintergrund zum Logo hinzufügen

Hintergrundfarben verwenden

Anstelle von Coverbildern können Sie Designs auch farbbasiert definieren.

Wichtig:Wenn ein Buch ein Cover hat, wird dieses über das im benutzerdefinierten Cover-Layout definierte Layout gedruckt. Layouts müssen daher in Kombination mit Coverbildern getestet werden!

Hier ist ein Beispiel und das benötigte HTML/CSS für das PDF-Layout.

• BookStyle1
  BookStyle1

Buchstil1

Dokumentvorwort:

<!-- Logo -->
<div class="pdfcreator-bookStyle1-logo">
{{logo}}}
</div>
<!-- Farbblock -->
<div class="pdfcreator-bookStyle1-colorblock">
</div>
<div class="pdfcreator-bookStyle1-colorblock-accent">
</div>
<!-- Titel -->
<div class="pdfcreator-bookStyle1-title">
{{title}}}
</div>
<!-- Untertitel -->
<div class="pdfcreator-bookStyle1-subtitle">
{{book-subtitle}}}
</div>

Dokumentvorwort:

/* Logo */
.pdfcreator-bookStyle1-logo {margin:1cm; Textausrichtung: rechts}

/* Farbblock */
.pdfcreator-bookStyle1-colorblock {Position:absolut; Höhe:2cm; Breite:1,8cm; Hintergrundfarbe:#3a3b3c;
Rand:4cm 0 0 0; Z-Index:-500}

.pdfcreator-bookStyle1-colorblock-accent {Position:absolut; Höhe:2cm; Breite:24cm; Hintergrundfarbe:#3366cc;
Rand:4cm 0 0 1,8cm; Z-Index:-500}

/* Titel */
.pdfcreator-bookStyle1-title {Schriftgröße:28pt;Schriftstärke:fett;Rand:8,5cm 1cm 1cm 1,8cm;Farbe:#333333;}

/* Untertitel */
.pdfcreator-bookStyle1-subtitle {Schriftgröße:16pt; Rand: 1 cm 1 cm 1 cm 1,8 cm; Farbe: #555555}

Migration bestehender BlueSpice Cloud PDF-Vorlagen

BlueSpice 4 Cloud verfügt über 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 zu bearbeitende Vorlage aus 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. Deckblatt -> Registerkarte Dokumentpräfix
   4. Styles.less -> Registerkarte Stile
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“:

Vorlagen-Slot	BlueSpice 4	BlueSpice 5
Header	{| | {{{logo}}} || || {{{title}}} |} Hinweis: Der Header-Wrapper wurde im Hintergrund erstellt und mit der ID „runningheaderfix“ gekennzeichnet. Diese ID existiert nicht mehr, kann 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, 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-Magic-Wö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>
Dokumenten	{| 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 nun festgelegt, wenn der Wrapper <div class="pdfcreator-intro">...</div>existiert: Es zeigt das in den Konfigurationsmanager-Einstellungen definierte Standard-Deckblattbild an. Wenn kein Bild festgelegt ist, wird kein Hintergrundbild gedruckt, es sei denn, in den Metadaten eines Buches ist ein Bücherregalbild definiert.	<div class="pdfcreator-intro"> <div class="pdfcreator-intro-title">{{{title}}}</div> </div> Hinweis: Wenn Sie kein vordefiniertes Cover-Hintergrundbild in einer Vorlage 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 den Vorlagenelementen verwendet werden. Es sind keine vordefinierten Stile vorhanden.
Eigenschaften	n/a	Ermöglicht die Steuerung einiger Aspekte der PDF-Ausgabe.
Beschreibung	n/a	Ermöglicht die Dokumentation der Vorlage und ihres Verwendungszwecks.

Die folgenden Parameter existieren nicht mehr und müssen durch MediaWiki 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	Uhrzeit der PDF-Erstellung	{{CURRENTTIME}}
subtitle	Untertitel des Buches	{{{Buch-Untertitel}}}

Technische Referenz: PDFCreator

---

Feedback zur Dokumentation ist im Community-Forum möglich.