diff --git a/add/data/locale/edirom-lang-de.xml b/add/data/locale/edirom-lang-de.xml index 60ea4146..1ca78817 100644 --- a/add/data/locale/edirom-lang-de.xml +++ b/add/data/locale/edirom-lang-de.xml @@ -68,8 +68,8 @@ - - + + @@ -138,14 +138,14 @@ - + - + - - - + + + diff --git a/add/data/locale/edirom-lang-en.xml b/add/data/locale/edirom-lang-en.xml index 5f94ad18..0bbdddbb 100644 --- a/add/data/locale/edirom-lang-en.xml +++ b/add/data/locale/edirom-lang-en.xml @@ -145,7 +145,7 @@ - + diff --git a/add/data/xql/getHelp.xql b/add/data/xql/getHelp.xql index ca07c860..7384991e 100644 --- a/add/data/xql/getHelp.xql +++ b/add/data/xql/getHelp.xql @@ -21,11 +21,15 @@ declare option output:omit-xml-declaration "yes"; let $lang := request:get-parameter('lang', 'en') let $idPrefix := request:get-parameter('idPrefix', '') -let $contextPath := request:get-context-path() let $base := replace(system:get-module-load-path(), 'embedded-eXist-server', '') (:TODO:) let $doc := doc(concat('../../help/help_', $lang, '.xml')) +let $contextPath := if(starts-with(document-uri($doc), '/db')) + then substring-after(document-uri($doc), '/db') + else document-uri($doc) +let $contextPath := substring-before($contextPath, concat('help/help_', $lang, '.xml')) +let $contextPath := request:get-context-path() || $contextPath let $xsl := doc('../xslt/edirom_langReplacement.xsl') let $doc := @@ -43,7 +47,6 @@ let $doc := - (: == passing empty value for docUri (XSLT expects xs:anyURI, but ExtJS view does not provide value) -> github#480 == :) diff --git a/add/help/help_de.xml b/add/help/help_de.xml index 0ed8cdf4..8dddc0f2 100644 --- a/add/help/help_de.xml +++ b/add/help/help_de.xml @@ -4,47 +4,33 @@ - <term type="ediromGui" key="global_appName"/> Help - - Benjamin W. Bohl - DFG-Projekt "Digitale Musikedition" (Edirom) -
- Musikwissenschaftliches Seminar Detmold/Paderborn - Gartenstraße 20 - D-32756 Detmold -
-
-
- - Daniel Röwenstrunk - Freischütz Digital -
- Musikwissenschaftliches Seminar Detmold/Paderborn - Gartenstraße 20 - D-32756 Detmold -
-
-
+ <term type="ediromGui" key="global_appName"/> Hilfe + + Author + Benjamin W. Bohl + Daniel Röwenstrunk + Kristin Herold + + + Translation + Anna Maria Neubert +
- Virtueller Forschungsverbund Edirom - - - - + Virtueller Forschungsverbund Edirom + + Creative Commons Attribution 4.0 International (CC BY 4.0) + -

Written in Open Office by Edirom Project http://www.edirom.de. Converted to TEI P5 using oxgarage, see

+

Written in Open Office by Edirom Project (DFG) https://edirom.de/edirom-projekt/. Converted to TEI P5 using oxgarage, see

- - - - * replaced existing german help with currently better english version; - * translated en to de; - * translated en to de; - * translated en to de; + replaced existing german help with currently better english version; + translated en to de; + update metadata (add orcid, delete old addresses etc.) + delete deprecated content (eg installation from DVD), sum up text, delete duplicate text, re-structure, shorten and simplify sentences, resolve comments
@@ -52,996 +38,466 @@ Hilfe (Bedienungsanleitung) -

Dieses Dokument enthält eine allgemeine Einführung in die Benutzung von und beschreibt die grundlegenden Funktionen der Software. Möglicherweise sind nicht alle Optionen, die im Folgenden beschrieben werden in jeder Edition verfügbar. - Dies ist unter anderem der Tatsache geschuldet, dass Inhalte projektspezifisch angelegt werden und jede Edition, die benutzt, den individuellen Editionsrichtlinien und - konzepten unterliegt. - Des Weiteren kann es aus editions-spezifischen Gründen sein, dass manche Versionen mehrere Optionen und Erweiterungen enthalten, die nicht in diesem Dokument aufgeführt und erklärt sind.

+

Dieses Dokument enthält eine allgemeine Einführung in die Benutzung von . Es beschreibt die grundlegenden Funktionen der Software. Möglicherweise sind nicht alle Optionen, die im Folgenden beschrieben werden in jeder Edition verfügbar, + da Inhalte projektspezifisch angelegt werden und jede Edition ihren individuellen Editionsrichtlinien unterliegt. + Des Weiteren ist es aus editionsspezifischen Gründen möglich, dass manche Versionen Erweiterungen enthalten, die nicht in diesem Dokument aufgeführt und erklärt sind.

-
- - - - - - - -
- Vorbereitung -
- Installation -

wurde als eine Web-Anwendung entwickelt und muss deshalb auf einem Server aufgesetzt werden. - Sollten Fragen auftauchen, wie auf einem Server aufgesetzt werden muss, kann das Edirom Projekt (http://www.edirom.de) kontaktiert werden.

-

Nichtsdestotrotz kann eine auf basierende Edition aber auch auf anderen Datenträger gespeichert und verbreitet werden. - Dies erfordert jedoch die lokale Installation auf einem Computer. Sollte die vorliegende Version der eine solch verbreitete - Ausgabe sein, kann der entsprechende Autor oder Verlag kontaktiert werden, um weitere Informationen rund um die Installation auf dem Computer zu erhalten.

- - - -
-
- Start der Anwendung -

wurde als eine Web-Anwendung entwickelt. Die einzige Systemvorgabe, um vernünftig ausführen zu können, ist die Installation eines Javascript-fähigen Browsers.

-

Sollte die aktuelle Version von installiert werden müssen, kann rund um Fragen, die die Installation auf dem persönlichen Rechner betreffen, der entsprechende Autor oder Verlag kontaktiert werden.

- -
-
- - + + +
- Benutzeroberfläche -

Die Benutzeroberfläche von ist in verschiedene Abschnitte geteilt. Am oberen und unteren Rand des Fensters befindet sich die und die , durch die alle wichtigen Funktionen der Anwendung erreicht werden können. - Der Bereich zwischen den beiden Leisten ist der , und in der rechten oberen Ecke des Fensters befindet sich der .

+ Anwendungsoberfläche +

Die Anwendungsoberfläche von besteht aus verschiedenen Bereichen. Am oberen Rand befindet sich die , am unteren Rand die . + Der Bereich dazwischen ist der , innerhalb dessen alle innenliegenden Anwendungsfenster geöffnet werden um den Inhalt einer Edition anzuzeigen und Zugang zu weiteren Funktionen zu erhalten. Rechts befindet sich die . +

- - Eine exemplarische Ansicht des Fenster, das die (oben), die (unten), den , und den (rechts oben) zeigt. + + Eine exemplarische Ansicht des Fensters, das die (oben), die (unten), den und die (rechts) zeigt.
- +
+

Am linken Rand der befindet sich ein Link zur . + Daneben ist die . Diese ermöglicht eine Auswahl der verschiedenen enthaltenen Werke innerhalb einer Edition und versucht damit den Aufbau eines "klassischen" gedruckten Editionsbandes mit mehreren enthaltenen Werken nachzuempfinden. Die und damit das Verpacken mehrerer Werke in eine Edition (analog früherem Editionsband) wird in neueren Versionen seltener verwendet und an deren Stelle erscheint der Name der einzelnen Werk-Edition. + Rechts befindet sich die Eingabe für die und ein Button, der ein -Fenster öffnet. +

- - Detailansicht der . + + Detailansicht der mit und für die Werkauswahl (links) und dem Suchfeld (rechts). -
-

Beispiel der , mit dem , und der Kombobox für die am linken Rand der Leiste und dem am rechten.

-

- Am linken Rand der befindet sich der , daneben ist die Kombobox um die der gleichen Edition zu treffen; am rechten Ende befindet sich das um Inhalte zu finden. -

-
+
- + +

Das Fenster kann durch das Klicken des -Buttons (Lupe) in der oder durch die Eingabe einer Suchanfrage in das geöffnet werden. + Es wird eine text-basierte Suche auf allen Inhalten der Edition ausgeführt.

- -

Der öffnet den Startdialog der Anwendung erneut.

-
-
-
- Auswahl der Werke -

Das nächste Element ist eine Kombobox, die alle in der Edition enthaltenen Werke auflistet. - Wenn die vorhandene mehr als ein Werk enthält, kann immer zwischen den verschiedenen Komponenten gewechselt werden. - Sollte ein anderes Werk ausgewählt werden, werden die Inhalte der sowie der neu angepasst. - Die Inhalte des s werden ebenfalls dementsprechend angepasst.

-

Alle anderen Fenster, die Auszüge des zuletzt geöffneten Werkes beinhalten, bleiben je nach Einstellungen geöffnet (weitere Ausführung unten).. - Diese Option erlaubt den direkten Vergleich der verschiedenen Quellen miteinander. Trotzdem bleibt zu beachten, dass die -Navigationsoptionen (vgl. ) nur die Inhalte des aktuell ausgewählten Werkes beeinflussen, wohingegen geöffnete Inhalte anderer Werke nicht betroffen sind.

- -
-
- - - + + Detailansicht vom : Ein Klick auf die Lupe löst den Befehl aus. + +

Nachdem eine Suchanfrage ausgeführt wurde, werden alle Ergebnisse mit entsprechenden Inhalten (Textdokument, Annotation, usw.) gruppiert. + Einzelne Suchergebnisse werden gegebenenfalls extra hervorgehoben. + Sollte eine Suchanfrage mehr als drei Treffer pro Eintrag ergeben, erscheint ein Zeige alle Treffer Link.

- -

Wenn die vergrößernde Lupe geklickt wird, wird das geöffnet. Sollte eine Anfrage in das direkt in der Menüleiste eingegeben werden, kann direkt im Suchfeld gearbeiten werden, wohingegen besagter Button die Suche nur öffnet. - Die genaue Funktionen des Suchfensters, können in folgendem Kapitel nachgelesen werden ().

+ + Das Fenster
- +
-

In der rechen Ecke des s, direkt unter dem , befindet sich der . - Der enthält eine editionsspezifische Liste von Objekten, die in potenziellen Kategorien organisiert sind. - Wenn ein Element in der Liste angeklickt wird, wird das dazugehörige Objekt im Fenster des Workspaces geöffnet.

+

Rechts auf dem befindet sich die . + Die enthält eine editionsspezifische Liste von Objekten, die in Kategorien organisiert sein können. + Wird ein Element in der Liste angeklickt, öffnet sich das dazugehörige Objekt in einem Fenster des .

- - Ein exemplarischer Navigator. Zu Beachten ist die Leiste am rechten Rand. + + Eine exemplarische
-

Falls der Navigator viele Objekte beinhaltet, gibt es die Möglichkeit mit dem Scrollbalken am rechten Rand des Fensters durch die Inhalte zu navigieren. - Sollte ein Maus mit Scrollrad vorhanden sein, ist es ebenfalls möglich mit diesem zu scrollen.

-

Obwohl der immer fest an der oberen rechten Ecke des Fenster fixiert bleibt, ist es möglich das Fenster absichtlich zu verändern. - Ebenfalls ist es möglich den per an der linken oder unteren Kante zu einem schmalen Balken unterhalb des s zu verkleinern.

+

Beinhaltet die viele Objekte, kann mit dem Scrollbalken am rechten Rand des Fensters durch die Inhalte navigiert werden. + Die ist fest an der oberen rechten Ecke fixiert, kann aber per an der linken oder unteren Kante in der Größe verändert werden.

- -
- - - -

Der ist der Bereich zwischen der und der . - Innerhalb dieses Bereiches werden alle innenliegenden Anwendungsfenster geöffnet und arrangiert um den Inhalt einer Edition anzuzeigen und weiteren Zugang zu den Funktionen der Anwendungen zu erhalten. - Die innenliegenden Anwendungsfenster können nicht aus diesem Bereich gezogen werden. Für weitere Details, siehe .

-
- - -
+ +
+

Durch die am unteren Rand des s kann auf die globalen inhaltsbezogenen Funktionen auf der linken Seite sowie die Meta-Funktionen auf der rechten Seite zugegriffen werden.

- - Detaillierte Ansicht der - + + Detaillierte Ansicht der
-

Durch die am unteren Rand des s kann auf die inhaltsbezogenen Funktionen auf der linken Seite sowie die Meta-Funktionen auf der rechten Seite zugegriffen werden.

-
- - - -
- -

Wenn dieser Knopf geklickt wird, wird die Anordung aller offenen Fenster in die Abschnitte eines Rastergitters unterstützt.

+

Die drei ersten Buttons links steuern die unterschiedliche Anordnung aller geöffneten Inhaltsfenster auf dem .

+
+ +
-
-
- - - -
- -

Wenn dieser Knopf geklickt wird, wird die Anordung aller offenen Fenster in horizontale Reihen unterstützt.

+
+ +
-
-
- - - -
- -

Wenn dieser Knopf geklickt wird, wird die Anordung aller offenen Fenster in vertikale Reihen unterstützt.

+
+ +
-
-
- - - -
- -

Wenn der -Knopf geklickt wird, wird die Anzeige bzw. das Verstecken von Taktnummern in allen Fenstern unterstützt.

+

Die Takte von Faksimiles und Noteneditionen sind meistens mit Taktnummern versehen, diese können mit dem vierten Button von links für alle geöffneten Fenster mit musikalischem Inhalt ein- und ausgeblendet werden.

+
+ +
-
-
- - - -
- -

Wenn dieser Knopf geklickt wird, wird die Anzeige bzw. das Verstecken von Annotationssymbolen global in allen Fenstern unterstützt. Für weitere Details, siehe .

-

Allerdings können die Filteroptionen für die Annotationen (siehe ) nur in den jeweiligen zu individuellen Fenstern konfiguriert werden.

+

Noteneditionen bzw. Faksimiles und Librettoeditionen können Anmerkungen enthalten, die durch Annotationssymbole geöffnet werden können. + Mit dem Sprechblase-Button lassen sich . + Anmerkungen können Prioritäten und Kategorien zugeordnet sein. Das Filtern von Anmerkungen nach diesen Prioritäten und Anmerkungen ist über den globalen Button in der nicht möglich, sondern nur über die Auswahl an einem individuellen Fenster.

+
+ + +
+

Der Button mit den zwei horizontalen Pfeilen löst den Befehl aus und es öffnet sich der Navigator für , Details zur Bedienung des Konkordanz-Navigators finden sich im entsprechenden Abschnitt.

+
+ + +
+

Am rechten unteren Rand kann mit dem Fragezeichen-Button die geöffnet bzw. in den Vordergrund verschoben werden.

+
+ +
-
-
- - - -
- -

Wenn dieser Knopf geklickt wird, wird das Öffnen eines neuen Desktop in unterstützt. Damit wird ein komplett neues Set von Fenstern geöffnet, ohne den Inhalt des aktuellen Desktops zu verändern.

-
-
-
- - - -
- -

Wenn dieser Knopf geklickt wird, wird das -Fenster geöffnet.

-
-
- -
- - - -
- -

Wenn dieser Knopf geklickt wird, wird das Hilfe (Edirom User Manual) angezeigt bzw. in den Vordergrund verschoben.

-
-
- -
- - - -

Das Fenster kann entweder durch das Klicken des -Knopfs (vergrößernde Lupe) in der oder durch die Eingabe einer Suchanfrage in das geöffnet werden. - Es wird sodann eine text-basierte Suche auf allen Inhalten der Edition ausgeführt.

-
- -
-

Nachdem eine Suchanfrage ausgeführt wurde, werden alle Ergebnisse mit entsprechenden Inhalten (Textdokument, Annotation, usw.) gruppiert. - Einzelne Suchergebnisse werden gegebenenfalls extra hervorgehoben.

- -

Wenn ein Titel bzw. ein hervorgehobenes Suchergebnis geklickt wird, wird der entsprechende Inhalt geöffent und alle Suchergebnisse hervorgehoben.

-

Sollte eine Suchanfrage mehr als drei Treffer pro Eintrag ergeben, erscheint ein Zeige alle Treffer Link.

- - -
- - - -
- - - -

Der bietet einen schnellen Einstieg zu allen Objekten der Edition. - Diese können per Mausklick in einem neuen im aktuellen geöffnet werden.

- -
- - Beispiel eines Navigators. Zu beachten ist der Rollbalken auf der linken Seite. -
-

Die Zahl der Objekte, die im angezeigt werden, können die Größe des Feldes überschreiten. - In diesem Fall erlaubt eine Scrollleiste an der rechten Seite des Fenster durch die weiteren Inhalte des zu navigieren. - Das Scrollrad der Maus kann auch hier wieder eingesetzt werden.

-

Obwohl der in der rechten Ecke des Fensters fixiert ist, lässt er sich in seiner Größe verändern und per an der linken oder unteren Kante zu einem schmalen Balken unterhalb des verkleinern.

-
- - +
-

Der ermöglicht die Navigation innerhalb der Konkordanzen. - Dabei wird der Inhalt der aktuell geöffneten Fenster verändert, die in Zusammenhang mit den Konkordanzen stehen.

-

Variierende Konkordanzen können über ein Drop-Down-Menü ausgewählt werden. - Des Weiteren kann durch Sätze usw. durch ein zweites Drop-Down-Menü navigiert werden. - Sollte die ausgewählte Konkordanz noch weitere Untergliederungen, wie z.B. Sätze, beinhalten, wird ein zweites Drop-Down-Menü zur Auswahl erscheinen.

-

Danach erscheint ein Reiter mit Nummern, die die aktuelle Verbindung aufzeigen. Diese können angeklickt werden, um das Ziel angezeigt zu bekommen. - Die Pfeilköpfe können genutzt werden um Schritt für Schritt vor- bzw. rückwärts zu navigieren.

- -

mehrere Konkordanzen und editions spez

+

Der Navigator für ermöglicht das quellenübergreifende Navigieren in allen entsprechenden Faksimiles bzw. der Edition. + Ein weiteres Beispiel der Anwendung ist die Konkordanz von Partituren und den dazugehörigen Versen eines Librettos um die musikalischen Anweisungen neben den bestimmten Verszeilen gleichzeitig betrachten zu können. + Das Vorhandensein der besagten Konkordanzen ist jedoch von der jeweiligen Edition abhängig. + Sollte die ausgewählte Konkordanz weitere Untergliederungen, wie z.B. Sätze, beinhalten, wird ein zweites Drop-Down-Menü zur Auswahl erscheinen. +

- - + + - mit und ohne den zusätzlichen Drop-Down-Menüs. + mit und ohne zusätzliches Drop-Down-Menü.

Unter der Schiebeleiste befindet sich der Knopf . Dieser muss geklickt werden, um den ausgewählten Takt in allen offenen Quellen des Desktops zu öffnen. - Es kann auch vor- bzw. rückwärts auf Taktebene innheralb der Quellen navigiert werden, in dem die Pfeile rechts und links des -Knopfs verwendet werden. - Je nach privater Einstellung werden nur Fenster, die bereits geöffent sind beeinflusst. - Sollte der ausgewählt Takt aber in anderen Quellen vorkommen, die aktuell nicht geöffnet sind, erscheint unten rechts ein Knopf, der alle weiteren Quellen öffnet und die Fenster neu ordnet .

-

Ein üblicher Einsatz dieser Funktion ist das Aufzeigen der Takt-Konkordanzen eines bestimmten Taktes, die dann in allen Faksimiles bzw. Partituren des aktuellen Werkes in der geöffnet werden. - Wenn das ausgewählte Werk mehr als einen Satz hat, kann durch das Drop-Down-Menü der gewünschte ausgewählt werden. - Die Schiebeleiste gibt die Möglichkeit einen Takt auszuwählen, der dann durch das Klicken des -Knopfs angezeigt wird.

-

Ein weiteres Beispiel der Anwendung ist die Konkordanz von Partituren und den dazugehörigen Versen eines Librettos um die musikalischen Anweisungen neben den bestimmten Verszeilen gleichzeitig betrachten zu können. - Das Vorhandensein der besagten Konkordanzen ist jedoch von der jeweiligen Edition abhängig.

-
+ Es kann auch vor- bzw. rückwärts auf Taktebene innerhalb der Quellen navigiert werden, indem die Pfeile rechts und links des -Knopfs verwendet werden. + Sollte der ausgewählte Takt aber in anderen Quellen vorkommen, die aktuell nicht geöffnet sind, erscheint unten rechts ein Knopf, der alle weiteren Quellen öffnet und die Fenster neu ordnet.

+
- +
Fenster mit Inhalt -

Fenster mit Inhalt können innerhalb der Anwendung wie in jedem normalen Systemfenster manipuliert und angepasst werden. - Entlang der oberen Kante des Fensters befindet sich eine Zeile, die den Titel des geöffneten Objekts anzeigt.

-

Unter der Titelzeile hat jedes Fenster eine . - Am linken Rand des Fensters befindet sich die , mit der zwischen verschiedenen gewechselt werden kann. - Mit den verschiedenen können unterschiedliche Perspektiven des aktuell geöffneten Fensters angezeigt werden (z.B. , , , etc.). - Am unteren Rand jedes Fenster kann die auftauchen, die verschiedene Werkzeuge zum Manipulieren der verschiedenen Objekte bereitstellt. - Die Verfügbarkeit der ist dynamisch und hängt von den jeweilig angezeigten Objekten ab. - Zum Beispiel:

- - - Das ist Standard für alle Fenster, die mehrere Ansichten beinhalten und ermöglicht den Wechsel zwischen verschiedenen Sichten. - -

Das Konzept im Umgang mit den verschiedenen Objekten von hat sich im Vergleich zum vorhergehenden Edirom Viewer dahingehend verändert, dass es viel flexibler und dynamisch handhabbar ist. - Somit sind die Fenster nicht mehr in ihrer Größe statisch, sondern passen sich dynamisch den jeweiligen Objekten und deren Inhalten an. - Die untenstehende Tabelle bietet eine kurze Übersicht über das alte bzw. das neue Konzept.

- - - Art des Inhalts - Verfügbare Ansichten - Vergleichbare Objekte des Edirom Viewer - - - XML Quelle - XML Ansicht - - - - - Editorischer Text in TEI - Ansicht der Metadaten, Ansicht des Texts, Ansicht XML - Text - - - MEI-Datei - Ansichten der Metadaten, Ansicht XML - - - - - MEI-Datei mit den dazugehörigen Bildern der Faksimile - Ansicht der Metadaten, Ansicht der Faksimile, Ansicht XML - Ansicht der Metadaten, Ansicht der Faksimile, Ansicht XML - Fenster für Partitur - - - MEI-Arbeitsdatei - Ansicht der Metadaten, Ansicht der Annotationen, Ansicht XML - - - -
-

Jedes offene Fenster wird in der als eigener Knopf mit den jeweiligen Titel dargestellt. Ein Feature, das aus den meisten Computeranwendung bekannt ist. - Wenn dieser Eintrag geklickt wird, kann zwischen dem Anzeigen bzw. Verstecken des Fensters hin- und hergeschaltet werden.

-

Sollten mehrere Fenster geöffnet sein, zeigt der Eintrag in der , welches der Fenster momentan aktiv ist (und somit auf verschiedene Tastaturkürzel reagiert): - Der entsprechende Eintrag des jeweils aktiven Fenster ist im Gegensatz zu den nicht-aktiven Fenstern hervorgehoben. - Fenster können je nach Wunsch und Nutzen per in den Titelleisten verschoben werden. -

-

Am rechten Ende der Titelleiste befinden sich drei Knöpfe:

-
- -

Der Klick auf das -Symbol hat zur Folge, dass das Fenster in die gezogen bzw. verkleinert wird.

-
-
- -

Der Klick auf das -Symbol hat zur Folge, dass das Fenster auf den aktuellen Desktop vergrößert wird.

-
-
- -

Mit dem Klick auf das Symbol wird das Fenster geschlossen..

-
-

Fenster können mithilfe von an jeder Kante oder Ecke in ihrer Größe verändert werden. Damit wird die individuelle Anpassung an die verschiedenen Arbeitsumgebungen garantiert.

-

Zusätzlich zu anderen inhaltbezogenen Kontrollelementen sind erweiterte Optionen zur Fensterorganisation verfügbar (wie oben beschrieben, siehe).

- - -
+

Oben an einem Fenster mit Inhalt befindet sich eine Zeile, die den Titel des geöffneten Objekts anzeigt. + Unter der Titelzeile hat jedes Fenster eine . + Links in der befindet sich die , mit der zwischen verschiedenen des aktuell geöffneten Fensters gewechselt werden kann, z.B. , , . + Je nach ausgewählter Ansicht kann am unteren Rand des Fenster die angezeigt sein, die unterschiedliche Werkzeuge zum Manipulieren der verschiedenen Objekte bereitstellt.

+ + +
-

Sollte der Inhalt eines Fenster textbasiert sein, z.B. eine TEI-Datei, ist der Eintrag zu innerhalb eines Menu-Fensters verfügbar. - Der Text erscheint in ähnlicher äußerer Form einer Webseite und kann Links zu anderen Inhalten enthalten. Dies hängt jedoch von der jeweiligen Edition ab und ist in der Aktualität der Links variabel. - Alle geklickten Links werden im selben Fenster geöffnet. Um den Inhalt in einem anderen Fenster zu öffnen, muss der Control Key bei Windows bzw. der Command Key bei Mac OX X gehalten werden.

-

Die ansichtsspezifischen Kürzel erscheinen in der . Diese enthalten:

- - - - - - Die erlaubt das Überspringen bestimmter Kapitel eines Textes. - - +

Sollte der Inhalt eines Fenster textbasiert sein, z.B. eine TEI-Datei, ist der Eintrag zu innerhalb eines Menu-Fensters verfügbar. + Der erscheint in ähnlicher Form einer Webseite und kann Links zu anderen Inhalten enthalten. +

- - - - - - - -
+ +
-

Die zeigt die Bilder der Quellen und liefert die Kontroll-Werkzeuge um innheralb der Quelle navigieren zu können.

-

Die des Faksimile- und Partitur-Fensters enthält folgende zusätzliche Kontroll-Werkezeuge:

- - - erlaubt die Anordnung der verschieden angezeigten Schichten und der übereinander liegenden Taktnummern (für eine detaillierte Beschreibung siehe: ). - - erlaubt die Anordung übereinander liegender Annotationssymbole (für eine detaillierte Beschreibung siehe: ) - - erlaubt das Springen zu bestimmten Takten oder Sätzen in der aktuellen Quelle (für eine detaillierte Beschreibung siehe: ) - -

Die enthält folgende Kontroll-Werkzeuge für die Navigation innerhalb des Inhalts der Quellen:

-
- -

- wechselt zu einer seitenbasierten Navigation der Quelle.

-
-
- -

- wechselt zu einer taktbasierten Navigation der Quelle.

-
-
- -

- erlaubt in bzw. aus der vorliegenden Seite hinaus bzw. heraus zu zoomen.

-
-
- -

- passt die aktuelle Quelle an das Fenster an.

-
-
- -

bzw. - Die Nummer, die im Nummernfeld angezeigt wird zeigt entweder die derzeitige Nummer () oder Taktnummer () an. - Das Wechseln auf eine andere Seite oder einen anderen Takt ist entweder durch das Klicken auf die Pfeilköpfe (vor- bzw. rückwärtsblättern) oder durch die Eingabe einer Zahl in das Nummernfeld (mögliche Nummern werden als Drop-Down-Menü angezeigt) möglich. - Die möglichen Zahlen korrespondieren mit dem Quelleneditor und beginnen deshalb nicht immer mit 1 und können alphanumerische Charaktere enthalten.

-
-

Einige zusätzliche Kontroll-Werkezeuge erscheinen in der :

-
- -

- Es kann der Satz ausgewählt werden, dessen Takte angezeit werden sollen.

-
-
- -

- Es können die Bestandteile ausgewählt werden, die angezeit werden sollen. Dieses Kontroll-Werkzeug ist nur verfügbar, wenn verschiedene Bestandteile gekennzeichnet sind.

-
-
- -

- In dieses Eingabefeld kann die Zahl der Takte eingegeben werden, die angezeigt werden sollen.

-
-

Das Zoom-Level kann gesteigert bzw. verringert werden indem das Scrollrad der Maus bedient wird. Am unteren Rand des Fenster sind die verschiedenen Seiten der Quelle aufgeführt.

- -
- - - -

- Das Menü führt zu folgenden Funktionen:

- - - Die Option unterstützt die Kontrolle der Einblendung von Taktnumer der vorliegenden Quelle. - Taktnummer erscheinen in der Mitte des jeweiligen Taktes. - - Taktnummer können ebenfalls mithilfe der Tastatur angezeigt bzw. versteckt werden. ('B' für das aktuell aktive Fenster, 'Shift+B' für alle geöffneten Faksimile-Fenster). - - Der Eintrag steuert die Anpassung des Zoom-Levels der Quelle an die derzeitige Fenstergröße. - - Der Menüeintrag zeigt bzw. verbirgt vorhandene Schichten in den Noten, wenn diese von der Edition bereitgestellt wurden. - Diese Schichten könnten beispielsweise farbige Bemerkungen zur visuellen Hervorherbung der Hinzufügungen im Autograph oder in den Faksimiles sein. - -
-
+

Ist eine der möglichen Ansichten eines Objekts werden die Bilder der Quelle gezeigt. +

+ + +
- + -

Das hat folgende Funktionen:

+

In der gibt es die folgenden weiteren Menüs.

+ + +

+ + Unter + gibt es folgende Unterpunkte: + + + Die Option unterstützt die Kontrolle der Einblendung von Taktnumern der vorliegenden Quelle. + Taktnummern erscheinen in der Mitte des jeweiligen Taktes. + + Der Eintrag steuert die Anpassung des Zoom-Levels der Quelle an die derzeitige Fenstergröße. + + Der Menüeintrag zeigt bzw. verbirgt vorhandene Schichten in den Noten, wenn diese von der Edition bereitgestellt wurden. + Diese Schichten könnten beispielsweise farbige Bemerkungen zur visuellen Hervorherbung der Hinzufügungen im Autograph oder in den Faksimiles sein. + +

+ +

+ + + + Unter gibt es folgende Unterpunkte. + + + Die Option aktiviert die Anzeige der Annotationen des Kritischen Berichts als Annotationssymbole auf den Faksimiles bzw. der Edition. + Annotationen können nach Priorität und Kategorie gefiltert werden (siehe unten). + In jeder Quelle werden nur die Annotationen angezeigt, die in Bezug zur geöffneten Quelle stehen. + Mit einem Mouseover über das Annotationssymbol wird ein Tooltip geöffnet, über den die Annotation in einem neuen Fenster geöffnet werden kann. + + Filtermöglichkeit der Anmerkungen nach Priorität. + + Filtermöglichkeit der Anmerkungen nach Kategorien. + +

+ +

+ + + + Das hat folgende Funktionen: - Die Option unterstützt die Anzeige der Annotationen des Kritischen Berichts als Annotationssymbole, die auf den Faksimiles angezeigt sind . - Annotationen können ebenfalls nach Priorität und Kategorie gefiltert werden (siehe unten). - In jeder Quelle werden nur die Annotationen angezeigt, die in Bezug zur geöffneten Quelle stehen. - Mit einem Mouseover über das Annotationssymbol wird ein Tooltip geöffnet, das zusätzliche Informationen zu den Annotationen zeigt. - Wenn auf das Symbol geklickt wird, wird die Annotation in einem neuen Fenster geöffnet. - - Das Untermenü zeigt alle Annotationen, die innerhalb der vorliegenden Quelle vorhanden sind. Zusätzlich existiert die Funktion diese in der Faksimile-Ansicht anzuzeigen bzw. auszublenden. + Die Option öffnet einen Dialog, in den gewünschte Satz- und Takt-Nummern eingetragen werden können. - Das Untermenü zeigt alle Kategorien, die innerhalb der vorliegenden Quelle vorhanden sind. Zusätzlich existiert die Funktion diese in der Faksimile-Ansicht anzuzeigen bzw. auszublenden. + Auflistung aller Sätze bzw. editionsspezifisch angelegte Abschnitte innerhalb einer Quelle. +

-
+ +
- + -

Das hat folgende Funktionen:

- - - Die Option öffnet einen Dialog, in den gewünschte Satz- und Takt-Nummer eingetragen werden können. - - Das Untermenü zeigt alle Prioritäten innerhalb des Satzes in der aktuellen Quelle auf. Wenn ein Element ausgewählt wird, wird die betreffende erste Seite geladen. - +

Die enthält folgende Werkzeuge für die Navigation innerhalb des Inhalts der Quellen:

+
+ + : wechselt zu einer seitenbasierten Navigation der Quelle. +
+
+ + : wechselt zu einer taktbasierten Navigation der Quelle. Bei Aktivierung dieser Ansicht erscheinen die drei folgenden zusätzlichen Werkzeuge in der . +
+
+ + , : Es kann der Satz ausgewählt werden, dessen Takte angezeigt werden sollen. +
+
+ + , : Es können einzelne Stimmen ausgewählt werden. Dieses Werkzeug ist nur verfügbar, wenn verschiedene Stimmen in der Codierung gekennzeichnet sind. +
+
+ + , : Eingabe eines Taktumfangs, durch den "geblättert" werden soll. +
+
+ + +
+
+ + : passt die Größe der aktuellen Quelle an das Fenster an. +
+
+ + bzw. +

Die Zahl im Nummernfeld zeigt die derzeitige Seitenzahl () oder Taktzahl () an. + Das Wechseln auf eine andere Seite oder einen anderen Takt ist durch das Klicken auf die Pfeilköpfe oder die Eingabe einer Zahl in das Nummernfeld möglich. + Die möglichen Zahlen korrespondieren mit der Quelle, beginnen also nicht immer mit 1 und können auch alphanumerische Charaktere enthalten.

+
- +
-

Wenn die im Menü ausgewählt wird, werden die XML-Daten des vorliegenden Elements angezeigt. - Einige Kontroll-Werkzeuge können so der entsprechenden zugordnet werden könne:

+

In der gibt es folgende Optionen in der .

- Mit dem-Button lässt sich die Schriftgröße im verkleinern. + -Button - Mit dem -Button lässt sich dich Schriftgröße im vergrößern. + -Button - Mit dem -Button lassen sich die Zeilennummern im anzeigen bzw. verstecken + -Button
- - - - -
+ + +
-

Die aus dem Menü zeigt die Lesarten bzw. die individuellen Annotationen aus dem Kritschen Berichts des vorliegenden Objekts. - Das vorgegebene Erscheinungsbild ist eine Liste mit allen Annotationen, die in vier Rubriken mit folgenden Details eingeteilt werden können:

- - - Zeigt die Folge der Annotationen an. - - Besagt den Titel der Annotation und wird oftmals genutzt um den Gegenstand der Annotation zu verdeutlichen. - - Zeigt die Kategorien an, die einer Annotation zugeordnet werden kann. - - Besagt die Priorität, die einer Annotation zugewiesen wurde. - -

Wenn auf den Kopf der Rubrik geklickt wird, werden die Kategorien gemäß der vorhandenen Daten neu angeordnet, ein zweiter Klick auf die selbe Leiste wird die Sortierung umkehren. - Sollte die Maus über einen Rubrikkopf fahren, erscheint ein Pfeilkopf in der rechten Ecke des Rubrikentitels, der in ein Kontextmenü weiteführt, das folgendes erlaubt:

- - Einstellung der Reihenfolge. - Anzeigen/Verstecken der Rubriken. - Anwenden eines Filters auf die jeweilige Spalte. - -

Mit einem Doppelklick auf einen Eintrag in den Annotationen kann eine größere Ansicht aller Annotationsdetails angezeigt werden. - Dies erlaubt wiederum 3 verschiedene Arten der Darstellung, die durch das -Menü zur hinzugefügt werden können. - Über alle verfügbaren Anzeigedarstellungen lassen sich die Annotationstext und die Metadaten anzeigen lassen. Jedoch unterscheiden sie sich im Unterschied zu den zugehörigen Quellen wie folgt:

- - - Zeigt die Bilder aller zugehörigen Quellen in einem Überblicks-Gitter. Mit einem Doppelklick auf ein einzelnes Objekt kann dieses in der angezeigt werden (siehe unten). - - Zeigt den betroffenen Quellenausschnitt innerhalb der Form der Annotation. Pfeile, die nach rechts und links weiterleiten, erlauben die Navigation durch alle Bilder. - Mit einem Doppelklick kann wieder zurück auf die (siehe oben) oder (siehe unten) navigiert werden. Dies hängt davon ab, wie die Ansicht geladen wurde. - - Führt eine Liste auf, die die und die aufführt. - -

Des Weiteren wurden die folgenden Kontroll-Werkzeuge zu der hinzugefügt.

-
- -

- Resultiert in der Ansicht der generellen Liste der Annotationen.

+

Mit dem Unterpunkt aus dem Menü lassen sich die Lesarten bzw. die individuellen Annotationen aus dem Kritischen Bericht des vorliegenden Werkes öffnen. + Einige Editionen bieten einen Einstieg in den kritischen Bericht auch als Eintrag in der an. + Die Kopfzeile des kritischen Berichts kann folgende Einträge haben. + + + Zeigt die laufende Nummer der Annotationen an. + + Titel der Annotation, der den Gegenstand der Annotation verdeutlicht. + + Kategorien, die einer Annotation zugeordnet werden können. + + Priorität, die einer Annotation zugewiesen werden kann. + + Quelle(n), in denen die Annotation vorkommt. + +

+

Ein Klick auf eine Kopfzeilen-Kategorie ordnet die Daten auf- bzw. absteigend neu an. + Ein Pfeil in der rechten Ecke der Kopfzeile bei mouse-over öffnet ein Kontextmenü mit folgenden Einstellungsmöglichkeiten: + + Einstellung der Reihenfolge. + Anzeigen/Verstecken einzelner Einträge der Kopfzeile. + Anwenden eines Filters auf die jeweilige Spalte. + +

+

Ein Doppelklick auf einen Eintrag in der Annotationsliste öffnet die Detail-Ansicht der Annotation. + In der unter können die zugehörigen Quellen wie folgt angeordnet werden. + + + Zeigt die Bilder aller zugehörigen Quellen in einem Raster. Mit einem Doppelklick auf ein einzelnes Objekt kann dieses in der angezeigt werden (siehe unten). + + Zeigt den Quellenausschnitt, auf den sich die Annotation bezieht. + Mit einem Doppelklick kann wieder zurück auf die (siehe oben) oder (siehe unten) navigiert werden. + + Liste mit und . + +

+

Die enthält folgende Werkzeuge.

+
+ + (Rückkehr zur)
- -

- Resultiert in der vorhergehenden Annotation in Berücksichtung der Filter und Sortierungsoptionen, die in der spezifiziert wurden.

+ + aus der Anmerkungsliste.
- -

- Resultiert in der nachfolgenden Annotation in Berücksichtung der Filter und Sortierungsoptionen, die in der spezifiziert wurden.

+ + aus der Anmerkungsliste.
- -

- Öffnet die detaillierte Ansicht aller Quellen, die in Zusammenhang mit der aktuell ausgewählte Annotation stehen.

+ + : Öffnet die detaillierte Ansicht aller Quellen, die in Zusammenhang mit der aktuell ausgewählte Annotation stehen.
- -

- Nur verfügbar, wenn die vorhergehend ausgeführt wurde, schließt alle zugehörigen Fenster.

+ + : Nur verfügbar, wenn vorhergehend ausgeführt wurde.
-
- - - - -
- Arbeiten mit Annotationen -

Annotationen, die aus dem Kritischen Bericht einer Edition kommen, können in auf unterschiedliche Weise geöffnet werden. - (1) Symbole, die bereits in der Quelle angezeigt werden, liefern bereits eine große Bandbreite an Informationen. Durch einen Doppelklick kann dadurch auch der komplette Kritische Bericht erreicht werden. - (2) Der komplette Kritische Bericht ist üblicherweise über den eines Werkes verfügbar.

-

Ferner liefert eine zusätzliche Funktion, die es erlaubt die Annotationen individuell mit den und den zu bewerten. - Der spezifische Gebrauch dieser Optionen hängt von den vorbereiteten Editionsrichtlinen ab (z.B. die Kategorien, die tatsächlich verwendet wurden). - Deshalb sollte die folgende Beschreibung nicht als komplette Dokumentation gesehen werden, sondern eher als eine Einführung in die grundsätlichen Konzepte dieser Überlegung.

-
- - Ein exemplarischer Screenshot eines Annotationssymbols, das den Tooltip einer einzelnen Annotation zeigt. -
-
- -

Eine gibt einen Hinweis auf die Wichtigkeit der Annotation. - Die Visualisierung der im wird durch eine Farbcodierung der Symbole erreicht:

-
- -

Priorität 1 Annotationen beziehen sich auf die editionsspezifischen Schlüsselprobleme, die im Interesse aller Leser der Edition sind und sind mit der Farbe rot markiert.

-
-
- -

Priorität 2 Annotationen beziehen sich auf wichtige Aspekte der Edition, die aber nicht von größter Bedeutung für die Edition als sich sind. Diese Annotationen sind rot/gelb markiert.

-
+ + +
+ Arbeiten mit Annotationen +

Annotationen, die aus dem Kritischen Bericht einer Edition kommen, können in auf unterschiedliche Weise geöffnet werden. + (1) Symbole, die bereits in der Quelle angezeigt werden, liefern bereits eine große Bandbreite an Informationen. Durch einen Doppelklick kann dadurch auch der komplette Kritische Bericht erreicht werden. + (2) Der komplette Kritische Bericht einer Edition ist üblicherweise als unter dem Menüpunkt in der verfügbar. Wie bereits oben erwähnt, bieten einige Editionen auch einen Einstieg in den kritischen Bericht als Eintrag in der an.

+

Ferner liefert die Möglichkeit, Annotationen in und einzuteilen. + Der Gebrauch dieser Optionen hängt von den Editionsrichtlinen ab (z.B. den Kategorien, die tatsächlich verwendet wurden). + Deshalb sollte die folgende Beschreibung nicht als komplette Dokumentation gesehen werden, sondern eher als eine Einführung in die grundsätzlichen Konzepte dieser Überlegung.

- -

Priorität 3 Annotationen enthalten Beobachtungen des Editor, die normalerweise nur für die Dokumentquellen interessant sind und nicht weiter erwähnenswert in editorischer Perspektive. Diese Annotationen sind mit gelb markiert.

+ + Ein exemplarischer Screenshot eines Annotationssymbols, das den Tooltip einer einzelnen Annotation zeigt.
-
-
- -

Annotationen sind normalerweise einer oder mehrerer zugeordnet, die jeweils eigene Symbol hat. - Diese Symbole sind meistens ebenfalls in der Farbe der codierten Box angezeigt, in der das Annotationssymbol in der ist. - Daher ist es möglich, den Typ bzw. den Inhalt der Annotation mithilfe des Symboly zu bestimmen.

-

Die verfügbaren Annotationskategorien hängen jedoch von der jeweiligen Edition ab. - Typische Beispiele für Annotation sind etwa Bogensetzung, Kennzeichnung der Ausdrücke oder Artikulation.

-
- - - Kategorie: - Symbol im Faksimile: - - - Partitur - - - - - - - - Expressive Kennzeichnung - -
- - - -
-
-
- - Choral Text - -
- - - -
-
-
- - Kombination verschiedener Kategorien - -
- - - -
-
-
-
- Beispiele der Symbole für die Kategorien der Annotationen. -
+ + +
+ +

Eine gibt einen Hinweis auf die Wichtigkeit der Annotation. + Die Visualisierung der im wird durch eine Farbcodierung der Symbole erreicht:

+
+ +

Priorität 1 Annotationen beziehen sich auf die editionsspezifischen Schlüsselprobleme und sind mit der Farbe rot markiert.

+
+
+ +

Priorität 2 Annotationen beziehen sich auf wichtige Aspekte der Edition, die aber nicht von größter Bedeutung für die Edition sind und sind orange markiert.

+
+
+ +

Priorität 3 Annotationen enthalten editorische Beobachtungen, die normalerweise nur für die Dokumentquellen interessant sind. Diese Annotationen sind mit gelb markiert.

+
+
+ + +
+ +

Annotationen können einer oder mehreren zugeordnet sein, die jeweils eigene Symbol haben. + Diese Symbole sind meistens ebenfalls in der Farbe der codierten Box angezeigt, in der das Annotationssymbol im ist. + Damit ist es möglich, den Typ bzw. den Inhalt der Annotation mithilfe des Symbols schneller zu erfassen.

+

Die verfügbaren Annotationskategorien hängen von der jeweiligen Edition ab. + Typische Beispiele für Annotationen sind etwa Bogensetzung, Kennzeichnung der Ausdrücke oder Artikulation.

+
+ + + Kategorie + Symbol im Faksimile + + + Partitur + +
+ + + +
+
+
+ + Expressive Kennzeichnung + +
+ + + +
+
+
+ + Choral Text + +
+ + + +
+
+
+ + Kombination verschiedener Kategorien + +
+ + + +
+
+
+
+ Beispielsymbole für Kategorien bei Annotationen. +
- - -
- Filtern -

Das Filtern der Anzeige von Annotationen ist sowohl im Menü, als auch im möglich. - Die entsprechenden Beschreibungen können in den dazugehörigen Abschnitten dieses Dokuments gefunden werden.

-

Alle Annotationen, die mindestens einer der ausgewählten Kategorien zugeordnet werden können, werden in den Faksimile angezeigt. - Das Filtern nach mehreren Kategorien wird alle Annotationen die zumindest einer Kategorie zugeordnet sind, als Resultat ergeben; das Filtern nach Annotationen, die allen ausgewählten Kategorien zugeordnet sind, ist hingegen nicht möglich. -

-
-
- -
- Hilfe (Edirom Benutzeroberfläche) -

Das Hilfe (Edirom Benutzeroberfläche) Fenster ist (im Gegensatz zu den Fenstern mit den Inhalten) ein Stand-Alone-Fenster, das nur einmal geöffnet werden kann. - Wenn sie den Button jedoch öfters klicken, erscheint die Schaltfläche für das Zeigen bzw. Verbergen des Hilfe-Fensters. Das heißt es wird in den Vordergrund gestellt, sollte es hinter anderen Fenstern versteckt sein.

- -
- - - - + - \ No newline at end of file + diff --git a/add/help/help_en.xml b/add/help/help_en.xml index f7596a1b..97012e6a 100644 --- a/add/help/help_en.xml +++ b/add/help/help_en.xml @@ -5,55 +5,47 @@ <term type="ediromGui" key="global_appName"/> Help - - Benjamin W. Bohl - DFG-Projekt "Digitale Musikedition" (Edirom) -
- Musikwissenschaftliches Seminar Detmold/Paderborn - Gartenstraße 20 - D-32756 Detmold -
-
-
- - Daniel Röwenstrunk - Freischütz Digital -
- Musikwissenschaftliches Seminar Detmold/Paderborn - Gartenstraße 20 - D-32756 Detmold -
-
-
+ + Author + Benjamin W. Bohl + Daniel Röwenstrunk + Kristin Herold +
- Virtueller Forschungsverbund Edirom - + Virtueller Forschungsverbund Edirom - + Creative Commons Attribution 4.0 International (CC BY 4.0) -

Written in Open Office by Edirom Project http://www.edirom.de. Converted to TEI P5 using oxgarage, see

+

Written in Open Office by Edirom Project (DFG) https://edirom.de/edirom-projekt/. Converted to TEI P5 using oxgarage, see

- - - - * added description of searchWindow; deactivated link to missing preferences section; - * corrected long lang_vars in pull request; - * removed tei:q around some terms as terms now with css class .term; added TODO comments searchView and preferences; - * removed generated IDs from conversion to TEI P5; * where applicable, inserted tei:head in tei:figure; * overhauled priority images to match new figure-structure; * prettified XML indentation; wrapped annotation categories table with figure; * added description of Annotation View's TaskBar Buttons; added TaskBar screenshot; * corrected figure head of Tool Bar;* changed ID from toolbar_bottom to help_view.desktop.TaskBar; * added description of annotationOverview.png; * added TODO comments; * matched EdiromHelp SVN and GitHub; * added workspace-switcher.png; - *overhauled structure of button entries; * corrected some typos; * added missing button descriptions in annotation-view; - * deleted comment with manually edited TOC; * provided description of annotation-view; * deleted description of annotations window; * reworked chapter on annotations; * made all ediromGui terms empty elements; * removed some generated xml:id attributes; - reworked preferences description; made preferences description a comment due to implementation status - updated occurrences of "Edirom Online" to + + + Moved tei:head/@xml:id to parent tei:div using headId2parentDivId.xquery; removed leading line breaks in tei:head elements; rephrased "installation" and inserted tei:note[@type='editorial'] on insertion of installation information; changed old corresponding parts on installation into xml comments; wrapped 'Installation' and 'Application Startup' with 'Preparation' div; removed 'id_' from all @xml:id; rephrased 'Application Startup'; comletely reworkeg 'GUI' chapter; inserted TODO comments; + Updated Ids and Anchors using scripts/anchorId2parentId.xquery; deleted empty lines; deleted back-to-top links; changed tei:graphic/@src to point to original pix of Edirom Viewer Help;created first help_en.pdf using standard oXygen tranformation scenario for TEI P5 to PDF; + Updated document name to "Edirom Online Help"; inserted me as author with xml:id for change references; changed pubStmt to unpublished; removed leading '../../0119a239-cd85-4b1a-9a15-abf5ffea2131/' from every tei:graphic/@url; introduce4d tei:body/tei:head; + Converted from HTML version to TEI P5 using oxgarage web sercice + + reworked text from "toolbar" onwards; created separate chapters for and ; added description for the buttons in help_view.desktop.TaskBar; reworked chapter on windows; inserted passages on views; - Moved tei:head/@xml:id to parent tei:div using headId2parentDivId.xquery; removed leading line breaks in tei:head elements; rephrased "installation" and inserted tei:note[@type='editorial'] on insertion of installation information; changed old corresponding parts on installation into xml comments; wrapped 'Installation' and 'Application Startup' with 'Preparation' div; removed 'id_' from all @xml:id; rephrased 'Application Startup'; comletely reworkeg 'GUI' chapter; inserted TODO comments; - Updated Ids and Anchors using scripts/anchorId2parentId.xquery; deleted empty lines; deleted back-to-top links; changed tei:graphic/@src to point to original pix of Edirom Viewer Help;created first help_en.pdf using standard oXygen tranformation scenario for TEI P5 to PDF; - Updated document name to "Edirom Online Help"; inserted me as author with xml:id for change references; changed pubStmt to unpublished; removed leading '../../0119a239-cd85-4b1a-9a15-abf5ffea2131/' from every tei:graphic/@url; introduce4d tei:body/tei:head; - Converted from HTML version to TEI P5 using oxgarage web sercice + updated occurrences of "Edirom Online" to + reworked preferences description; made preferences description a comment due to implementation status + deleted comment with manually edited TOC; provided description of annotation-view; deleted description of annotations window; reworked chapter on annotations; made all ediromGui terms empty elements; removed some generated xml:id attributes; + overhauled structure of button entries; corrected some typos; added missing button descriptions in annotation-view; + + + removed tei:q around some terms as terms now with css class .term; added TODO comments searchView and preferences; + removed generated IDs from conversion to TEI P5; where applicable, inserted tei:head in tei:figure; overhauled priority images to match new figure-structure; prettified XML indentation; wrapped annotation categories table with figure; added description of Annotation View's TaskBar Buttons; added TaskBar screenshot; corrected figure head of Tool Bar; changed ID from toolbar_bottom to help_view.desktop.TaskBar; added description of annotationOverview.png; added TODO comments; matched EdiromHelp SVN and GitHub; added workspace-switcher.png; + + + corrected long lang_vars in pull request; + added description of searchWindow; deactivated link to missing preferences section; + update metadata (add orcid, delete old addresses etc.) + replaced old (partly deprecated) content with updated and revised german help, which was translated to english; correct indentation @@ -61,1055 +53,467 @@ Help (User Manual) -

This document provides a general introduction to using . It describes the basic functions of the software. Please note that not all of the - options described here are necessarily available in every edition using . This is due to the fact that contents have to be prepared - accordingly and projects using have their own edition guidelines and concepts. Furthermore, some versions may contain more options than - mentioned in this document due to edition-specific enhancements.

+

This document contains a general introduction to the use of . It describes the basic functions of the software. Not all of the options described below may be available in every edition, as content is created on a project-specific basis and each edition is subject to its own individual edition guidelines. + Furthermore, for edition-specific reasons, it is possible that some versions contain extensions that are not listed and explained in this document. +

- - -
- Preparation -
- Installation -

- is designed as web application and thus has to be set up on a server. For questions about setting up on a server please contact the Edirom Project (http://www.edirom.de).

-

Nevertheless an based edition can be distributed on a discrete data storage device, and require/permit installation on your personal computer. If your current version of is such a distributed version, please contact the corresponding author or publisher for further details concerning installation on your personal computer.

- - - -
-
- Application startup -

- is designed as a web application. The only system requirement is a javascript enabled web browser.

-

If your current version of has to be installed please contact the corresponding author or publisher for further details concerning installation on your personal computer.

- -
-
- +
- User interface -

The user interface of is divided into several sections. At the top and bottom borders of the window you find and that provide access to all major Edirom functions. The space in between is called . At the top right corner of the is the so-called .

-
- - A sample view of an screen, showing (top), (bottom), , and (right). -
- -
- - - + User interface +

The application interface of consists of different areas. At the top is the , at the bottom is the . + The area in between is the , within which all internal application windows are opened to display the content of an edition and gain access to additional functions. On the right is the +

- - Detail view of the . - + + An example view of the window, which shows the (top), the (bottom), the and the (right).
-

Sample , with , and combo box for at the left end and the on the right end.

-

- At the very left of the - is the , next to it is a combo box for of the same - edition; at the very right is the for locating contents. -

-
+ + +
- - + + +

The is located on the left edge of the . + Next to it is the . This enables a selection of the various works contained within an edition and thus attempts to emulate the structure of a “classic” printed edition volume with several works included. + The and thus the packaging of several works in one edition (analogous to an earlier edition volume) is used less frequently in newer versions and the name of the individual work edition appears in its place. + On the right is the input for the and a button that opens an window. +

- -

The reopens the startup dialog.

+ + Detailed view of the with and for the work selection (left) and the search field (right).
-
-
- Selecting works -

The next element is a combo box listing the works contained in the edition. If your contains more than one work, you can switch between works at any time. If you select a different work, the context of and will be set to the newly selected work, and the contents of the will be updated accordingly.

-

Any program windows that remain open with content from the last displayed work may stay open, depending on your settings (see below). This option allows comparing components of different works directly with one another. Please note, however, that the navigation options (see ) affect only the contents of the currently selected work, while (open) contents of other works remain unaffected.

- +
+ + + +

The window can be opened by clicking the button (magnifying glass) in the or by entering a search query in the . + A text-based search is performed on all content in the edition.

+
+ + Detailed view of the : Clicking on the magnifying glass triggers the command. +
+

After a search query is executed, all results are grouped with corresponding content, eg text document, annotation. + Individual search results may be highlighted separately. + If a search query results in more than three hits per entry, a Show all hits link appears.

+
+ + The window +
+
-
+ + +
- - + + +

On the right of the is the . + The contains an edition-specific list of objects that can be organized into categories. + If an element in the list is clicked, the corresponding object opens in a window of the .

- -

Clicking the magnifying lens icon triggers . By entering a query in the located on the menu bar, you can directly operate the search window, whereas this button just opens it. For the exact functions of the search window, see the corresponding chapter ().

+ + An exemplary
-
-
- - -
- - - -

At the top right corner of the , right below the , is the so-called . The - contains an edition-specific list of content objects potentially - organized in categories. Clicking on an item opens the corresonding item in a new - window in the workspace.

-
- - A sample navigator. Behold the scrollbar on its right edge. -
-

In case the navigator holds very many objects, a scroll bar located along the right - edge of the window lets you scroll through the contents of the navigator. You can - also scroll using the wheel of your mouse, if applicable.

-

Although always fixed to the top right corner of the workspace, you can resize the - deliberately and also - reduce it to a narrow bar below the , by on its left or bottom - edges.

-
- -
- - - -

The is the space between and . In this space all internal application windows are opened and arranged in order to show contents of an edition or to give access to further application functions. The internal application windows cannot be dragged out of this area. See for further details.

-
+

If the contains many objects, you can navigate through the contents using the scroll bar on the right edge of the window. + The is fixed to the upper right corner, but can be resized via at the left or bottom edge.

+
+ -
- - - -
- - Detail view of the - -
-

The at the bottom of the gives access to content-related functions on the left, and meta-functions on the right.

-
+
- + +

Through the at the bottom of the the global content-related functions can be accessed on the left and the meta functions on the right.

- -

This button lets you arrange all open windows in tiles of a grid.

+ + Detailed view of the
-
-
- - - +

The first three buttons on the left control the different arrangement of all open content windows on the .

- -

This buttons lets you arrange all open windows in horizontal rows.

+ +
-
-
- - -
- -

This buttons lets you arrange all open windows as tiles.

+ +
-
-
- - -
- -

The button lets you show or hide measure numbers globally in all windows.

+ +
-
-
- - - +

The bars of facsimiles and editions are usually provided with bar numbers; these can be shown and hidden for all open windows with musical content using the fourth button from the left.

- -

This button lets you show or hide annotation icons globally in all windows. For further details see .

-

Annotation filter settings (see ), however, can only be configured in the of each individual window.

+ +
-
-
- - - -
- -

This button lets you add another desktop to allowing for a complete new set of windows even from another work's context without modifying your current dektop(s).

-
-
-
- - - +

Music editions or facsimiles and libretto editions can contain annotations that can be opened using annotation symbols. + With the speech bubble button you can . + Annotations can be assigned priorities and categories. Filtering annotations according to these priorities and annotations is not possible via the global button in the , but only via selection in an individual window.

- -

This button opens or closes the window.

+ +
-
- -
- - - + + + +

At the bottom right, you can use the question mark button to open the or move it to the foreground.

- -

You can use this button to display this Help (Edirom User Manual) window or to move it to the foreground.

+ +
-
-
-
- -
- - - -

The window can be opened by clicking the button (magnifying lens) on the or by entering a search query in the and hitting Return. It will perform a text-based search on all edition contents.

-
- -
-

After performing a search operation, all resulting hits are grouped as one result entry for every corresponding content item (text document, annotation, etc.). Furthermore, individual hits are highlighted within their surrounding context.

- -

Clicking on an entry's title or on a highlighted search hit opens the corresponding content item with all search hits highlighted.

-

If a search operation scores more than three hits per entry a link named show all hits will appear.

- - -
- - -
- - - -

The offers quick access to the objects contained in the edition, which are opened by mouse click in a new on the current .

- -
- - A sample navigator. Note the scrollbar on the right. -
-

The number of objects held by the may exceed the actual size of the panel. In this case a scrollbar at the right side of the window permits to scroll through the contents - of the . The mouse wheel may be used as well.

-

Although the is fixed to the top right corner of the workspace, it is possible to resize and even to reduce it to a narrow - bar below the button by drag-and-drop on its left or bottom edge.

+
- + +
- + - -

The -provides navigation by concordance, - affecting those contents in windows currently open and associated with the concordance.

-

Different concordances can be selected from a drop down menu. Furthermore movements etc are accessible through a second drop-down - If the selected concordance has subdivisions (e.g. movements) a second drop-down menu will appear to choose between them.

-

Slider with number indicating current connection; click display to trigger; use arrowheads to navigate back and forward step by step.

-

mehrere Konkordanzen und editions spez

- - -
- - - - with and without additional drop-down menu. + +

The navigator for enables cross-source navigation in all corresponding facsimiles or the edition. + Another example of the application is the concordance of scores and the corresponding verses of a libretto in order to be able to view the musical instructions alongside the specific verse lines at the same time. + However, the existence of the concordances in question depends on the respective edition. + If the selected concordance contains further subdivisions, such as sentences, a second drop-down menu will appear for selection.

+
+ + + with and without additional drop-down menu.
-

Below the slide control is a large button labeled . Click on this button to open the selected measure in all open sources on - the current desktop. You can also navigate within sources using the two arrows - to the left and right of the button, which allow you to browse forward or backward. Depending on your settings , only windows which are already opened are affected by this. If this particular measure exists in other sources currently not displayed, a small button on the lower right will appear . This buttons lets you open all relevant - windows for the selected measure position and will rearrange all open - windows.

- -

A common use is a measure concordance which lets you display the content of a particular measure in all facsimiles and scores of the current work open on the . -If the current work has more than one movement, a drop-down menu lets you select the desired one. Using a slide - control, you may select the measure to be displayed when you click the button - labeled .

-

Another example would be a concordance of scores and the corresponing verses of - a libretto, in order to simultaneoulsy display the corresponding musical - setting alongside a particular verseline. The presence of certain concordances - depends on the particular edition.

- +

Below the slider is the button . + This must be clicked to open the selected measure in all open sources on the desktop. + You can also navigate forward or backward at the measure level within the sources using the arrows to the right and left of the button. + However, if the selected measure occurs in other sources that are not currently open, a button will appear at the bottom right that opens all other sources and rearranges the windows

- - +
Content windows -

Content windows can be manipulated within the program in virtually the same - way as normal operating system windows. Along the top edge of the window is a title - bar that contains the name of the displayed item.

-

Below the title bar each window contains a . At the very left of this is a for switching between ; offer differnent perspectives on the content - currently open in a window (e. g. - , , , - etc.) At the bottom edge each window might contain a view specific with tools for manipulating the - respective object. The availability of is - dynamic and thus depends on the object being displayed. For example:

- - - This is standard for all windows containing multiple views and allows for - switching between views. - - -

The object concept of has - changed in comparison to the former Edirom Viewer, switching to a much - more flexible and dynamic concept of objects. Thus windows no longer are of a certain - type but dynamically provide views to an object depending on its contents. For a - translation of the former window types to the new view concept see the below - table.

- - - Type of content - Available views - Comparable Edirom Viewer object - - - XML resource - XML view - - - - - Editorial text in TEI - Metadata view, Text view, XML view - Text - - - MEI file - Metadata view, XML view - - - - - MEI file with associated facsimile images - Metadata view, Facsimile view, XML view - Score window - - - MEI work file - Metadata view, Annotations view, XML view - - - -
-

Each open window is represented as button in the holding the window title, a feature that might be - known from certain computer operating systems. Clicking on this entry toggles show/hide window function.

-

When multiple windows are open, the entry in the indicates which window is currently - active (and will thus react to certain key combinations): - The corresponding entry of the currently active window is highlighted in contrast to - those of non-active windows. Windows can be - arranged on the desktop as desired by on - the title bars.

-

At the right end of the title bar are three buttons:

-
- -

click on this symbol to the - windowe to the .

-
-
- -

click on this symbol to the window on the current desktop.

-
-
- -

click on it to close the corresponding window..

-
+

At the top of a window with content there is a line that shows the title of the open object. + Under the title bar, each window has a . + On the left in the is the , with which you can switch between different of the currently open window, e.g. , , . + Depending on the view selected, the may be displayed at the bottom of the window, which provides different tools for manipulating the various objects.

-

Windows can be resized by any - edge or corner of the window frame. This allows the user to customize his or her own - workspace.

-

In addition to other content-dependent control elements, - some advanced window organization options are also available (already - described above, see ).

- +
- - -

The entry is available on a window's - Menu if the - content item of the window is a text-based item, e. g. a TEI file. The text appears in a form similar to that of a website and may - include links to other content (depending on the edition, appearance of actual - links may vary). Clicking on these links opens the corresponding item in the same - window. To open the link in a new window, hold down the Control key - (Windows) or the Command key (Mac OS X) while - clicking. + + +

If the content of a window is text-based, e.g. a TEI file, the entry for is within a Menu window available. + The appears in a similar form to a web page and may contain links to other content.

-

Text view specific controls will appear in the , these include:

- +
+ + +
+ + + +

If is one of the possible views of an object, the images from the source are shown.

+ +
- + - - This allows to skip to a certain - chapter of a text. - - +

In the there are the following additional menus.

+ +

+ + + + Under there are the following sub-points: + + + The option supports the control of the display of measure numbers from the current source. + Measure numbers appear in the middle of each measure. + + The entry controls the adjustment of the zoom level of the source to the current window size. + + The menu entry shows or hides existing layers in the music if they were provided by the edition. + These layers could, for example, be colored notes to visually highlight the additions in the autograph or facsimiles. + +

+ +

+ + + + Under there are the following sub-points. + + + The option enables the display of the critical report annotations as annotation symbols on the facsimiles or edition. + Annotations can be filtered by priority and category (see below). + In each source, only the annotations that are related to the open source are displayed. + Mouseover over the annotation symbol opens a tooltip that can be used to open the annotation in a new window. + + Option to filter comments by priority. + + Option to filter comments by category. + +

+ +

+ + + + The has the following functions: + + + The option opens a dialog in which the desired division and measure number can be entered. + + Listing of all divisions or edition-specific sections within a source. + +

- - - - - -
- - - -

The shows source images and provides controls for navigating in a source.

-

The of the facsimile and score window contains the following additional control menus:

- - - allows configuration of displayed layers, or superimposed measure numbers - (for a detailed description see ). - - allows configuration of superimposed annotation symbols (for a detailed description see ). - - allows jumping to certain measures or movements of the current source (for a detailed description see ). - -

The contains following controls for navigating the source contents:

- -
- -

- - switches to a page based navigation of the source.

-
-
- -

- - switches to a measure based navigation of the source.

-
+ +
+ + + +

The contains the following tools for navigation within the content of the sources:

- -

- - allows for zooming in and out of the page currently displayed.

+ + : switches to page-based navigation of the source.
- -

- - Fits the current page into the window.

+ + : switches to measure-based navigation of the source. When this view is activated, the following three additional tools appear in the .
- -

- respectively - The number indicated by the number field either shows the currente page number (), or measure number (). Switching to another page or measure is possible either by clicking on the respective arrow heads for leafing through, or entering a number in the number field, in which case a filtered list of possible numbers will appear. The possible numbers correspond to those used by the editor for the source and therefore do not always begin with 1 and might include any alphanumeric character.

+ + , : The movement whose measures should be displayed can be selected. +
+
+ + , : Individual parts can be selected. This tool is only available when different parts are in the encoding. +
+
+ + , : Enter a measure range through which you want to scroll. +
+
+ + +
+
+ + : resizes the current source to fit the window. +
+
+ + or +

The number in the number field shows the current page number () or measure number (). + Switching to another page or measure is possible by clicking on the arrow heads or entering a number in the number field. + The possible numbers correspond to the source, so they do not always start with 1 and can also contain alphanumeric characters.

- -

Some additional controls appear when switching to the :

- -
- -

- - Allows for selecting the movement from which measures shall be displayed.

-
-
- -

- - Allows for selecting the parts to be displayed. This control is only available if the current source has parts marked.

-
-
- -

- - This input field allows entering the number of measures being displayed.

-
- -

Zoom level can be increased or decreased using the scroll function of the mouse wheel. At the bottom of the window, you can browse the different pages of the source .

- - -
- - - -

- menu grants - access to the following functions:

- - - This option lets you control the superimposition of measure numbers for - the displayed source. Measure numbers appear in the - center of the corresponding measure. - Measure - numbers can also be shown or hidden via the keyboard ('B' for the currently - active window, 'Shift+B' for all facsimile - windows). - - This entry triggers a command to adjust zoom-level of the source to fit - the current window size. - - This menu entry lets you show or hide existing layers in the score, if there are any provided by the edition. - These could include, for example, colored markings to visually highlight - autograph additions in facsimiles or similar features. - - -
-
- - - -

The menu provides access to following functions:

- - - This option lets you display Critical Report annotations as annotation symbols superimposed on the facsimies . The user can also filter - annotations by priority and category (see below). In each source, only annotations relating to that source are shown. If you mouse over an annotation symbol, a tooltip appears showing additional information concerning the annotation. Click on the symbol to open the annotation in a separate window. - - This sub-menu shows all priorities (if any) of annotations contained in - the current source and lets you activate/de-activate their display in the - facsimile view. - - This sub-menu shows all categories (if any) of annotations contained in the current source and lets you activate/de-activate their display in the facsimile view. - -
-
- - - -

The menu - provides access to following functions:

- - - This option opens a dialog allowing you to enter movement and measure - number you want to be displayed. - - This sub-menu shows all priorities movements contained in the current - source. Selecting an item will load the respective first page. -
- - + +
- - -

Selecting from - Menu shows the - XML data of the current item. A couple of controls are added to the corresponding - , being:

+ + +

In the there are the following options in the .

- This is the - - button that lets you decrease font size in the - + -Button - This is the - - button that lets you increase font size in the - + -Button - The - - button lets you show and hide the line numbers on the left hand side - of the . + -Button
- - - -
- - - -

Selecting from - Menu shows readings or individual annotations from the Critical Report of the current item. The default appearance is a list of all annotations with four columns for following annotation detail:

- - - Indicates the order of the annotations. - - Gives the title of the annotation; often used to give a first impression of the annotation's subject matter. - - Indicates the categories assigned to a given annotation. - - gives the priority assigned to a given annotation. - -

Clicking on a column head will resort the list on the basis of this columns data, a seconnd click on the same column head will reverse the sort order. When hovering over a column head a arrowhead will appear on the right edge of the column title, giving access to a context menu that allows for:

- - setting sort order. - showing/hiding columns. - applying a filter on the respective column. - -

Double-clicking on an annotation entry in the list will switch to a focused view of all the annotation's details. This again allows for three different kinds of display, available through the menu added to the . All available display modes offer complete annotation text and metadata but differ in the way the present corresponding sources as follows:

- - - presents images of all corresponding sources in an overview grid, double-clicking a single item shows this item in (see below). - - shows the respective source detail maximized to the annotation view's boundaries; arrow heads to left and right allow for stepping through all images. Double-clicking returns to (see above) or (see below), whichever you entered this view from. - - Gives a list providing corresponding and . - - -

Moreover following controls are added to :

-
- -

- - Returns the view to the general list of annotations.

-
+ +
+ + + +

With the sub-item from the menu you can change the readings or the individual ones Open annotations from the critical report of this work. + Some editions also offer an entry to the critical report as a topic in the . + The header of the critical report can have the following entries. + + + Shows the running number of the annotations. + + Title of the annotation, which clarifies the subject of the annotation. + + Categories that can be assigned to an annotation. + + Priority that can be assigned to an annotation. + + Source(s) in which the annotation occurs. + +

+

Clicking on a header category rearranges the data in ascending or descending order. + An arrow in the right corner of the header when mouse-over opens a context menu with the following setting options: + + Setting the order. + Show/hide individual header entries. + Apply a filter to the respective column. + +

+

Double-clicking on an entry in the annotation list opens the detailed view of the annotation. + In the under the associated sources can be arranged as follows. + + + Shows the images from all associated sources in a grid. By double-clicking on an individual object, it can be displayed in the (see below). + + Shows the source snippet to which the annotation refers. + With a double click you can go back to the (see above) or ( see below). + + List with and . + +

+

The contains the following tools.

- -

- - Moves to the previous annotation with respect to filters and sort options applied in .

+ + (Return to)
- -

- - Moves to the next annotation with respect to filters and sort options applied in .

+ + from the annotation list.
- -

- - Opens detail view of all sources corresponding to the currently selected annotation.

+ + from the annotation list.
- -

- - Only available when has been operated before, closes all respective windows.

+ + : Opens the detailed view of all sources related to the currently selected annotation.
- -
- -
- - - - - -
- Working with annotations -

Annotations from an edition's Critical Report can be accessed in different ways through . (1) Icons displayable in the sources already provide a great deal of information as tooltip and allow accessing the complete Critical Report by double-clicking the icon. (2) The complete Critical Report usually is available through a work object's .

-

Moreover provides additional means for adding accessing individual annotations by assigning them and a . The specific use of these options depends on the applicable edition guidelines, for example in terms of the categories actually used. Therefore, the following descriptions should not be considered complete documentation but simply an introduction to the basic concepts.

-
- - A sample screenshot with annotation icons displayed in a source and tooltip of a single annotation. -
-
- - - -

An annotations gives a hint towards its relevance for the edition. Visualization of an annotation's in is achieved by color-coding the symbols:

-
- -

- Priority 1 annotations deal with key edition-related issues of potential interest to all readers of the edition and are denoted by a completely red symbol.

-
-
- -

- Priority 2 annotations deal with important aspects of the edition which are, however, not of major importance to the edition as such. These annotations are indicated by progressively red-to-yellow symbols.

-
-
- -

- Priority 3 annotations include observations from the editor, which typically serve only to document sources and are of no - real relevance to the editorial work. These are represented by yellow symbols.

-
-
-
- - - -

Annotations are typically assigned to one or more , each of which may have its own symbol. These symbols are likewise displayed in the color coded box when displaying annotation icons in the . It is thus possible to determine the type of annotation content by its symbol. -

-

The annotation categories that are actually available depend on the edition. Typical examples include slur placement, expressive marking or articulation.

-
- - - Category: - Symbol in the facsimile: - - - Score - - - - - - - - - - Expressive marking - -
- - - -
-
-
- - Choral text - -
- - - -
-
-
- - Combination of multiple categories - -
- - - -
-
-
-
- Examples of symbols for annotation categories. -
-
- - -
- Filtering -

Filtering the display of annotations is both possible in the menu and . For respective descriptions see the corresponding sections of this document.

-

All annotations belonging to at least one of the selected categories are shown in the facsimile. Please note that filtering by multiple categories will yield all annotations assigned to at least one of these categories; filtering for annotations assigned to all selected categories is not possible.

-
- - -
- Help (Edirom User Manual) -

The Help (Edirom User Manual) window is (in contrast to content related windows) a stand-alone window and can only be opened once. Clicking the button several times - will toggle show/hide for the help window, respectively bringing it to the foreground if hidden behind other windows.

- -
- - - - + + +
+ Working with Annotations +

Annotations that come from an edition's Critical Report can be opened in different ways in . + (1) Symbols that are already displayed in the source already provide a wide range of information. The complete critical report can also be accessed by double-clicking. + (2) The complete critical report of an edition is usually available as under the menu item in the available. As already mentioned above, some editions also offer an entry into the critical report as a topic in the .

+

Furthermore, provides the option to create annotations in and . + The use of these options depends on the edition guidelines (e.g. the categories that were actually used). + Therefore, the following description should not be viewed as a complete documentation, but rather as an introduction to the basic concepts of this consideration.

+
+ + An example screenshot of an annotation icon, showing the tooltip of a single annotation. +
+ + +
+ +

A gives an indication of the importance of the annotation. + The visualization of the in the is achieved by color coding the symbols:

+
+ +

Priority 1 Annotations refer to the edition-specific key issues and are marked red.

+
+
+ +

Priority 2 Annotations refer to important aspects of the edition that are not of the utmost importance for the edition and are marked orange.

+
+
+ +

Priority 3 Annotations contain editorial observations that are normally only of interest to the document sources. These annotations are marked yellow.

+
+
+ + +
+ +

Annotations can be associated with one or more , each with its own icon. + These symbols are usually also displayed in the color of the coded box in which the annotation symbol is in the . + This makes it possible to capture the type or content of the annotation more quickly using the symbol.

+

The available annotation categories depend on the specific edition. + Typical examples of annotations are bow placement, identification of expressions or articulation.

+
+ + + Category + Symbol in facsimile + + + score + +
+ + + +
+
+
+ + Expressive labeling + +
+ + + +
+
+
+ + Choral Text + +
+ + + +
+
+
+ + Combination of different categories + +
+ + + +
+
+
+
+ Example symbols for categories in annotations. +
+
+
+ - \ No newline at end of file + diff --git a/add/index.xql b/add/index.xql old mode 100755 new mode 100644 index 0bd642f8..cb834ba3 --- a/add/index.xql +++ b/add/index.xql @@ -3,6 +3,7 @@ xquery version "3.1"; (: IMPORTS ================================================================= :) import module namespace edition = "http://www.edirom.de/xquery/edition" at "data/xqm/edition.xqm"; +import module namespace eutil = "http://www.edirom.de/xquery/eutil" at "data/xqm/eutil.xqm"; (: NAMESPACE DECLARATIONS ================================================== :) @@ -20,8 +21,8 @@ declare option output:omit-xml-declaration "yes"; (: VARIABLE DECLARATIONS =================================================== :) declare variable $edition := request:get-parameter("edition", ""); -declare variable $editionUri := if($edition) then edition:findEdition($edition) else(); -declare variable $preferences := if($editionUri) then(doc(edition:getPreferencesURI($editionUri))) else(); +declare variable $editionUri := edition:findEdition($edition); +declare variable $additional_css_path := eutil:getPreference('additional_css_path', $editionUri); let $eoEditionFiles := collection('/db/apps')//edirom:edition[@xml:id] let $eoEditionFilesCount := count($eoEditionFiles) @@ -77,9 +78,9 @@ let $eoIndexPage := () else (, - if ($preferences//entry[@key = "additional_css_path" and @value != '']) + if ($additional_css_path) then - + else (),