museum-digital/handbook-de
36
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity

Transfer remaining data from old (German lang) handbook

Browse Source
This commit is contained in:
Joshua Ramon Enslin
2022-01-01 00:15:12 +01:00
parent ae1095a8cc
commit 1ec16705ff
227 changed files with 14994 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

138
src/Ausgabe/3-1-Suche.md Normal file
View File

@ -0,0 +1,138 @@
Suche
=====
Die Suchmechanismen bei museum-digital sind komplexer als es zunächst
scheint. Die Mechanismen sind dabei in allen Versionen von
museum-digital gleich - die Ergebnisse sind indes verschieden. Wer nach
\"Albert Schweitzer\" bei museum-digital:westfalen sucht bekommt auch
nur Ergebnisse aus Museen, die Teil dieser Version sind. Wer indes nach
\"Albert Schweitzer\" in der deutschlandweiten Version sucht, bekommt
Ergebnisse aus allen beteiligten deutschen Museen. Die meisten Treffer
wird jener finden, der in der internationalen Version
[global.museum-digital.org](https://global.museum-digital.org/) sucht,
worin alle bei museum-digital beteiligten Museen eingeschlossen sind.
Die Wahl der Version von museum-digital bestimmt das Ergebnis der Suche.
Das gilt auch innerhalb einer Version von museum-digital. Auf der Seite
zu einem Museum oder der Seite zu einer Sammlung gibt es die Möglichkeit
nur innerhalb des gerade gewählten Museums oder der gerade gewählten
Sammlung zu suchen. Der Suchschlitz ändert seine Funktion entsprechend.
Der einfache Suchschlitz
------------------------
Über den Schalter \"Museum\" ist ein Suchschlitz für die Suche nach
Museen, über den Schalter \"Sammlung\" ein Suchschlitz für die Suche
nach Sammlungen erreichbar. Museen und Sammlungen sollten mit diesen
Suchschlitzen gesucht werden. Der am häufigsten gebrauchte Suchschlitz
ist jener für Objekte. Dieser Suchschlitz ist stets oben rechts zu
finden.
![](../assets/frontend/search/searches.jpg)
Um zu verstehen, wie eine Suche über den \"Objekte suchen\"-Suchschlitz
gestaltet ist, ist es gut zunächst die zu den Objekten gespeicherten
Informationen zu betrachten: Im Grunde gibt es zwei Qualitäten von
Informationen, zum einen freie Texte und Begriffe (Objektart, Titel,
Beschreibung) und zum anderen kontrollierte Begriffe (Schlagworte,
Akteure, Orte). Diese kontrollierten Begriffe sind angereichert und
hierarchisiert. Die Hierarchie erlaubt es untergeordnete Begriffe
einzuschließen. Eine Suche nach \"Spielzeug\" kann auch
\"Schaukelpferde\" finden, eine Suche nach \"Deutschland\" kann alle
Treffer für \"Berlin\" einschließen \... . Die kontrollierten Begriffe
bieten deshalb ein großes Potential für eine erfolgreiche Suche. Sie
sind in verschiedenen Katalogen gespeichert. Eine Suche findet aus
diesem Grund zuerst in den Katalogen kontrollierter Begriffe statt,
bevor sie - falls nichts gefunden wurde - zur Indexsuche wird.
Nach Eingabe eines Suchbegriffes wird zunächst der Schlagwortkatalog
durchsucht, wird dort der gesuchte Begriffe gefunden, werden die Treffer
ausgegeben. Wird der gesuchte Begriff nicht gefunden, wird der
Personen-Institutionen-Katalog abgefragt. Falls jetzt etwas gefunden
wird, so wird es ausgegeben, ist dagegen noch immer nichts gefunden,
geht die Frage weiter an den Ortskatalog, bei Treffern wird angezeigt
und die Suche abgebrochen. Wird allerdings auch im Ortskatalog nichts
gefunden tritt die Suche im Volltextindex in Kraft.
![](../assets/frontend/search/suchweg.JPG)
Die Indexsuche schließt fast alle Texte und Begriffe ein, die mit den
Objekten verknüpft sind. Aus dieser Gesamtheit wird in regelmäßigen
Zeitabständen ein Index gebildet, der schnell durchsucht werden kann.
Bei einer Suche mit mehreren Worten kann der Index auf ein- und
ausschließende Weise abgefragt werden. Es lässt sich beispielsweise nach
\"Essen und Trinken\" (ohne Anführungszeichen) suchen. Gefunden werden
alle Objekte in deren Index \"Essen\" und alle Objekte, in deren Index
\"Trinken\" vorkommt. Eine Suche nach \"Essen und Trinken\" - diesesmal
mit Anführungszeichen - sucht alle Objekte in deren Index die
Buchstabenkombination \"Essen und Trinken\" enthalten ist. Eine Suche
nach \"+Essen -Trinken\" findet Objekte für die gilt: \"Essen\" ist im
Index unbedingt enthalten, \"Trinken\" ist jedoch nicht im Index
enthalten. Das Gute an der Suche über einen solchen Index ist, dass die
Reihenfolge der Resultate schon dem Index entnommen werden kann, etwa:
Objekte zu \"Essen und Trinken\" (Buchstabenkombination) zuerst, Objekte
bei denen \"Essen\" UND \"Trinken\" getrennt vorkommen danach, Objekte
bei denen nur einer der Begriffe vorkommt im Anschluss. Innerhalb dieser
Gruppen kann die Häufigkeit berücksichtigt werden, kommt zu einem Objekt
der Begriff \"Essen\" vier mal im Index vor, zu einem anderen Objekt
aber nur drei mal, so wird das erste Objekte vor dem zweiten in der
Trefferanzeige platziert.
Ein kleiner Nachteil der Suche tritt zutage, wenn jemand einen \"Hammer
aus Bremen\" (ohne Anführungszeichen) sucht. Er wird sehr viel finden,
vieles zu \"Hammer\", vieles zu \"aus\" und vieles zu \"Bremen\".
Letztlich war die Frage sehr unscharf formuliert, sollten \"Hämmer, die
in Bremen hergestellt wurden\" gefunden werden, oder \"Hämmer, die in
Bremen genutzt wurden\" oder einfach \"alle Hämmer, die irgendetwas mit
Bremen zu tun haben\"? Im letzten Fall wäre, unabhängig davon dass es
sich sowohl bei \"Hammer\" als auch bei \"Bremen\" um kontrollierte
Begriffe handelt eine Suche nach \"+Hammer +Bremen\" erfolgreicher
gewesen. Mit beiden Begriffen gemeinsam als Sucheingabe wäre der
Algorithmus in keinem der Kataloge fündig geworden und ohnehin zur
Indexsuche fortgeschritten.
### Suche verfeinern
Eine gute Möglichkeit bei der Suche nach mehr als einem Begriff bietet
die Funktion \"Suche anpassen\". Sucht man z.B. zuerst nach \"Hammer\",
dann erscheint oberhalb der Trefferanzeige dieser Schalter. Er erscheint
ebenfalls im Symbolmenu oberhalb der Trefferansicht rechts. Ein Klick
auf einen der Schalter öffnet ein Feld (oder Fenster) mit mehreren
Eingabemöglichkeiten. Hier kann man unter \"Ort\" den Begriff \"Bremen\"
auswählen (nicht: eintippen) und bekommt anschließend jene Objekte
präsentiert, die in Beziehung zum Schlagwort \"Hammer\" und zum Ort
\"Bremen\" stehen. Durch erneutes Anpassen der Suche über \"Art der
Beziehung\" lassen sich bei Eingabe (oder Auswahl) von \"hergestellt\"
alle Hämmer, die in Bremen hergestellt wurden finden.
![](../assets/frontend/search/searchrefine.jpg)
 
Die erweiterte Suche
--------------------
 Die erweiterte Suche lässt sich über den Menupunkt \"Objekt\"
erreichen. Hier können mehrere Suchbegriffe eingegeben (oder im Falle
von Begriffen aus kontrollierten Katalogen: ausgewählt) und miteinander
kombiniert werden. Die erweiterte Suche ist immer eine \"UND-Suche\",
d.h. wer als \"Ort\" wählt \"Bremen\" und als \"Schlagwort\" den Begriff
\"Hammer\", der findet Objekte, die zu \"Bremen\" UND zu \"Hammer\" in
Beziehung stehen. Wie die einfache Suche, so lässt sich auch die
erweiterte Suche anpassen und verfeinern. Durch Auswahl einer \"Art der
Beziehung\" lassen sich etwa alle Hämmer finden, die in Bremen
\"hergestellt\" wurden und durch zusätzliche Auswahl von \"Museum\"
lassen sich alle Hämmer (Schlagwort) finden, die im Deutschen
Schifffahrtsmuseum (Museum) zu finden sind und in Bremen (Ort)
hergestellt (Art der Beziehung) wurden. Der beste Weg zu guten
Resultaten ist der Weg über die Verfeinerung, unabhängig davon, ob die
einfache oder die erweiterte Suche den Ausgangspunkt bildeten.
![](../assets/frontend/search/seachfull.jpg)
### Volltextsuche
Untergebracht im Suchfenster der erweiterten Suche - weil auch mit
dieser kombinierbar - ist die Volltextsuche, die ganz absichtlich die
Kataloge aus kontrollierten Begriffen ignoriert und statt des Begriffes
\"Hammer\" die Buchstabenkombination \"h\"  gefolgt von \"a\" gefolgt
von \"m\" etc. in allen Feldern des Objektdatensatzes sucht.

35
src/Ausgabe/API/README.md Normal file
View File

@ -0,0 +1,35 @@
# API
## Generelles
APIs und alternative Ausgabeformate sind über ein hinzufügen von &output=format an eine gegebene URL erreichbar. Unten finden Sie eine Liste der verfügbaren APIs und Exportoptionen, abgesehen von RSS-Feeds.
Alle APIs sind auch über das Kontextmenü (<kbd>CTRL+Right Click</kbd>) und die Tastensteuerung (<kbd>CTRL+e</kbd>) auf der korrespondierenden HTML-Seite verfügbar.
Wir würden uns freuen, wenn Sie uns über Benachrichtigen könnten, falls Sie die API benutzen, damit wir bei Änderungen schnell Bescheid sagen können.
## JSON API
Museum-Digital bietet JSON APIs für alle zentralen Seiten:
- Alle Museen
- Alle Sammlungen
- Objekt-Suchergebnisse (Beispiel)
- Verfügbare Daten zu einem Objekt (Beispiel)
- Verfügbare Daten zu einer Institution (Beispiel)
- Verfügbare Daten zu einer Sammlung (Beispiel)
- Verfügbare Daten zu einer Objektgruppe (Beispiel)
- Texte auf der Startseite
- Kontakt
## Weitere Export-Optionen
Einige Seiten bieten erweiterte Exportoptionen.
| Seite | Zweck | Beispiel | Format / mime-type |
|----------------------|----------------------------------------------------------|-------------------------------------------------------|-----------------------------|
| Einzelinstitution | vCard (digitale Visitenkarte) einer Institution | Beispiel: Kontakt der Institution mit ID 1 | .vcf / text/vcard |
| Einzelinstitution | Kalender für alle Ausstellungen einer Institution | Beispiel: Ausstellungen der Institution mit ID 1 | .ics / text/calendar |
| Einzelne Ausstellung | Kalendereintrag für eine Ausstellung | Beispiel: Ausstellung mit ID 1 | .ics / text/calendar |
| Einzelnes Objekt | BibTeX-Export für Referenzieren einer Objektseite | Beispiel: Objekt mit ID 1 | .bib / application/x-bibtex |
| Einzelnes Objekt | BibTeX-Export für alle Literatureinträge eines Objektes | Beispiel: Verknüpfte Literatur des Objektes mit ID 1 | .bib / application/x-bibtex |

1
src/Ausgabe/README.md Normal file
View File

@ -0,0 +1 @@
# Ausgabe

15
src/Ausgabe/UI/README.md Normal file
View File

@ -0,0 +1,15 @@
Benutzeroberfläche
==================
Prinzipien
----------
- Weniger Grau / Grundfarbe Weiß
- Jeder Bereich hat eine Überschrift
- Datenschutzerklärung und Impressum von überall erreichbar
- Klar verständliche Icons
Responsive Design
-----------------
Drei verschiedene Modi (Handy, Tablet, Desktop)

53
src/Ausgabe/UI/Sprachsteuerung.md Normal file
View File

@ -0,0 +1,53 @@
Sprachsteuerung
===============
Die Sprachsteuerung ist derzeit noch ein experimentelles Feature, das
nur in Chromium-basierten Browsern (also beispielsweise Google Chrome
oder Vivaldi) nutzbar ist.
Sprachsteuerung aktivieren
--------------------------
Um die Sprachsteuerung zu benutzen zu können, muss man sie zuerst
aktivieren. Dazu klickt man in der Fußzeile auf *\"Einstellungen\"* und
schiebt den Regler hinter *\"Spracheingabe aktivieren\"* nach rechts.
Ist die Spracherkennung generell aktiviert, erscheint am unteren
Bildschirmrand ein Mikrofon-Symbol. Durch einen Klick darauf kann die
Spracherkennung zur konkreten Benutzung angeschaltet werden.
Befehle
-------
Die in der Sprachsteuerung zur Verfügung stehenden Befehle richten sich
immer nach der für die Navigation eingestellten Seite. Es folgt eine
Übersicht der deutschsprachigen Befehle.
Die Steuerung funktioniert über einen Satz, dessen erstes Wort ein Verb
ist.
| Erstes Wort | **Folgende Worte** | **Funktion** |
|-----------------|---------------------------------------|---------------------------------------------------------------|
| öffne | Handbuch | Navigiert zum Handbuch |
|   | nächste Seite | Navigiert zur nächsten Seite in einer paginierten Übersicht |
|   | vorherige Seite | Navigiert zur vorherigen Seite in einer paginierten Übersicht |
|   | ersten Eintrag | Öffnet ersten Listeneintrag auf einer Übersichtsseite |
|   | zweiten Eintrag | Öffnet zweiten Listeneintrag auf einer Übersichtsseite |
|   | Startseite | Navigiert zur Startseite |
|   | Museen / Übersicht der Museen | Navigiert zur Museumsübersicht |
|   | Sammlungen / Übersicht der Sammlungen | Navigiert zur Sammlungsübersicht |
|   | Ausstellungen | Navigiert zur Ausstellungsübersicht |
|   | erweiterte Suche | Navigiert zur Seite für die erweiterte Suche |
|   | Zeitleiste | Navigiert zur (generellen) Zeitleiste |
|   | Bilderwand | Navigiert zur Bilderwand |
|   | Themenübersicht | Navigiert zur Themenübersicht |
|   | Kontakt | Navigiert zur Kontaktseite |
|   | Impressum | Navigiert zum Impressum |
|   | Datenschutz | Navigiert zur Informationsseite zu den Datenschutzbedingungen |
|   | Settings | Navigiert zur Einstellungsseite |
| suche | *Suchbegriff* | Öffnet die Objektsuche für den gegebenen Suchbegriff |
| wechsle | Sprache en | Ändert die Navigationssprache zu Englisch |
|   | Sprache hu | Ändert die Navigationssprache zu Ungarisch |
|   | Design | Wechselt zwischen normalem und alternativen Design |
| deaktiviere | Spracherkennung | Deaktiviert die Spracherkennung |

13
src/Ausgabe/UI/Tastensteuerung.md Normal file
View File

@ -0,0 +1,13 @@
Tastensteuerung
===============
| Tastenkürzel | Kommando |
|----------------------------------------------|----------------------------------------------------------------------------------|
| <kbd>Left</kbd> / <kbd>Right</kbd> | Previous / next image (only on image pages) |
| <kbd>CTRL+Left</kbd> / <kbd>CTRL+Right</kbd> | Previous / Next page (available on all paginated or ordered pages) |
| <kbd>CTRL+I</kbd> | Open image viewer (on object page) |
| <kbd>CTRL+Y</kbd> | Focus search for objects |
| <kbd>CTRL+K</kbd> / <kbd>CTRL+R</kbd> | Toggle overlay for searching for museums / collections |
| <kbd>CTRL+0</kbd> | Return to home page |
| <kbd>CTRL+1</kbd> - <kbd>CTRL+9</kbd> | Open the first, second \... entry in list (museum overview, collection overview) |