Taalafhankelijke JavaScript-bestanden voor CMS-modules aanmaken
Het bluetronix CMS genereert automatisch geoptimaliseerde JavaScript-bestanden voor elke geactiveerde taal van je website. Je leert hoe standaardbestanden, individuele aanpassingen en taalafhankelijke modul teksten worden samengevoegd en hoe het CMS de juiste bestanden automatisch in je website integreert.
Taalafhankelijke JavaScript-bestanden
Het bluetronix CMS kan voor elke geactiveerde taal van je website eigen JavaScript-bestanden genereren. Hierdoor zijn taalafhankelijke teksten en functies direct beschikbaar binnen het betreffende JavaScript-bestand.
De benodigde bestanden worden automatisch aangemaakt zodra je een moduleconfiguratie opslaat. Het CMS houdt rekening met zowel de standaardbestanden als je individuele aanpassingen.
Deze tutorial bouwt voort op de documentatie 'CMS-modules opnemen en aanpassen'. Je zou al vertrouwd moeten zijn met de ontwikkelaarsmap bx_Mod en het gebruik van je eigen _own-bestanden.
1. Automatische generatie van de JavaScript-bestanden
Wanneer je een moduleconfiguratie opslaat, genereert het CMS automatisch alle benodigde taalafhankelijke JavaScript-bestanden opnieuw.
Alleen de taalkeurs die je hebt geactiveerd via de module Lang worden aangemaakt.
De geactiveerde talen worden vastgelegd in de globale moduleconfiguratie:
bx_Mod/config_own.phpAls je bijvoorbeeld Duits, Engels en Spaans hebt geactiveerd, zal het CMS overeenkomstige JavaScript-bestanden voor deze drie talen aanmaken.
Een wijziging van het kleurenpalet of de lay-out verandert de JavaScript-bestanden niet meer. De automatische generatie vindt plaats bij het opslaan van een moduleconfiguratie.
2. JavaScript-bestanden handmatig genereren
Naast de automatische generatie kun je de taalafhankelijke JavaScript-bestanden ook handmatig laten aanmaken.
Als beheerder kun je hiervoor het volgende adres openen. Vervang de voorbeeld-domeinnaam door het adres van je CMS:
https://xxxx.bxserver.net/bx_Mod/BxScript.phpMet deze oproep kun je de JavaScript-bestanden onafhankelijk van het opslaan van een moduleconfiguratie opnieuw genereren.
3. Globale moduleconfiguratie
De globale moduleconfiguratie bevindt zich onder:
bx_Mod/config_own.phpDit bestand bevat de individuele instellingen van je project. Het wordt na de installatie ingesteld volgens de eisen van de gebruiker.
Hier wordt onder andere vastgelegd welke modules en gebieden moeten worden gebruikt, bijvoorbeeld shop of blog. Ook worden de geactiveerde talen in aanmerking genomen.
De configuratie vormt zo een belangrijke basis voor de generatie van de taalafhankelijke JavaScript-bestanden.
4. Moduleconfiguraties en taalbestanden
Bij de generatie houdt het CMS rekening met de configuratiebestanden van de betreffende modules. Dit omvat de standaardconfiguratie, individuele aanpassingen en taalafhankelijke teksten.
Neem als voorbeeld het shop-module:
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.phpDe bestanden vervullen verschillende taken:
config.php: Bevat de standaardconfiguratie van de shop-module.
config_own.php: Bevat jouw individuele configuratie-instellingen.
config_text_de.php: Bevat de standaard Duitstalige teksten van de shop-module.
config_text_de_own.php: Bevat jouw individuele aanpassingen van de Duitstalige teksten.
Voor andere geactiveerde talen worden de betreffende taalbestanden in aanmerking genomen.
Probeer de standaardbestanden zo min mogelijk direct te wijzigen. Gebruik voor individuele aanpassingen de voorziene _own-bestanden, zodat je wijzigingen behouden blijven bij normale CMS-updates.
5. Standaard-JavaScript en eigen aanpassingen
De algemene JavaScript-bestanden bevinden zich in de ontwikkelaarsmap bx_script.
Voor de centrale JavaScript-functies worden de volgende bestanden overwogen:
/bx_script/BxScript_own_min.js
/bx_script/BxScript_own.js
/bx_script/BxScript_own_min.jsBxScript.js is het standaardbestand van het bluetronix CMS. Dit kan worden overschreven bij systeemupdates.
De bestanden BxScript_own.js en BxScript_own_min.js zijn bedoeld voor individuele aanpassingen.
Deze bestanden kunnen worden overwogen bij het genereren van de taalafhankelijke JavaScript-bestanden.
6. Header-JavaScript en eigen aanpassingen
Naast de algemene JavaScript-bestanden zijn er aparte bestanden voor de header van jouw website.
/bx_script/BxHeadScript_own_min.js
/bx_script/BxHeadScript_own.js
/bx_script/BxHeadScript_own_min.jsBxHeadScript.js bevat de door het CMS geleverde header-JavaScript-functies. Dit standaardbestand kan worden overschreven bij een systeemupdate.
Voor eigen aanpassingen zijn BxHeadScript_own.js en BxHeadScript_own_min.js beschikbaar.
Ook uit deze bestanden worden de bijbehorende taalafhankelijke versies gegenereerd.
7. Geproduceerde JavaScript-bestanden
Het CMS genereert aparte bestanden voor elke geactiveerde taal op basis van de bestaande configuratie-, taal- en JavaScript-bestanden.
Bijvoorbeeld ontstaan de volgende algemene JavaScript-bestanden:
/bx_script/BxScript_de.js
/bx_script/BxScript_en.js
/bx_script/BxScript_ru.js
/bx_script/BxScript_es.jsDaarnaast worden de bijbehorende header-JavaScript-bestanden aangemaakt:
/bx_script/BxHeadScript_de.js
/bx_script/BxHeadScript_en.js
/bx_script/BxHeadScript_ru.js
/bx_script/BxHeadScript_es.jsDe taalkortingen geven de betreffende taal aan. Bijvoorbeeld staat de voor Duits, en voor Engels, ru voor Russisch en es voor Spaans.
Het CMS genereert alleen de bestanden voor de daadwerkelijk geactiveerde talen.
8. Optimalisatie van de gegenereerde JavaScript-bestanden
Tijdens de generatie worden de JavaScript-bestanden ook geoptimaliseerd. Hierdoor kunnen onnodige opmerkingen en overbodige spaties worden verwijderd.
De eenvoudige optimalisatie omvat de volgende stappen:
1. Regels die beginnen met // worden verwijderd.
2. Regels die alleen spaties bevatten, worden verwijderd.
3. Meerdere spaties kunnen worden vervangen door een enkele spatie.
Een volledige minimalisering is momenteel niet strikt noodzakelijk.
De optimalisatie vermindert onnodige inhoud binnen de gegenereerde JavaScript-bestanden.
9. Taalafhankelijke JavaScript-bestanden automatisch inladen
Het bluetronix CMS controleert bij het genereren van jouw website of er een bijbehorend JavaScript-bestand voor de momenteel gekozen taal aanwezig is.
In de HTML-indeling kan bijvoorbeeld het algemene JavaScript-bestand via de volgende CMS-markering worden opgenomen:
__FV_/bx_script/BxScript_own_min.js__Als de bezoeker de Duitse taalversie van jouw website oproept en het bijbehorende taaldocument aanwezig is, vervangt het CMS de markering automatisch door:
__FV_/bx_script/BxScript_de.js__Hetzelfde principe geldt voor het header-JavaScript-bestand.
Van:
__FV_/bx_script/BxHeadScript_own_min.js__wordt bijvoorbeeld:
__FV_/bx_script/BxHeadScript_de.js__De bestaande HTML-inbedding hoeft hiervoor niet voor elke taal afzonderlijk te worden aangepast.
Als er geen geschikte taaldocument aanwezig is, blijft het algemene JavaScript-bestand ingeschakeld.
10. Browser-cache bijwerken op basis van bestand wijzigingsdatum
Om te voorkomen dat browsers na een wijziging een verouderd JavaScript-bestand uit de cache laden, kan het CMS ook de wijzigingsdatum van het betreffende bestand gebruiken.
Het ingeladen JavaScript-bestand krijgt daarvoor een versienummer als parameter.
Voorbeeld:
BxScript_de.js?v=DATEI_AENDERUNGS_DATUMAls het bestand verandert, kan ook de versieparameter veranderen. Hierdoor herkent de browser de gewijzigde bestandsversie en kan deze opnieuw laden.
Deze procedure kan zowel voor de algemene JavaScript-bestanden als voor de header-JavaScript-bestanden worden gebruikt.
11. Samenvatting
Het bluetronix CMS maakt automatisch aparte JavaScript-bestanden voor elke geactiveerde taal van je website.
De generatie vindt plaats bij elke opslaan van een moduleconfiguratie. Daarnaast kun je deze handmatig starten via bx_Mod/BxScript.php.
Bij het aanmaken worden de globale moduleconfiguratie, de configuratie- en taaldocumenten van de modules en de standaard- en eigen JavaScript-bestanden in overweging genomen.
In de lay-out herkent het CMS automatisch of er een geschikte taaldocument aanwezig is en laadt deze in plaats van het algemene JavaScript-bestand.
Gebruik voor individuele aanpassingen in principe de daarvoor bestemde _own-bestanden, zodat je wijzigingen behouden blijven bij normale systeemupdates.
FAQ
wat klanten ons vaak vragen
Wanneer worden taalf specifieke JavaScript-bestanden aangemaakt?
Het bluetronix CMS maakt de bestanden automatisch aan zodra je een moduleconfiguratie opslaat. Hierbij worden de JavaScript-bestanden voor alle geactiveerde talen opnieuw aangemaakt.
Hoe kan ik de JavaScript-bestanden handmatig opnieuw genereren?
Ga als administrator naar het adres https://xxxx.bxserver.net/bx_Mod/BxScript.php. Vervang de voorbeeld domeinnaam door het adres van jouw CMS.
Worden JavaScript-bestanden voor alle beschikbare talen aangemaakt?
Nee. Het CMS genereert uitsluitend de taalkundige versies die je via de module Lang hebt geactiveerd. De bijbehorende instellingen worden vastgelegd in bx_Mod/config_own.php.
Worden de JavaScript-bestanden gewijzigd bij het wisselen van kleurenschema of lay-out?
Nee. Het kleurenschema of lay-out wijzigt de JavaScript-bestanden niet meer. De automatische regeneratie vindt plaats bij het opslaan van een moduleconfiguratie.
Welke bestanden kan ik individueel aanpassen?
Voor individuele JavaScript-aanpassingen heb je onder andere toegang tot BxScript_own.js, BxScript_own_min.js, BxHeadScript_own.js en BxHeadScript_own_min.js. Ook de modules hebben eigen configuratie- en taaldocumenten met de aanduiding _own.
Wat gebeurt er met de standaard-JavaScript-bestanden bij een CMS-update?
De standaardbestanden BxScript.js en BxHeadScript.js kunnen bij systeemupdates worden overschreven. Daarom moet je eigen wijzigingen uitsluitend in de daarvoor bestemde _own-bestanden opslaan.
Hoe herkent het CMS welke JavaScript-bestand moet worden ingeladen?
Het CMS controleert bij het genereren van de website of er voor de momenteel gekozen taal een bijbehorend JavaScript-bestand beschikbaar is. Bestaat bijvoorbeeld BxScript_de.js, dan wordt deze voor de Duitse taalversie ingeladen in plaats van het algemene bestand.
Hoe voorkom ik dat bezoekers verouderde JavaScript-bestanden uit de browsercache laden?
Het CMS kan bij het inbouwen van de JavaScript-bestanden ook de bestandswijzigingsdatum als versieparameter gebruiken. Hierdoor kan de browser na een wijziging de nieuwe bestandsversie laden.