Zielgruppe BetriebVersion: GSB10.1Labeleditor
In einem GSB Mandanten werden für die Unterstützung von mehrsprachigen Webauftritten bzw. Funktionalitäten im Mandanten Labeldokumente (Dokumenttyp ConfigResLabel) genutzt.
Label und Labeldokumente bieten eine komfortable Möglichkeit für einzelne Zeichenketten eines Webauftrittes entsprechende Übersetzungen für alle angebotenen Sprachen definieren und in den Auftritt integrieren zu können.
So können bspw. einzelne Formularfelder eines Suchformulars in allen unterstützten Sprachen mit Hilfe eines Labels sprachspezifisch ausgegeben werden. Das Formularfeld für den Suchbegriff wird so bspw. wie folgt in der Standardlösung bezeichnet:
- Deutsch: Suchbegriff
- Englisch: search item
Der gleiche Ansatz wird auch bei Buttons, Mailbenachrichtigungen, etc. verfolgt, da das Konzept der Label und Labeldokumente durchgängig in einem GSB Mandanten für viele Funktionen und –bereiche genutzt wird.
Innerhalb eines Webauftritts sind somit viele Labeldokumente für die sprachspezifische Bezeichnung der oben skizzierten Elemente vorhanden. Die Pflege der Labeldokumente durch SiteAdmins ist aufwändig, dab bei Änderungen und Anpassungen die betreffenden Labeldokumente im Editor identifiziert und angepasst werden müssen (Dokument öffnen, ausleihen, bearbeiten, zurückgeben, publizieren).
Der Labeleditor fasst alle Labeldokumente des Mandanten zusammen und ermöglicht so die einfache Pflege an einer zentralen Stelle.
Bearbeitung der Label
Der Labeleditor kann aus der Preview heraus über den Button "Labeleditor" in der roten Statusleiste aufgerufen werden.
Der Labeleditor präsentiert sich wie folgt:
Die Labeldokumente des Mandanten werden in der tabellarischen Übersicht angezeigt. Beim initialen Aufruf werden die Dokumente aufsteigend nach ihrem Dokumentnamen sortiert in der Tabelle ausgegeben. Durch Klick auf einen der Spaltenköpfe kann die Sortierung anhand der gewählten Spalte durchgeführt werden. Bei einem erneuten Klick auf den Spaltenkopf wird die Sortierreihenfolge umgekehrt.
Durch Klick auf den Button "Spaltenauswahl" kann der Umfang der angezeigten Spalten der Tabelle angepasst werden. Hier besteht die Möglichkeit, die Anzeige der Ablage sowie der im Webauftritt unterstützten Sprachen je nach Anforderung individuell festlegen zu können.
Um ein bestimmtes Labeldokument schneller finden zu können, kann durch Eingabe eines Suchbegriffs in das Feld "Suchen" eine Volltextsuche in den Dokumenten durchgeführt werden. D.h. die Suche berücksichtigt den eingegebenen Suchbegriff sowohl in den Metadaten (Name, Ablage) als auch in den Werten für die einzelnen Sprachen.
Bearbeitung der Labeldokumente
Der Wert eines Labels kann einfach durch Klick auf die anzupassende Sprache geändert werden. Der folgende Screenshot zeigt dies exemplarisch für den deutschsprachigen Wert des Abbestellen Labels.
Durch Klick in den Wert wird automatisch ein Texteingabefeld erzeugt, so dass dieser anschließend bearbeitet werden kann. Die Änderung kann durch Klick auf den Bestätigen Button (oranger Haken) übernommen bzw. durck Klick auf den Verwerfen Button (X) rückgängig gemacht werden.
Aus technischer Sicht wird das zugrundeliegende GSB Dokument durch die skizzierte Aktion ausgeliehen und die Änderung anschließend im Dokument gespeichert.
Nachdem ein Dokument bearbeitet worden ist, wird dieses im Labeleditor als geändert gekennzeichnet, indem das betreffende Dokument in der tabellarischen Darstellung selektiert wird.
Alle bearbeiteten Labeldokumente können durch Selektion des Radiobuttons "Selektiert" ausgewählt werden, um diese in einem letzten Arbeitsschritt direkt über den Labeleditor "Zurückgeben" und zu "Publizieren".
Konfiguration Subsites
Der Hauptauftritt und alle Subsites des Mandanten müssen im Labeleditor konfiguriert werden, damit ein SiteAdmin die Label eines Auftritts über das Dropdown "Labels Übersicht" auswählen kann.
Die Definition der Sites erfolgt in dem Dokument __EditorConfig/Site/SiteAdminTools/LabelEditor/LabelEditor_script
in Form eines JSON Hashes, wobei der Key für jede Site dem Anzeigenamen im Dropdown "Labels Übersicht" entspricht und als Value der Name der Subsite oder Leerstring ("") für den Hauptauftritt definiert wird.
Die folgende Defintion skizziert dies exemplarisch für die Standardlösung
Labeleditor Site-Konfiguration:
## Site-Konfiguration#set ($sites = {"Hauptauftritt" : "" , "Subsite" : "subsite"})
Resource Label Konfiguration
Die einzelnen Labeldokumente werden in ResourceBundles
zusammengefasst, indem diese im Content des Mandanten in entsprechenden Konfigurationsdokumenten definiert werden.
Die ResourceBundle-Definition des Mandanten erfolgt im Dokument _config/ResourceBundle
. In diesem Dokument werden in der Property "Verzeichnis der Einträge" (technische Property entryDirectories
) alle Ordner aufgeführt in denen ResourceBundleEntries
abgelegt sind.
Der GSB 10.1 erfordert hier nur noch die Definition der zu berücksichtigenden Wurzelordner, d.h. ausgehend von den definierten Wurzelordnern werden ResourceBundleEntries in allen untegeordneten Ordnern ermittelt und berücksichtigt.