Version: GSB 7Namenskonventionen

Hinweis für Redakteure

Durch Einhaltung der folgenden Empfehlungen wird einerseits die Wiederauffindbarkeit von Inhalten im Redaktionssystem und andererseits die Sicherstellung von lesbaren und kurzen URLs sichergestellt.

• Ordnernamen sollten mit Großbuchstaben anfangen.
• Technische Ordner werden immer komplett in Englisch benannt.
• Dokumentnamen werden klein geschrieben (Beispiel: home).
  • Falls der Dokumentname aus mehreren Wörtern besteht, werden diese in Kleinbuchstaben und mit Unterstrich verkettet (Beispiel: homepage_hidden_node).
  • Es empfiehlt sich, bestimmte Dokumenttypen mit _ zu benennen, damit sie schneller auffindbar sind (Beispiel hidden_node). Die Dokumenttyp-Bezeichnung (z.B. node) ist ebenfalls klein zu schreiben.
  • Dokumente sollten mit möglichst kurzen Begriffen benannt werden.
• In Dokument- oder Ordnernamen dürfen keine Leerzeichen, Umlaute oder Sonderzeichen verwendet werden.
• Darüber hinaus dürfen die Ordner, die im Editor fest verankert sind, nicht umbenannt werden.

Hinweis für SiteAdministratoren

Die Konventionen für die Benennung von Ordnern und Dokumenten können individuell für einzelne Editoren in der Konfiguration des Editors definiert werden. Die Konfiguration befindet sich in der Datei __EditorConfig/Roles//config/RoleConfiguration. Das Token muss durch die mit der gewünschten Rolle verknüpfte Editor-Gruppe (bspw. editor_stdlsg_redakteur) für den Redakteurseditor der Standardlösung ersetzt werden.

Durch Definition eines regulären Ausdrucks für Dokument- bzw. Ordnernamen können individuelle Anforderungen an die Benennung innerhalb eines Mandanten umgesetzt werden. Hierzu ist jeweils das Pattern für den DocumentName bzw. FolderName anzupassen.

Die folgende Konfiguration skizziert dies anhand der Konfiguration der Standardlösung. Die regulären Ausdrücke erlauben maximal 30 Buchstaben sowie die Sonderzeichen Punkt ('.'), Unterstrich ('_') sowie Bindestrich ('-'):

Ergänzender Hinweis:

Die Anpassung der Konfiguration ist nur im GSB Editor/web möglich. Bei einem Parallelbetrieb von GSB Editor/web und JavaEditor sollte daher sichergestellt werden, dass die Validatoren mit den Möglichkeiten des JavaEditors kompatibel sind, um Problemen im Zusammenspiel der Editoren vorzubeugen.

Die Pattern für DocumentName bzw. FolderName-Pattern werden im GSBEditor/web Server gecached, so dass Änderungen an der Konfiguration erst nach einer Stunde im GSBEditor/web zur Verfügung stehen.