Handbuch:Erweiterung/PDFCreator

Migration bestehender benutzerdefinierter PDF-Vorlagen:

Benutzerdefinierte PDF-Vorlagen aus früheren BlueSpice-Versionen erfordern manuelle Updates auf die neue PDFCreator-Funktionalität. Je nach Anforderungen können neue Vorlagen im Wiki erstellt werden. Bei komplexen Anpassungen ist Technik-Unterstützung notwendig.

Für bestehende BlueSpice cloud-Vorlagen gibt es einige Anweisungen für die notwendigen Änderungen.

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.

PDF-Export Dialogfenster

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).

Ob verlinkte Seiten oder verlinkte Dateien im PDF Export berücksichtigt werden solten, ist in der jeweils ausgewählten Vorlage definiert.

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.

Medien-Links exportieren

Medienlinks (= Links, die direkt auf die Datei auf dem Server verweisen) fügen der exportierten PDF-Datei einen Anhang hinzu. Dies ist unabhängig vom gewählten Exportmodus (Seite, Seite mit verlinkten Seiten).

Dies gilt auch für PDF-Dateien, die über das Inhalts-Droplet PDF-Vorschau eingebettet werden.

Wenn keine Anhänge hinzugefügt werden sollen, muss dies in den Eigenschaften der PDF-Vorlage definiert werden.

Seiten mit verlinkten Seiten exportieren

Beim Exportieren von Seiten mit ihren verlinkten Seiten werden die Linktypen wie folgt verarbeitet:

• Medienlinks fügen der exportierten PDF-Datei einen Anhang hinzu (z.B. [[Medium:mydocument.pdf]])
• Dateilinks sind anklickbar und verlinken zur entsprechenden Dateiseite im Wiki. (z.B. [[File:mydocument.pdf]])
• Erwähnungen sind anklickbar und leiten zur Benutzerseite weiter.

Wenn keine Anhänge hinzugefügt werden sollen, muss dies in den Eigenschaften der PDF-Vorlage definiert werden.

Wenn keine Links zu Seiten hinzugefügt werden, die nicht im PDF enthalten sind, muss dies in den Eigenschaften der PDF-Vorlage definiert werden.

Neue Vorlage hinzufügen

Das Wiki bietet standardmäßig zwei PDF-Vorlagen:

• StandardPDF: Vorlage ohne Deckblatt für den Einzelseitenexport.
• StandardBookPDF: Vorlage mit Deckblatt für den Buchexport.

Ab BlueSpice 5.1 können PDF-Vorlagen über die Seite Spezial: PDF-Vorlagen erstellt werden.

Vorhandene Vorlage kopieren

So erstellen Sie eine neue PDF-Vorlage:

1. Gehen Sie zur Seite Spezial: PDF-Vorlagen.
2. Kopieren Sie eine vorhandene Vorlage.

   

   Schaltfläche zum Kopieren einer PDF Vorlage

3. Geben Sie einen Namen für die neue Vorlage an.
4. Klicken Sie Kopieren.

Klicken Sie anschließend die Schaltfläche zum Bearbeiten (Stift-Symbol) der neuen Vorlage.

Allgemeine Eigenschaften auswählen

1. Wählen Sie die Seitenausrichtung und die allgemeinen Exporteigenschaften aus (z. B. ob das Inhaltsverzeichnis für jede Seite angezeigt werden soll oder ob Links zu Seiten eingefügt werden sollen, die nicht im PDF selbst exportiert werden).
2. Klicken Sie auf Weiter.

Vorlagen-Elemente auswählen

Aktivieren Sie die Kontrollkästchen für jedes Element, das Sie in Ihre Vorlage aufnehmen möchten:

• Kopfzeile
• Fußzeile
• Dokumentvorspann: Deckblatt
• Dokumentanhang: Zusätzliche Seite am Ende der PDF-Datei. Sie ist wie die Inhaltsseiten (mit Kopf- und Fußzeile) formatiert und erhöht die Seitenzahl der PDF-Datei.

Klicken Sie für jedes Vorlagenelement auf Konfigurieren, um das Layout zu gestalten.

Kopfzeile konfigurieren

Die Kopfzeilenelemente können aus einem Bild (normalerweise Ihrem Logo) und Text (einer Kombination aus vordefinierten Parametern und Ihrem eigenen Text) bestehen.

