Terminology - notand/angular-tour-of-heroines GitHub Wiki

Terminology, controlled vocabulary

Use consistent terminology. Always use the same term for the same meaning. Consistency makes understanding easier for readers, because references are semantically clear. A manual is not a novel. Consistency also helps a lot during translation.

This list defines some key terms. The list is not comprehensive. For some terms, we have not found a well suited term yet. We still list them here, together with the thoughts we had about these terms. We hope this is of some help for translators of the manual.

Predefined translations

GUI terms (Graphical User Interface)

For ediarum specific terms of the Oxygen GUI, the corresponding terms in the target language are predefined. Ask your software developer for the ediarum localization file. For general GUI terms of Oxygen, install Oxygen in the target language and check the GUI.

For ediarum specific terms of the eXist-db GUI, use the German term. For general GUI terms of the eXist-db, use the English term.

In the XML files, GUI terms are marked with the <uicontrol> tag.

Not to be translated

The following terms should not be translated. Most of them are product names.

In the XML files, these terms are marked with the <keyword> tag. However, there can be terms marked as that you need to translate.

  • ediarum
    • Immer klein schreiben, außer am Satzanfang oder wenn es im GUI groß geschrieben wird.
  • ediarum.BASE.edit
  • ediarum.DB
  • ediarum.REGISTER.edit
  • ediarum.WEB
  • eXist-db
  • Oxygen
    • Oxygen XML Author
    • Oxygen XML Editor

General vocabulary DE

  • Arbeitsordner
    • für den Ordner, in dem die Frameworks liegen
  • Anmeldedaten
    • für "Credentials"
  • Autor-Modus
    • für den Autor-Modus in Oxygen
    • Woher kommt das, dass wir "Modus" sagen? Hat sich das bei uns so etabliert, oder redet Oxygen so darüber? Evtl. wäre "Autor-Ansicht" besser? In der Oxygen-Doku wird die Bezeichnung "several editing modes" verwendet (Author, Grid, Text). Vielleicht ist "Ansicht" trotzdem verständlicher.
    • nicht: Author Modus (EN)
  • Basis-Setup
  • Dashboard (der eXist-db)
  • Datenbankverbindung
    • für die WebDAV-Verbindung zwischen Oxygen und eXist-DB
    • nicht: "-anbindung"
  • DTA-Basisformat
  • DTABf
  • Dokumententypen
  • ediarum-Register
    • für standardmäßig in ediarum.DB enthaltene Register
  • ediarum._.edit-Frameworks
    • Wenn man von allen Frameworks reden will, die "edit" am Ende haben
  • (Ihr) editionsspezifisches Framework
  • Editor/in
  • "eXist-App ediarum.DB" versus "ediarum App"
    • Achtung: Im eXist-GUI ist die App als "ediarum" gelabelt.
    • In folgenden Fällen kann "ediarum App" verwendet werden:
      • Wenn der Handlungskontext das eXist Dashboard ist, wo das Icon für die ediarum-App angezeigt wird. Hier ist es sinnvoll, dass das Icon "ediarum" heißt und nicht "ediarum.DB".
      • Verkürzte Benennung als "App" erlaubt, wenn es im nahen textlichen Kontext schon mehrmals genannt wurde.
  • eXist-App Package Manager
  • Framework-Ordner
    • für einen Ordner, in dem ein Framework liegt. Der Ordner ist ein Unterordner des Arbeitsordners.
  • klonen
  • Oxygen-Arbeitsumgebung
  • Projekt
    • für Projekt in eXist
    • für Projekt in Oxygen
    • "Projekt" ist in diesen beiden Software-Produkten ein zentrales Konzept, welches für das Verständnis und für die Anwendung von ediarum wichtig ist. Wenn möglich im Text insgesamt den Term "Projekt" nicht noch für weitere, andere Bedeutungen verwenden.

To be discussed DE

  • ?? an andere weitergeben
    • für die projektspezifischen Einstellungen, das Framework, das Add-On
    • Ändern?! In Englisch wäre das "to distribute" von "Distribution". "an andere" ist auch nicht so toll. Im technischen Sinne ginge es um andere Oxygen-Instanzen. Aus Benutzer/innensicht um andere Editor/innen. --> Vllt. "für Nutzer zur Installation bzw. Update bereitstellen"
    • Für diejenigen, die bei einer wissenschaftlichen Edition die Editionsarbeit machen. Also aus DH-Entwickler-Sicht die Enduser von ediarum.
    • Bessere Idee? Vielleicht mit irgendeine Attribut/Adjektiv, in die Richtung "wissenschaftliche/r Editor/in"?
    • Kann leider im technischen und XML-Kontext leicht missverstanden werden, da Oxygen ein Editor für XML ist usw.
  • Benutzungsoberfläche? Editionsansicht? GUI? Eingabeoberfläche?
    • einerseits für das Oxygen-GUI, das durch Frameworks verändert wird. Andererseits im allgemeinen Sinne, z.B. wenn man darüber reden will, dass für die Definition von Aktionen und Operationen ein GUI bereitsteht, sodass man nicht direkt in der .framework-Datei herumschreiben muss
  • ?? Datenbaum
  • ?? "XML-Daten" versus "XML-Dateien"
    • "Menge an XML-Dateien"?
    • Welche Benennung macht aus inhaltlicher Sicht mehr Sinn? Beispielkontexttext: "In eXist-db kann man mithilfe eines Templating-Systems Webanwendungen aus den XML-Daten generieren. Diese Webanwendungen heißen "Apps"."
  • Webausgabe? Web-Publikation? ...?
    • für die Kernfunktionalität von ediarum.web, analog zu "Arbeitsumgebung" für ediarum.BASE.edit und ediarum.REGISTER.edit

GUI vocabulary DE

Role model: Microsoft Style Guide

  • Button

  • Feld

  • Formulierungen für Klicken:

    • Klicken Sie das Icon xy an.
      • für Bild-Icons
    • Klicken Sie den Button xy an.
      • für Buttons mit Icon (ohne Textlabel)
  • Klicken Sie auf OK.

    • für Buttons mit Textlabel.
  • Wählen Sie das Menü xy>abc aus.

  • Ziehen Sie die Datei xy von A nach B.

    • für Drag&Drop
  • Machen Sie xy im nun geöffneten Fenster ABC.

    • Möglichst immer "Fenster, Button" oder ähnliches mit nennen, in derselben Reihenfolge wie im Beispiel angegeben.
  • Wählen Sie xy aus.

    • Wenn man in einer Liste etwas anklicken muss um es für nachfolgende Aktionen auszuwählen. Und es dann ge-highlighted ist oder sich daneben eine bestimmte Ansicht öffnet (wie im Dokumenttypen-Zuordnung-Fenster).

Gender DE

  • Editor:innen
    • to include non-binary genders
    • "*" may lead to trouble when the manual content is transformed to Markdown (which might be advisable for some easy-to-use publication workflows)
    • "_" is used in this manual for file naming.
⚠️ **GitHub.com Fallback** ⚠️