Sprachabhängige JavaScript-Dateien für CMS-Module erstellen
Das bluetronix CMS erzeugt automatisch optimierte JavaScript-Dateien für jede aktivierte Sprache deiner Webseite. Du lernst, wie Standarddateien, individuelle Anpassungen und sprachabhängige Modultexte zusammengeführt werden und wie das CMS die passenden Dateien automatisch in deine Webseite einbindet.
Sprachabhängige JavaScript-Dateien
Das bluetronix CMS kann für jede aktivierte Sprache deiner Webseite eigene JavaScript-Dateien erzeugen. Dadurch stehen sprachabhängige Texte und Funktionen direkt innerhalb der jeweiligen JavaScript-Datei zur Verfügung.
Die benötigten Dateien werden automatisch erstellt, sobald du eine Modulkonfiguration speicherst. Dabei berücksichtigt das CMS sowohl die Standarddateien als auch deine individuellen Anpassungen.
Dieses Tutorial baut auf der Dokumentation „CMS-Module einbinden und anpassen“ auf. Du solltest bereits mit dem Entwicklerordner bx_Mod und der Verwendung eigener _own-Dateien vertraut sein.
1. Automatische Erzeugung der JavaScript-Dateien
Wenn du eine Modulkonfiguration speicherst, erzeugt das CMS automatisch alle benötigten sprachabhängigen JavaScript-Dateien neu.
Es werden ausschließlich die Sprachversionen erstellt, die du über das Modul Lang aktiviert hast.
Die aktivierten Sprachen werden über die globale Modulkonfiguration festgelegt:
bx_Mod/config_own.phpHast du beispielsweise Deutsch, Englisch und Spanisch aktiviert, erstellt das CMS entsprechende JavaScript-Dateien für diese drei Sprachen.
Ein Wechsel des Farbsets oder Layouts verändert die JavaScript-Dateien nicht mehr. Die automatische Neuerzeugung erfolgt beim Speichern einer Modulkonfiguration.
2. JavaScript-Dateien manuell erzeugen
Zusätzlich zur automatischen Erzeugung kannst du die sprachabhängigen JavaScript-Dateien manuell erstellen lassen.
Rufe dazu als Administrator die folgende Adresse auf. Ersetze die Beispieldomain durch die Adresse deines CMS:
https://xxxx.bxserver.net/bx_Mod/BxScript.phpÜber diesen Aufruf kannst du die JavaScript-Dateien unabhängig vom Speichern einer Modulkonfiguration neu erzeugen.
3. Globale Modulkonfiguration
Die globale Modulkonfiguration befindet sich unter:
bx_Mod/config_own.phpDiese Datei enthält die individuellen Einstellungen deines Projekts. Sie wird nach der Installation entsprechend den Anforderungen des Benutzers eingerichtet.
Hier wird unter anderem festgelegt, welche Module und Bereiche verwendet werden sollen, beispielsweise Shop oder Blog. Außerdem werden die aktivierten Sprachen berücksichtigt.
Die Konfiguration bildet damit eine wichtige Grundlage für die Erzeugung der sprachabhängigen JavaScript-Dateien.
4. Modulkonfigurationen und Sprachdateien
Bei der Erzeugung berücksichtigt das CMS die Konfigurationsdateien der jeweiligen Module. Dazu gehören die Standardkonfiguration, individuelle Anpassungen und sprachabhängige Texte.
Am Beispiel des Shop-Moduls sind dies:
bx_Mod/Shop/config.php
bx_Mod/Shop/config_own.php
bx_Mod/Shop/config_text_de.php
bx_Mod/Shop/config_text_de_own.phpDie Dateien erfüllen unterschiedliche Aufgaben:
config.php: Enthält die Standardkonfiguration des Shop-Moduls.
config_own.php: Enthält deine individuellen Konfigurationseinstellungen.
config_text_de.php: Enthält die standardmäßigen deutschsprachigen Texte des Shop-Moduls.
config_text_de_own.php: Enthält deine individuellen Anpassungen der deutschsprachigen Texte.
Für weitere aktivierte Sprachen werden die entsprechenden Sprachdateien berücksichtigt.
Verändere die Standarddateien möglichst nicht direkt. Verwende für individuelle Anpassungen die vorgesehenen _own-Dateien, damit deine Änderungen bei normalen CMS-Updates erhalten bleiben.
5. Standard-JavaScript und eigene Anpassungen
Die allgemeinen JavaScript-Dateien befinden sich im Entwicklerordner bx_script.
Für die zentralen JavaScript-Funktionen werden folgende Dateien berücksichtigt:
/bx_script/BxScript_own_min.js
/bx_script/BxScript_own.js
/bx_script/BxScript_own_min.jsBxScript.js ist die Standarddatei des bluetronix CMS. Sie kann bei Systemupdates überschrieben werden.
Die Dateien BxScript_own.js und BxScript_own_min.js sind für individuelle Anpassungen vorgesehen.
Diese Dateien können bei der Erzeugung der sprachabhängigen JavaScript-Dateien berücksichtigt werden.
6. Header-JavaScript und eigene Anpassungen
Neben den allgemeinen JavaScript-Dateien gibt es separate Dateien für den Header deiner Webseite.
/bx_script/BxHeadScript_own_min.js
/bx_script/BxHeadScript_own.js
/bx_script/BxHeadScript_own_min.jsBxHeadScript.js enthält die vom CMS bereitgestellten Header-JavaScript-Funktionen. Diese Standarddatei kann bei einem Systemupdate überschrieben werden.
Für eigene Anpassungen stehen dir BxHeadScript_own.js und BxHeadScript_own_min.js zur Verfügung.
Auch aus diesen Dateien werden die entsprechenden sprachabhängigen Versionen erzeugt.
7. Erzeugte JavaScript-Dateien
Aus den vorhandenen Konfigurations-, Sprach- und JavaScript-Dateien erzeugt das CMS separate Dateien für jede aktivierte Sprache.
Beispielsweise entstehen folgende allgemeine JavaScript-Dateien:
/bx_script/BxScript_de.js
/bx_script/BxScript_en.js
/bx_script/BxScript_ru.js
/bx_script/BxScript_es.jsZusätzlich werden die entsprechenden Header-JavaScript-Dateien erstellt:
/bx_script/BxHeadScript_de.js
/bx_script/BxHeadScript_en.js
/bx_script/BxHeadScript_ru.js
/bx_script/BxHeadScript_es.jsDie Sprachkürzel kennzeichnen die jeweilige Sprache. Beispielsweise steht de für Deutsch, en für Englisch, ru für Russisch und es für Spanisch.
Das CMS erzeugt nur die Dateien für die tatsächlich aktivierten Sprachen.
8. Optimierung der erzeugten JavaScript-Dateien
Während der Erzeugung werden die JavaScript-Dateien zusätzlich optimiert. Dadurch können unnötige Kommentare und überflüssige Leerzeichen entfernt werden.
Die einfache Optimierung umfasst folgende Schritte:
1. Zeilen, die mit // beginnen, werden entfernt.
2. Zeilen, die ausschließlich Leerzeichen enthalten, werden entfernt.
3. Mehrere Leerzeichen können durch ein einzelnes Leerzeichen ersetzt werden.
Eine vollständige Minifizierung ist aktuell nicht zwingend erforderlich.
Die Optimierung reduziert unnötige Inhalte innerhalb der erzeugten JavaScript-Dateien.
9. Sprachabhängige JavaScript-Dateien automatisch einbinden
Das bluetronix CMS prüft beim Erzeugen deiner Webseite, ob für die aktuell gewählte Sprache eine entsprechende JavaScript-Datei vorhanden ist.
Im HTML-Layout kann beispielsweise die allgemeine JavaScript-Datei über folgende CMS-Markierung eingebunden sein:
__FV_/bx_script/BxScript_own_min.js__Wenn der Besucher die deutsche Sprachversion deiner Webseite aufruft und die entsprechende Sprachdatei vorhanden ist, ersetzt das CMS die Markierung automatisch durch:
__FV_/bx_script/BxScript_de.js__Dasselbe Prinzip gilt für die Header-JavaScript-Datei.
Aus:
__FV_/bx_script/BxHeadScript_own_min.js__wird beispielsweise:
__FV_/bx_script/BxHeadScript_de.js__Die bestehende HTML-Einbindung muss dafür nicht für jede Sprache einzeln angepasst werden.
Ist keine passende Sprachdatei vorhanden, bleibt die allgemeine JavaScript-Datei eingebunden.
10. Browser-Cache durch Dateiänderungsdatum aktualisieren
Damit Browser nach einer Änderung nicht weiterhin eine veraltete JavaScript-Datei aus dem Cache laden, kann das CMS zusätzlich das Änderungsdatum der jeweiligen Datei verwenden.
Die eingebundene JavaScript-Datei erhält dafür einen Versionsparameter.
Beispiel:
BxScript_de.js?v=DATEI_AENDERUNGS_DATUMÄndert sich die Datei, kann sich auch der Versionsparameter ändern. Dadurch erkennt der Browser die geänderte Dateiversion und kann sie neu laden.
Dieses Verfahren kann sowohl für die allgemeinen JavaScript-Dateien als auch für die Header-JavaScript-Dateien verwendet werden.
11. Zusammenfassung
Das bluetronix CMS erstellt automatisch separate JavaScript-Dateien für jede aktivierte Sprache deiner Webseite.
Die Erzeugung erfolgt bei jedem Speichern einer Modulkonfiguration. Zusätzlich kannst du sie über bx_Mod/BxScript.php manuell starten.
Bei der Erstellung werden die globale Modulkonfiguration, die Konfigurations- und Sprachdateien der Module sowie die Standard- und eigenen JavaScript-Dateien berücksichtigt.
Im Layout erkennt das CMS automatisch, ob eine passende Sprachdatei vorhanden ist, und bindet diese anstelle der allgemeinen JavaScript-Datei ein.
Verwende für individuelle Anpassungen grundsätzlich die vorgesehenen _own-Dateien, damit deine Änderungen bei normalen Systemupdates erhalten bleiben.
FAQ
was Kunden uns häufig Fragen
Wann werden sprachabhängige JavaScript-Dateien erzeugt?
Das bluetronix CMS erzeugt die Dateien automatisch, sobald du eine Modulkonfiguration speicherst. Dabei werden die JavaScript-Dateien für alle aktivierten Sprachen neu erstellt.
Wie kann ich die JavaScript-Dateien manuell neu erzeugen?
Rufe als Administrator die Adresse https://xxxx.bxserver.net/bx_Mod/BxScript.php auf. Ersetze dabei die Beispieldomain durch die Adresse deines CMS.
Werden JavaScript-Dateien für alle verfügbaren Sprachen erzeugt?
Nein. Das CMS erstellt ausschließlich die Sprachversionen, die du über das Modul Lang aktiviert hast. Die entsprechenden Einstellungen werden in bx_Mod/config_own.php festgelegt.
Werden die JavaScript-Dateien beim Wechsel des Farbsets oder Layouts verändert?
Nein. Das Farbset beziehungsweise Layout verändert die JavaScript-Dateien nicht mehr. Die automatische Neuerzeugung erfolgt beim Speichern einer Modulkonfiguration.
Welche Dateien kann ich individuell anpassen?
Für individuelle JavaScript-Anpassungen stehen dir unter anderem BxScript_own.js, BxScript_own_min.js, BxHeadScript_own.js und BxHeadScript_own_min.js zur Verfügung. Auch die Module besitzen eigene Konfigurations- und Sprachdateien mit der Kennzeichnung _own.
Was passiert mit den Standard-JavaScript-Dateien bei einem CMS-Update?
Die Standarddateien BxScript.js und BxHeadScript.js können bei Systemupdates überschrieben werden. Deshalb solltest du eigene Änderungen ausschließlich in den dafür vorgesehenen _own-Dateien speichern.
Wie erkennt das CMS, welche JavaScript-Datei eingebunden werden muss?
Das CMS prüft beim Erzeugen der Webseite, ob für die aktuell gewählte Sprache eine entsprechende JavaScript-Datei vorhanden ist. Existiert beispielsweise BxScript_de.js, wird diese für die deutsche Sprachversion anstelle der allgemeinen Datei eingebunden.
Wie verhindere ich, dass Besucher veraltete JavaScript-Dateien aus dem Browser-Cache laden?
Das CMS kann beim Einbinden der JavaScript-Dateien zusätzlich das Dateiänderungsdatum als Versionsparameter verwenden. Dadurch kann der Browser nach einer Änderung die neue Dateiversion laden.