Wenn Sie ein anderes Bild als Ihr Wiki-Logo verwenden möchten, wählen Sie Benutzerdefiniertes Logo verwenden und geben Sie einen vorhandenen Bildnamen ein oder laden Sie ein neues Bild hoch.

Fußzeile konfigurieren

Standardmäßig bietet das Wiki für jeden Fußzeilenabschnitt lokalisierte Systemmeldungen an. Nutzen Sie Systemmeldungen, wenn Sie die Spracheinstellungen Ihrer Benutzer unterstützen möchten. Beispielsweise kann in einem deutschsprachigen Wiki die deutsche Systemmeldung für {{int:pdfcreator-pdf-disclaimer}} auf der Seite MediaWiki:pdfcreator-pdf-disclaimer geändert werden. Die englische Version finden Sie auf der Seite MediaWiki:pdfcreator-pdf-disclaimer/en.

Alternativ können Sie einfach Ihren eigenen Text eingeben, wenn der PDF-Export keine Benutzersprachen berücksichtigen muss. Oder lassen Sie den Abschnitt leer, wenn Sie keinen Text drucken möchten.

Konfigurieren des Dokumentvorspanns (Deckblatt)

Sie können folgende Elemente für Ihr Deckblatt festlegen:

Hintergrundbild:

• Wenn ein Buchregalbild vorhanden ist, wird dieses als Coverbild für den PDF-Export des Buches verwendet.
• Wenn kein Buchregalbild vorhanden ist, wird das im Konfigurationsmanager definierte Standardbild als Coverbild für den PDF-Export des Buches verwendet.
• Wenn in der PDF-Vorlage ein benutzerdefiniertes Bild definiert ist, wird dieses für den PDF-Export des Buches verwendet.

Wenn Sie kein Hintergrundbild für Ihr PDF-Cover verwenden möchten, müssen alle drei Felder für die Definition eines Hintergrundbildes leer sein.

Eigenschaften

Die folgenden Eigenschaften können konfiguriert werden:

{
	"embed-page-toc": true,
	"nsPrefix": true,
	"attachments": true,
	"suppress-links": false,
	"no-redirect": true,
	"coverBackground": ""
}

Bezeichnung	Name	Standardwert	Beschreibung
Namensraumpräfix anzeigen	nsPrefix	true	Das Namensaumpräfix von Seiten wird nicht in den Seitentiteln abgedruckt.
Inhaltsverzeichnis anzeigen	embed-page-toc	true	Das Inhaltsverzeichnis jeder exportierten Seite wird ausgegeben.
Weiterleitung ignorieren	no-redirect	false	Wenn Links auf eine andere Seite weiterleiten, ist die Zielseite nicht im PDF enthalten.
Anhänge erlauben	attachments	true	Wenn Dateien direkt mit dem Präfix „Medium:“ verlinkt sind, werden die Dateien auch im PDF angehängt.
Links in PDF deaktivieren	suppress-links	false	Ersetzt alle Links im PDF durch ein span-Element, wenn sie nicht auf ein Ziel innerhalb des PDFs verweisen.
-	coverBackground	<File:filename.png>	Diese Eigenschaft wird programmgesteuert festgelegt, wenn ein benutzerdefiniertes Hintergrundbild für das Deckblatt angegeben ist.

Bestehende PDF-Vorlagen bearbeiten

Alle Vorlagen sind als Unterseiten der Seite MediaWiki:PDFCreator gespeichert.

Hier ist die Syntax für die Vorlagenelemente einsehbar und auch direkt bearbeitbar, falls komplexere Änderungen nötig 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

PDF Creator

• Namensraum-Präfix im PDF ausblenden: Entfernt das Namensraum-Präfix aus Titeln.
• Standard Export-Vorlage für Seiten: Die Standardvorlage wird als erstes angezeigt, wenn Benutzer im Modus „Seite“ eine Exportvorlage auswählen. Sie wird auch für das Inhalts-Droplet "PDF-Link" verwendet.

• Cover-Hintergrundbild in PDF-Vorlagen: Standard-Hintergrundbild für PDF-Vorlagen. Eine PDF-Vorlage muss im Slot "Dokumentenvorspann" folgenden Standard-Wrapper nutzen, damit das hier angegebene Bild ausgegeben wird:

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

Standard-Bild:

/app/bluespice/w/extensions/BlueSpiceBookshelf/data/common/images/bs-cover.png

Ausgabe:

Standard PDF-Coverbild

