Benennungskonventionen

Eine systematische und klare Benennung von digitalen Entitäten hilft, diese zu interpretieren, eindeutig unterscheiden und zuordnen zu können. In OES-Anwendungen ist eine aussagekräftige Benennung vor allem bei der URL und den Mediendateien entscheidend. Die Regeln für Benennungen können bei Bedarf in einer Konvention festgehalten werden.

1. Benennung der URL

Die URL (für Uniform Ressource Locator) ist die eindeutige Adresse einer Webseite. Eine ‚gute‘ URL sollte möglichst kurz und interpretierbar sein, also verdeutlichen, was auf der Seite zu finden ist. Die URL der Startseite der OES-Demo bspw. ist in diesem Sinne eine ‚gute‘ URL: https://demo.open-encyclopedia-system.org/

Eine URL besteht vereinfacht dargestellt aus folgenden Teilen:

Die Benennung des letzten Teils (Datei oder Slug) ergibt sich in OES automatisch aus dem Titel des zuvor angelegten Datenobjekts. Dieser Teil der URL ist der „sprechende“ Teil, der den Nutzenden Aufschluss über den Inhalt des Posts gibt, und kann im rechten Seitenmenü der Redaktionsumgebung unter ‚URL‘ oder im Quick-Edit-Modus nachbearbeitet und so bei Bedarf optimiert werden.

Folgende Tipps gibt es für die Benennungen von Slugs:

  • Hauptstichwort des Inhalts des Posts nutzen
  • möglichst kurz halten
  • Überflüssiges wie z. B. Füllwörter vermeiden
  • Wortgruppen durch Bindestriche (nicht Unterstriche) trennen
  • Klein- statt Großschreibung

2. Benennung von Dateien

In den OES-Anwendungen werden alle hochgeladenen Medien und Dateien in der Mediathek gespeichert. Um die Mediathek möglichst übersichtlich und schlank zu halten, sollte eine doppelte Ablage von Medien vermieden und klare Dateinamen vergeben werden. Eine hilfreiche Maßnahme hierfür kann die Verwendung einer Benennungskonvention sein. Konsistent benannte Dateien sind leichter zu finden, und so lässt sich schneller prüfen, ob ein Medium bereits hochgeladen worden ist.

Beispiele:

zu 1. URL bei DATA AFFAIRS

Der Titel eines Glossareintrags bei DATA AFFAIRS lautet: Creative-Commons-Lizenzen (CC-Lizenzen). OES übernimmt bis auf die Sonderzeichen alle Zeichen, trennt die Wörter mit Bindestrichen und generiert automatisch bei der Speicherung den Slug ‚creative-commons-lizenzen-cc-lizenzen‘.

Da dieser redundante Informationen enthält und sehr lang ist, wurde er unter ‚Quick Edit‘ gekürzt.

Die so bearbeitete URL https://data.affairs.affective-societies.de/glossary/creative-commons-lizenzen/ ist nun eine sprechende und interpretierbare URL und die Lesenden können sich erschließen, was sie dort erwartet.

zu 2. Benennungskonvention für Dateien

Bestandteile des Dateinamens können z. B. sein:

  • ggf. Rubrik/Thema o. ä.
  • Kurztitel (beschreibt den Inhalt)
  • ggf. Nummerierung (bei Bildern einer Serie)
  • ggf. Versionsnummer
  • ggf. auch urhebende Person

Benennungskonvention für Bilder aus DATA AFFAIRS:
Thema_Kurztitel.Endung

  • ano_pseudo_anonymisierung.png
  • ano_pseudo_original.png
  • ano_pseudo_pseudonymisierung.png

Citation

„Benennungskonventionen “,Version 2.2. In: OES Demo. Published by Center for Digital Systems, Freie Universitu00e4t Berlin,