Project

General

Profile

task #8578

report #8556: sifting of existing documentation

Discuss and find appropriate terms for major editor parts (window, view, editor, panel, pane)

Added by Andreas Kohlbecker 9 months ago. Updated 8 months ago.

Status:
Closed
Priority:
Highest
Category:
Documentation
Target version:
Start date:
10/09/2019
Due date:
% Done:

100%

Audience:

Description

In the Taxeditor documentation the term 'window' is being used as simple and common term to refer to the various top level UI components of the Taxeditor.

This term can be confusing though, since it usually refers to whole application windows and not to window like sub-components in a application.
In eclipse RCP terminology these are named view and editor

Terms as used in documentation for other software products:

In the UI the names View and Editor are being used:

picture452-1.png View (272 KB) Andreas Kohlbecker, 10/10/2019 01:02 PM

view-green.png View (8.88 KB) Andreas Kohlbecker, 10/10/2019 01:05 PM

editor-blue.png View (9.68 KB) Andreas Kohlbecker, 10/10/2019 01:05 PM

picture121-1.png View (12.9 KB) Andreas Kohlbecker, 10/10/2019 04:45 PM

Taxeditor-Terms-Poll-2019.pdf (302 KB) Andreas Kohlbecker, 11/12/2019 03:21 PM

History

#1 Updated by Andreas Kohlbecker 9 months ago

  • Description updated (diff)

#2 Updated by Andreas Kohlbecker 9 months ago

  • Description updated (diff)

#3 Updated by Andreas Kohlbecker 9 months ago

  • Description updated (diff)

#4 Updated by Andreas Kohlbecker 9 months ago

  • Description updated (diff)

#5 Updated by Andreas Kohlbecker 9 months ago

  • Description updated (diff)

#6 Updated by Andreas Kohlbecker 9 months ago

  • Description updated (diff)

#7 Updated by Andreas Kohlbecker 9 months ago

  • Description updated (diff)

#8 Updated by Andreas Kohlbecker 9 months ago

  • File picture764-1.png added
  • Description updated (diff)

#9 Updated by Andreas Kohlbecker 9 months ago

#10 Updated by Andreas Kohlbecker 9 months ago

#11 Updated by Andreas Kohlbecker 9 months ago

#12 Updated by Andreas Kohlbecker 9 months ago

  • File deleted (picture764-1.png)

#13 Updated by Andreas Kohlbecker 9 months ago

#14 Updated by Andreas Kohlbecker 9 months ago

A poll on editor terms was created on 2019-10-10 : Umfrage https://terminplaner4.dfn.de/enQ2EAH8G7jKtJev

#15 Updated by Andreas Kohlbecker 9 months ago

Mein vorläufiges Fazit aus der Umfrage ist, dass alle "Formular-Felder" Editoren sind, also auch der Details-View und "Taxon-Node-Dialog". Der Taxon Navigator oder Factual-Data-View sind ganz klar keine Editoren. Alles was sich im Hauptbereich tummelt, also grün oder blau, kann als View oder Panel bezeichnet werden. Die Präferenzen für den einen oder anderen Begriff scheint zum einen etwas mit Gewöhnung zu tun zu haben, hat aber auch wohl einen semantischen Hintergrund (siehe David).

Ich schlage vor wir bleiben bei View, das hat sich ja schon gut eingebürgert. Den Begriff Editor sollten wir aber flexibler verwenden: Alles was zur Eingabe von Daten dient, sollte als Editor bezeichnet werden können, also (Bindestiche hier nur zu Darstellungszwecken):

Name-Editor oder Name-Editor-View

Taxon-Node-Editor oder Taxon-Node-Editor-Dialog

Name-Bulk- Editor

Details-Editor oder Details-Editor-View

Dadurch sind wir flexibler und können auch den Taxon-Node-Editor z.B. in einem View anbieten, sofern das mal gebraucht wird. Ob es ein Dialog oder ein View ist ist für den Nutzer ja nicht so wichtig, denn auf die Funktion kommt es an.

#16 Updated by Andreas Kohlbecker 8 months ago

Die Umfrage ist abgeschlossen und ausgewertet (Taxeditor-Terms-Poll-2019.pdf):


Hallo zusammen,

