Verzeichnispfade für Templates
Standard BlueSpice Templates
- Common: extensions/BlueSpiceUEModulePDF/data/PDFTemplates/common
- Einzelseite: extensions/BlueSpiceUEModulePDF/data/PDFTemplates/BlueSpice
- Buch: extensions/BlueSpiceUEModuleBookPDF/data/PDFTemplates/BlueSpice Book
WICHTIG:
Das Common Verzeichnis enthält gemeinsame Dateien wie z. B. die page.css die die Seitenränder definiert.
Sichere Verzeichnisse für eigene Templates
Die PDF Templates dürfen nicht in den oben genannten Verzeichnissen angepasst werden. Bei einem Update werden Änderungen überschrieben!
Beispiele für sichere Verzeichnisse:
- extensions/<MyPDFTemplates>
- skins/<MyPDFTemplates>
- images/<MyPDFTemplates>
- extensions/BlueSpiceFoundation/data/PDFTemplates
Bearbeiten der Templates
Die PDF Templates für Einzelseite und Buch sind sich sehr ähnlich.
Erstellen eigener Templates
Die Inhalte der Verzeichnisse
- extensions/BlueSpiceUEModulePDF/data/PDFTempates
- extensions/BlueSpiceUEModuleBookPDF/data/PDFTempates
nach "extensions/BlueSpiceFoundation/data/PDFTemplates" kopieren und umbennennen
- "common" => "common" (bleibt)
- "BlueSpice" => "MyPageTemplate"
- "BlueSpice Book" => "MyBookTemplate"
Die Template namen müssen später noch in der jeweils zugehörigen template.php geändert werden.
Verzeichnisstruktur der Templates
data/PDFTemplates
|_ common
| |_ stylesheets (page.css -> Einstellung der Seitenränder)
|
|_ MyPageTemplate
| |_ template.php
| |_ template.html
| |_ images
| |_ stylesheets (styles.css -> Logo in der Kopfzeile)
|
|_ MyBookTemplate
|_ template.php
|_ template.html
|_ images
|_ stylesheets (styles.css -> Logo in der Kopfzeile)
Anpassung der Templates
template.php
Diese Datei enthält die Beschreibung bzw. Definition des Templates. Hier müssen alle css Dateien und ggf. Schriftarten angegeben werden, die im Template verwendet werden sollen.
Es müssen auch die Bilder angegeben werden, die z. B. in der Kopfzeile verwendet werden sollen.
Besonderheiten beim Buch:
Das PDFTemplate für das Buch greift auf das common Verzeichnis des Einzelseiten Templates zu. In der template.php wird aus diesem Grund eine Variable $sCommonDir die auf das Verzeichnis zeigt. Wenn die Templates in ein eigenes Verzeichnis kopiert werden muss dieser Pfad angepasst werden.
Wichtige Änderungen in den Abschnitten:
Abschnitt info:
- name => name des Templates (z. B. MyPageTemplate). MUSS mit dem Verzeichnisnamen übereinstimmen
Abschnitt resources:
- STYLESHEETS => geben Sie hier ggf. zusätzlich Stylesheets an. Diese müssen auch in der template.html angegeben werden. Wenn Sie andere Schriftarten verwenden müssen diese hier auch angegeben werden.
- IMAGES => geben Sie hier die Bilder an die Sie verwenden wollen. Beispiel 'images/bs-header.jpg'
Abschnitt messages:
- Hier können Texte sogenannten msg-keys zugeordnet werden. Diese msg-keys können in der template.html verwendet werden, z. B. der disclaimer.
- en, de, de-formal sind die Sprachen. Anders als in der template.html geschriebene Texte werden diese msg-keys Sprachabhängig verwendet.
template.html
Grundsätzlicher Aufbau der Seite. Hier kann z. B. in der Fußzeile die Seitennummer entfernt werden. Wenn eigene css Dateien mit eingebunden werden sollen müssen diese hier im <head> mit angegeben werden.
Beispiel:
<link href="stylesheets/styles.css" type="text/css" rel="stylesheet" />
Anpassung der Stylesheets
In den Stylesheets kann die Darstellung geändert werden. Dies betrifft z.B.
- Seitenränder
- Kopfzeile mit Logo
- Überschriften
- Textfarben
- ...
Die wichtigsten Beispiele:
Seitenränder:
Datei: common/stylesheets/page.css
Der Bereich @page ist die normale Seite im Hochformat. Die Seitenränder werden in der Zeile "margin" eingestellt (Reihenfolge: oben rechts unten links).
Hintergrundbild:
Datei: common/stylesheets/page.css
Der Bereich @page ist die normale Seite im Hochformat. Das Hintergrundbild wird in der Zeile "background" eingestellt.
Das Hintergrundbild muss in der template.php angegeben werden. (Wird bei BlueSpice nur für die Einzelseite verwendet.)
Kopfzeile (Logo):
Datei: MyPageTemplate/stylesheets/page.css
oder
Datei: MyBookTemplate/stylesheets/page.css
Bei #bs-runningheaderfix wird das Logo für die Kopfzeile in der Zeile "background" eingestellt.
Das Logo muss in der template.php angegeben werden.
Mit den Parametern "margin", "background-size" und "height" kann die Größe der Kopfzeile und des Logos beeinflusst werden. Die Zeile "width" sollte auf 21cm bleiben (ganze Seitenbreite).
Einstellen der Templates
PDF Templates können bei BlueSpice 3 nicht mehr über das Wiki eingestellt werden.
In der LocalSettings.php müssen folgende Zeilen hinzugefügt werden:
- Beispiel für Einzelseite:
$GLOBALS['bsgUEModulePDFTemplatePath'] = 'extensions/BlueSpiceFoundation/data/PDFTemplates'; $GLOBALS['bsgUEModulePDFDefaultTemplate'] = 'MyPageTemplate';
- Beispiel für Buch:
$GLOBALS['bsgUEModuleBookPDFTemplatePath'] = 'extensions/BlueSpiceFoundation/data/PDFTemplates'; $GLOBALS['bsgUEModuleBookPDFDefaultTemplate'] = 'MyBookTemplate';
Hinweis für Update von BlueSpice 2 auf BlueSpice 3
Bei BlueSpice 2 waren die Dateisystem Pfade zu den PDF Templates anders. Zusätzlich wurden diese in der Datenbank gespeichert.
Falls die Einstellung für die PDF Templates nicht funktionieren sollte in der Datenbank überprüft werden.
Folgende Zeilen aus der Tabelle bs_settings3 löschen (falls vorhanden):
MW::UEModuleBookPDF::DefaultTemplate MW::UEModuleBookPDF::TemplatePath MW::UEModulePDF::DefaultTemplate MW::UEModulePDF::TemplatePath
DELETE FROM bs_settings3 WHERE s_name = 'MW::UEModuleBookPDF::DefaultTemplate'; DELETE FROM bs_settings3 WHERE s_name = 'MW::UEModuleBookPDF::TemplatePath'; DELETE FROM bs_settings3 WHERE s_name = 'MW::UEModulePDF::DefaultTemplate'; DELETE FROM bs_settings3 WHERE s_name = 'MW::UEModulePDF::TemplatePath';