Der Bild-Pfad kann gelöscht werden. Dann wird standardmäßig kein Bild ausgegeben.

Alternativ kann ein eine hochgeladene Bild-Datei angegeben werden (ohne Namensraum-Präfix), zum Beispiel: alpaka1.jpg

Standard Coverbild (hochgeladen)

​Wenn ein Buch ein eigenes Bücherregal-Bild besitzt, wird dieses beim direkten Export von der Spezialseite "Bücher" im PDF generiert.

Anpassungsbeispiele

Semantische Eigenschaft

Es ist möglich, eine semantische Eigenschaft (Attribut) 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 „Styles“ 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 „Styles“ hinzu:

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

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

Inhaltsverzeichnis entfernen

Das Inhaltsverzeichnis zu Beginn eines PDFs soll angezeigt werden, aber nicht das Inhaltsverzeichnis für die Abschnitte der Seiten.

Fügen Sie im Reiter „Styles“ hinzu:

/* remove the border from the header */
.pdfcreator-type-page .toc {
    display:none;
}

Um auch das Inhaltsverzeichnis am Beginn des PDFs zu entfernen:

/* remove the border from the header */
.toc {
    display:none;
}

PDF Inhalts-Droplets

Folgende Inhalts-Droplets sind verfügbar:

Droplet-Name	Beschreibung
Buch-PDF-Link	Fügt einen Link zu einem Buch auf der Seite ein. Ein Klick auf den Link lädt die PDF-Datei sofort herunter.
PDF-Link	Fügt einen Link zu derselben oder einer anderen Seite auf der Seite ein. Ein Klick auf den Link lädt die Seite sofort herunter.
PDF-Vorschau	Öffnet die PDF-Datei direkt auf einer Seite in einem PDF-Viewer.
Inhalte im PDF ausschließen	Umschließt Inhalte mit den Tags <pdfexcludestart />...<pdfexcludeend />. Sie können den ausgeschlossenen Inhalt erweitern, indem Sie die Tags im Quelltextbearbeitungsmodus an eine andere Stelle verschieben. Hinweis: Das Tag <uenoexport /> ist veraltet, wird aber weiterhin unterstützt. Es sollte nicht mehr verwendet werden.
PDF-Seitenumbruch	Die eingefügte Seitenumbruchmarkierung ist sowohl im Bearbeitungs- als auch im Ansichtsmodus sichtbar. Um diese Markierung im Ansichtsmodus auszublenden, fügen Sie MediaWiki die folgende Deklaration hinzu:Common.css: /*PDF-Seitenumbruchmarkierung im Ansichtsmodus ausblenden */ .bs-tag-pdfpagebreak {display:none} .bs-tag-pdfpagebreak.ve-ce-leafNode {display:block}

Semantic MediaWiki

Die Bücher, in denen eine Seite existiert, werden über das semantische Attribut Bücher (Property:Books) abfragbar.

Semantisches Attribut "Bücher"

Migration bestehender BlueSpice cloud PDF-Vorlagen

Anleitung zur Migration der cloud PDF-Vorlagen

Technische Referenz: PDFCreator

PDF-Ausschluss - Start

---

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

PDF-Ausschluss - Ende

Eine Weiterleitung hilft, Duplikate und inhaltlichen Wildwuchs zu vermeiden. Weiterleitungen werden z.B. für Seiten eingerichtet, deren Inhalte veraltet sind, die nicht mehr gebraucht werden oder mit den Inhalten anderer Seiten übereinstimmen. Sie verweisen in der Regel auf die aktuellste Beschreibung eines Themas und vermeiden unnötige Arbeit im Fall von Ab-kürzungen, Synonymen, Plural/Singular-Duplikaten, Umbenennungen oder Verschiebungen.

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

Im Wiki abgetrennter Bereich, dessen Inhalte über spezielle Berechtigungen gelesen und bearbeitet werden können. Einen Namensraum erkennt man an einem Präfix vor dem Artikeltitel.

Tag: XML-Tags, welche beliebig parametrisiert werden können und eine vom Programmierer gewünschte Ausgabe produzieren. Fügt man beispielsweise das <bs:bookshelf>-Tag ein, dann erhält der Artikel die Kapitelnavigation des PDF-Buches, in dem der Artikel verlinkt ist.

Set von Wiki-Erweiterungen, mit dem strukturierte Daten erstellt und abgefragt werden können.