die Umfrage (https://terminplaner4.dfn.de/enQ2EAH8G7jKtJev) ist nun abgeschlossen. Auch wenn es kein eindeutiges Ergebnis gibt, sind die abgegebenen Stimmen und Kommentare aufschlussreich und lassen ein Fazit zu, das die Möglichkeiten zur Benennung der Bereiche im Taxeditor stark einschränkt.
Nach meiner Auffassung bieten sich letztlich zwei Möglichkeiten an.

Doch zunächst zu den allgemeinen Erkenntnissen aus der Umfrage:

Alle Bereiche mit Formularen über die Daten verändert werden können sind Editoren, also auch der "Details-View" und der "Taxon-Node-Dialog". "Taxon Navigator" oder "Factual-Data-View" sind ganz klar keine Editoren. Warum daher nur der zentralen Bereich als Editor bezeichnet werden sollte ist nicht nachvollziehbar.

Alles was sich im Hauptbereich tummelt, also grün oder blau, könnte als View, Panel oder Pane bezeichnet werden. Für "View" gab es die meisten Stimmen, was wohl damit zu tun hat, dass dieser Begriff schon lange verwendet wird und sich somit unter Entwicklern und langjährigen Nutzern etabliert ist. Allerdings ist "View" aus der Perspektive eines Muttersprachlers nicht geeignet, um damit einen Bereich zu bezeichnen, über den Daten verändert werden können: "View could be interpreted to mean that the data shown there are view-only" (Nick Turland).

"Panel" wurde in der Umfrage auch präferiert, wird aber laut Oxford English Dictionary üblicherweise nicht zur Bezeichnung von Userinterface-Bereichen verwendet, auch wenn die Dokumentationen von Adobe, Krita und QGis das Gegenteil belegen. "Pane" hingegen scheint aufgrund der Definitionen im Oxford English Dictionary ein recht gut passender Begriff zu sein. Allerdings zeigt sich bei einer Recherche auch, dass beide Begriffe so oft falsch verwendet wurden, so dass die Festlegung auf den Einen oder Anderen Begriff aus dieser Sicht nicht zwingend notwendig erscheint.
Panel wird im allgemeinen für sogenannte Bedienfelder zur Steuerung einer Anwendung verwendet, für Editoren passt er anscheinend weniger gut.
Auch "Frame" wurde in der Umfrage vorgeschlagen, dieser Begriff hat jedoch meistens einen Bezug zu Webseiten und scheint im Zusammenhang mit einer Desktop-Anwendung nicht passend zu sein.

Das Fazit aus all diesen Erwägungen ist, dass der Begriff Editor weiter gefasst werden sollte: Alles was zur Eingabe von Daten dient, sollte als Editor bezeichnet werden.

Alle Bereiche, ob Editor oder solche die nur Daten anzeigen, können als "View" oder "Pane" bezeichnet werden. "Panel" ist auch möglich, aber nicht optimal, wenn es sich bei dem Inhalt um einen Editor handelt. "View" ist als Begriff etabliert.

"Pane" wäre der passendste weil er am flexibelsten anwendbar ist und und keinen Widerspruch zum Inhalt darstellt, egal ob Editor oder reine Anzeige (=view). Also alle "Panes" mir denen Daten editiert werden können sind "Editors" die anderen "Views".

Oder wir machen es einfacher und sprechen nur von "Editor" und "View". Dadurch würde der "Details View" zum "Details Editor", so wie wir dann auch vom "Supplemental Data Editor" sprechen würden. Diese Möglichkeit würde die wenigsten Änderungen an bestehenden Labels und der Dokumentation nach sich ziehen und der Begriff "Pane" würde nur selten auftauchen, nämlich dann, wenn er als Oberbegriff für "View" und "Editor" gebraucht würde.

Allen die sich an dem Poll beteiligt habe ein herzliches Danke schön!

Viele Grüße
Andreas


#17 Updated by Andreas Kohlbecker 8 months ago

  • Subject changed from Improve term 'window' in documentation to Discuss and find appropriate term for major editor parts

#18 Updated by Andreas Kohlbecker 8 months ago

  • Subject changed from Discuss and find appropriate term for major editor parts to Discuss and find appropriate terms for major editor parts (window, view, editor, panel, pane)
  • Status changed from New to Closed
  • Priority changed from New to Highest
  • % Done changed from 70 to 100

This task in complete since we have now a good naming strategy which should be acceptable for almost anybody:

"... sprechen nur von "Editor" und "View". Dadurch würde der "Details View" zum "Details Editor", so wie wir dann auch vom "Supplemental Data Editor" sprechen würden. Diese Möglichkeit würde die wenigsten Änderungen an bestehenden Labels und der Dokumentation nach sich ziehen und der Begriff "Pane" würde nur selten auftauchen, nämlich dann, wenn er als Oberbegriff für "View" und "Editor" gebraucht würde."

Also available in: Atom PDF

Add picture from clipboard (Maximum size: 40 MB)