Kapitel 3-9 auf VuFind 4 aktualisiert

03_Installation_VuFind.md

@@ -1,48 +1,34 @@
 # Installation von VuFind
 
-Für den Betrieb von VuFind werden diese Softwarekomponenten benötigt:
+In den vorigen beiden Kapiteln haben Sie ein Ubuntu-Linux-Betriebssystem (16.04 LTS) in VirtualBox installiert. In diesem Kapitel installieren wir nun VuFind und die dafür benötigten Softwarekomponenten. Dazu gehören:
 
-* Webserver (Apache),
-* Suchindex (Solr),
-* Programmiersprache (PHP) und
-* Datenbank (MySQL).
-
-Optional kann ein Integriertes Bibliothekssystem an VuFind angebunden werden. (Dies ist nicht Bestandteil des Tutorials.)
+* Webserver (Apache)
+* Suchindex (Solr)
+* Programmiersprache (PHP)
+* Datenbank (MySQL)
 
 ## Aktualisierung des Betriebssystems
 
-Vor der Installation sollte Xubuntu auf den aktuellsten Stand gebracht werden.
-
-Führen Sie folgenden Befehl im Terminal aus:
+Vor der Installation sollte das Betriebssystem auf den aktuellsten Stand gebracht werden. Führen Sie dazu folgenden Befehl im Terminal aus:
 
 ```
-sudo apt-get update
+sudo apt-get update && sudo apt-get dist-upgrade
 ```
 
-Führen Sie danach diesen Befehl aus:
-
-```
-sudo apt-get dist-upgrade
-```
+Der Installation der Updates müssen Sie mit der Antwort „J“ auf die Frage „Möchten Sie fortfahren? \[J/n\]“ zustimmen.
 
 Anschließend sollte das System neu gestartet werden:
 
 ```
-sudo shutdown –r now
+sudo shutdown -r now
 ```
 
 ## Download des Installationspaketes
 
-Stellen Sie sicher, dass Sie die im Terminal eingegebenen Befehle im Kontext des Standardverzeichnisses Ihres Benutzers ausführen. Dieses Verzeichnis wird Homeverzeichnis genannt. In diesem Tutorial verwenden wir den Benutzer „stefan“ und dieser hat sein Homeverzeichnis unter dem Pfad ```/home/stefan/ ```.
-
-Im Terminal erkennen Sie das Homeverzeichnis an einer Tilde mit Dollar-Zeichen (```~$```), die vor dem Cursor angezeigt wird:
-
-![](media/03/image1.png)
-
 Führen Sie im Terminal folgenden Befehl aus:
 
 ```
-wget http://downloads.sourceforge.net/vufind/vufind_2.4.1.deb?use_mirror=osdn -O vufind_2.4.1.deb
+wget http://downloads.sourceforge.net/vufind/vufind_4.1.1.deb?use_mirror=osdn -O ~/vufind_4.1.1.deb
 ```
 
 Die Installationsdatei (ein sogenanntes Paket) wird in Ihr Homeverzeichnis heruntergeladen:
@@ -51,96 +37,69 @@ Die Installationsdatei (ein sogenanntes Paket) wird in Ihr Homeverzeichnis herun
 
 ## Installation des Paketes
 
-Führen Sie diesen Befehl im Terminal aus:
+Führen Sie im Terminal folgenden Befehl aus:
 
 ```
-sudo dpkg -i vufind_2.4.1.deb
+sudo apt install -f ~/vufind_4.1.1.deb
 ```
 
-Dieser Befehl installiert VuFind. Zunächst wird diese Installation jedoch mit einer Fehlermeldung abgebrochen, weil nicht alle für VuFind benötigten Pakete (sogenannte abhängige Pakete) installiert sind. Bei den abhängigen Paketen handelt es sich um die in der Einleitung beschriebenen Softwarekomponenten.
+Dieser Befehl installiert VuFind und alle für VuFind benötigten Pakete (sogenannte abhängige Pakete). Bei diesen Paketen handelt es sich um die in der Einleitung beschriebenen Softwarekomponenten (Apache, Solr, MySQL, PHP).
 
-![](media/03/image3.png)
-
-Sie müssen daher zunächst alle abhängigen Pakete installieren. Danach wird automatisch VuFind installiert.
-
-Führen Sie folgenden Befehl aus:
-
-```
-sudo apt-get install –f
-```
-
-Der Befehl installiert die abhängigen Pakete und gibt zahlreiche Informationen im Terminal aus. Zu Beginn wird ermittelt, welche abhängigen Pakete tatsächlich neu installiert werden müssen. Der Installation müssen Sie mit der Antwort „j“ auf die Frage „Möchten Sie fortfahren? \[J/n\]“ zustimmen. Während der eigentlichen Installation werden weitere Informationen ausgegeben.
+Der Installation müssen Sie mit der Antwort „J“ auf die Frage „Möchten Sie fortfahren? \[J/n\]“ zustimmen.
 
 Für die Installation von MySQL wird die Angabe eines Root-Kennwortes erfragt:
 
 ![](media/03/image4.png)
 
-Aus Sicherheitsgründen sollten Sie dieses Kennwort vergeben. Notieren Sie sich das Kennwort, da es für die spätere Konfiguration von VuFind benötigt wird. Es erscheint ein weiteres Fenster (ohne Abbildung), in welchem Sie die Eingabe des Kennworts wiederholen müssen.
+Notieren Sie sich das Kennwort, da es für die spätere Konfiguration von VuFind benötigt wird. Es erscheint ein weiteres Fenster, in welchem Sie die Eingabe des Kennworts wiederholen müssen. Danach wird die Installation fortgesetzt. 
 
-Danach wird die Installation fortgesetzt und wiederum Informationen im Terminal ausgegeben.
-
-Am Ende der Installation erscheint im Terminal ein Hinweis auf eine erforderliche Verlinkung zwischen VuFind und dem Apache-Webserver:
-
-![](media/03/image5.png)
-
-Diesen Hinweis können Sie ignorieren.
-
-Starten Sie Firefox. (Dieser befindet sich unter „Startmenü &gt; Internet &gt; Firefox Web Browser“.) Rufen Sie die Webseite <http://localhost/vufind> auf. Nach kurzer Zeit erscheint die Startseite von VuFind:
+Wenn die Installation abgeschlossen ist, starten Sie den Firefox Browser. Rufen Sie die Webseite <http://localhost/vufind> auf. Nach kurzer Zeit erscheint die Startseite von VuFind:
 
 ![](media/03/image6.png)
 
-Das Erscheinen der Startseite zeigt, dass die Verlinkung zwischen VuFind und dem Apache-Webserver bereits vorhanden ist. Der Hinweis „Es ist ein Fehler aufgetreten“ bedeutet in diesem Fall, dass VuFind noch nicht gestartet wurde. Dies wird im nächsten Schritt geschehen.
+Der Hinweis „Es ist ein Fehler aufgetreten“ erscheint, weil die Suchmaschine Solr noch nicht gestartet wurde.
 
-## Erste Konfiguration und Start von VuFind
+## Berechtigungen setzen und Solr starten
 
-Führen Sie im Terminal diesen Befehl aus:
+Führen Sie im Terminal folgenden Befehl aus:
 
 ```
-source /etc/profile.d/vufind.sh
+source /etc/profile
 ```
 
-Durch den Befehl wird ein Skript ausgeführt, welches sogenannte Umgebungsvariablen erstellt. Diese werden zum Betrieb von VuFind benötigt und enthalten jeweils den Pfad zur Java-Instanz, zum Hauptverzeichnis von VuFind sowie zum Verzeichnis mit Ihren lokalen Einstellungen für VuFind.
+Durch diesen Befehl werden die Umgebungsvariablen neu eingelesen, was uns einen Neustart erspart. Die Umgebungsvariablen werden zum Betrieb von VuFind benötigt und enthalten den Pfad zur Java-Instanz, zum Hauptverzeichnis von VuFind sowie zum Verzeichnis mit Ihren lokalen Einstellungen für VuFind.
 
-Wechseln Sie in das Hauptverzeichnis von VuFind:
+Geben Sie folgende Befehle ein, um notwendige Berechtigungen für Solr und VuFind zu konfigurieren:
 
 ```
-cd /usr/local/vufind2/
+sudo chown -R $(id -u):$(id -g) /usr/local/vufind/
+sudo chown -R www-data:www-data /usr/local/vufind/local/config
+sudo chown -R www-data:www-data /usr/local/vufind/local/cache
 ```
 
-Starten Sie VuFind:
+Der erste Befehl setzt den aktuell angemeldeten Nutzer als Eigentümer des Verzeichnisses `/usr/local/vufind`. Damit der Apache-Webserver auf bestimmte Verzeichnisse zugreifen kann, wird für die Unterordner `local/config` und `local/cache` der Nutzer `www-data` als Eigentümer gesetzt.
+
+Starten Sie dann den Suchindex Solr:
 
 ```
-./vufind.sh start
+/usr/local/vufind/solr.sh start
 ```
 
-In dem Terminal-Fenster, in welchem Sie VuFind gestartet haben, werden beim Start und während der weiteren Nutzung von VuFind zahlreiche Statusinformationen ausgegeben.
-
-  --------- --------------------------------------------------------------------------------------------
-  **!!!**   Benutzen Sie für alle übrigen Aktionen im Terminal ab sofort ein zweites Terminal-Fenster.
-  --------- --------------------------------------------------------------------------------------------
-
-Aktualisieren Sie die noch im Firefox geöffnete Startseite von VuFind:
+Wenn Sie die noch im Firefox geöffnete Startseite von VuFind aktualisieren, wird der Fehlerhinweis nicht mehr angezeigt:
 
 ![](media/03/image7.png)
 
-Der Fehlerhinweis wird nicht mehr angezeigt und VuFind wurde somit erfolgreich gestartet.
+## Automatische Konfiguration
 
-Öffnen Sie nun ein zweites Terminal und führen Sie nacheinander folgende Befehle aus:
-
-```
-sudo php5enmod mcrypt
-sudo service apache2 restart
-```
-
-Dadurch wird ein für den Betrieb von PHP benötigtes Modul namens „Mcrypt“ korrekt nachinstalliert und anschließend der Webserver (apache2) neu gestartet.
-
-Öffnen Sie in Firefox die Seite <http://localhost/vufind/Install/Home>.
-
-Angezeigt wird die Autokonfiguration von VuFind:
+Öffnen Sie jetzt die Seite <http://localhost/vufind/Install/Home>. Angezeigt wird die Autokonfiguration von VuFind:
 
 ![](media/03/image8.png)
 
-Klicken Sie den Schalter „Reparieren“ hinter „Basic Configuration“ an. Dies wird quittiert mit „Your configuration has been successfully updated.“
+### Grundkonfiguration
+
+Klicken Sie den Schalter „Reparieren“ hinter „Basic Configuration“ an. Dies wird quittiert mit „Your configuration has been successfully updated.“ Wechseln Sie über den Link "Autokonfiguration" wieder zurück auf die vorige Seite.
+
+### Datenbank
 
 Beim Reparieren von „Database“ erscheint eine Eingabemaske:
 
@@ -150,61 +109,63 @@ Geben Sie in das Feld „New user password“ ein Kennwort ein. Wiederholen Sie
 Geben Sie im Feld „MySQL Root Password“ das während der VuFind-Installation vergebene Root-Kennwort für MySQL.
 Klicken Sie anschließend „Abschicken“ an.
 
+## Anbindung Bibliothekssystem
+
 Beim Reparieren von „ILS“ erscheint ebenfalls eine Eingabemaske:
 
 ![](media/03/image10.png)
 
-Wählen Sie „NoILS“ aus der Liste aus.
-Klicken Sie anschließend „Daten absenden“ an.
+Wählen Sie „NoILS“ aus der Liste aus. Klicken Sie anschließend „Daten absenden“ an.
 
-  --------- ---------------------------------------------------------------------------------------------------------------------------------------------------------
-  **!!!**   Alternativ können Sie Ihr Lokalsystem aus der Liste wählen und es konfigurieren. Beachten Sie jedoch, dass dies nicht Bestandteil dieses Tutorials ist.
-  --------- ---------------------------------------------------------------------------------------------------------------------------------------------------------
+---------
+
+**!!!** Alternativ können Sie Ihr Lokalsystem aus der Liste wählen und es konfigurieren. Beachten Sie jedoch, dass dies nicht Bestandteil dieses Tutorials ist.
+
+---------
+
+Zurück auf der Konfigurationsseite erhalten wir weiterhin die Fehlermeldung "ILS... Fehlgeschlagen". Die Autokonfiguration hat die Einstellung auf NoILS mit der Option „ils-offline“ gesetzt, die für Wartungsarbeiten gedacht ist. Wir müssen diese noch auf „ils-none“ setzen, um VuFind zu signalisieren, dass tatsächlich kein Lokalsystem angebunden ist. Diese Einstellung ist in der Datei `/usr/local/vufind/local/config/vufind/NoILS.ini` vorzunehmen. Geben Sie dazu im Terminal folgenden Befehl ein:
+
+```
+sudo sed -i 's/mode = ils-offline/mode = ils-none/g' /usr/local/vufind/local/config/vufind/NoILS.ini
+```
+
+Wenn Sie anschließend die Seite Autokonfiguration neu laden, wird "ILS... OK" angezeigt.
+
+### Sicherheitseinstellungen
 
 Klicken Sie abschließend den Schalter „Reparieren“ im Bereich „Security“ an.
 
-Am Fuß der Seite erscheint nun ein Link zum Abschalten der Autokonfiguration:
+Unterhalb der Statusmeldungen erscheint nun ein Link zum Abschalten der Autokonfiguration:
 
 ![](media/03/image11.png)
 
 Klicken Sie „Disable Auto Configuration“ an.
-Dies wird mit „Auto configuration has been successfully disabled.“ quittiert.
 
-Wechseln Sie ins Terminal. Ersetzen Sie im folgenden Befehl „stefan“ durch Ihren Benutzernamen und führen Sie den Befehl aus:
+Dies wird mit „Auto configuration has been successfully disabled.“ und der Empfehlung quittiert, die Berechtigungen für das Konfigurationsverzeichnis sicherheitshalber anzupassen. Geben Sie dazu noch den folgenden Befehl ins Terminal ein:
 
 ```
-sudo chown –R stefan:stefan /usr/local/vufind2/local/config
+sudo chown -R $(id -u):$(id -g) /usr/local/vufind/local/config
 ```
 
-Dieser Befehl sorgt dafür, dass Ihr Benutzer zum Besitzer des Verzeichnisses\ ```/usr/local/vufind2/local/config```wird. Das Verzeichnis enthält die lokale Konfiguration für VuFind (mehr dazu bei der Konfiguration).
+Dieser Befehl sorgt dafür, dass Ihr Benutzer zum Besitzer des Verzeichnisses `/usr/local/vufind/local/config` wird und dieses nicht mehr durch den Webserver verändert werden kann. Das Verzeichnis enthält die lokale Konfiguration für VuFind (mehr dazu in den folgenden Kapiteln).
 
-Öffnen Sie im Dateimanager den Pfad ```/usr/local/vufind2/local/config/vufind/```. Öffnen Sie darin die Datei ```NoILS.ini```mit der Anwendung „Mousepad“.
+## Zwischenstand
 
-Ändern Sie darin die Zeile
+Die automatische Konfiguration von VuFind ist damit abgeschlossen und das System einsatzbereit.
 
-```
-mode = ils-offline
-```
-
-in
-
-```
-mode = ils-none
-```
-
-Die Einstellung „ils-offline“ ist für Wartungsarbeiten gedacht. Die Einstellung „ils-none“ signalisiert VuFind, dass tatsächlich kein Lokalsystem angebunden ist.
+Im nächsten Schritt importieren wir Testdaten, denn momentan ist der Suchindex noch komplett leer.
 
 ## Sicherungspunkt in VirtualBox setzen
 
-Fahren Sie nun Xubuntu herunter und setzen Sie in VirtualBox einen Sicherungspunkt namens „VuFind 2.4.1, bereit für Testimport“.
+Fahren Sie nun das Betriebssystem herunter und setzen Sie in VirtualBox einen Sicherungspunkt namens „VuFind, bereit für Testimport“.
 
 ## Quellen
 
-Installation Notes. VuFind Documentation.
-<https://vufind.org/wiki/installation_readme>
+VuFind Dokumentation: Installation Notes (Stand: 20.11.2017)
+<https://vufind.org/wiki/installation:notes>
 
-Local Settings Directory. VuFind Documentation.
-<https://vufind.org/wiki/vufind2:local_settings_directory>
+VuFind Dokumentation: Local Settings Directory (Stand 21.12.2015)
+<https://vufind.org/wiki/configuration:local_settings_directory>
 
-VuFind 2.x on Ubuntu. VuFind Documentation.
-<https://vufind.org/wiki/vufind2:installation_ubuntu>
+VuFind on Ubuntu. VuFind Documentation (Stand 20.11.2017)
+<https://vufind.org/wiki/installation:ubuntu>

04_Installation_Testimport.md

@@ -4,64 +4,41 @@ Um VuFind und seine Funktionen erstmalig in Augenschein zu nehmen, empfiehlt sic
 
 ## Download von Testdaten
 
-Öffnen Sie die Seite des „Datendienstes Bibliografische Dienstleistungen“ auf der Webseite der DNB:
-<http://www.dnb.de/datendienst>
+Öffnen Sie das Verzeichnis Testdaten auf dem Downloadserver data.dnb.de der Deutschen Nationalbibliothek:
+<https://data.dnb.de/testdat/>
 
-Wählen Sie dort (ohne Abbildung) den Link „Testdaten“ aus.
-Es öffnet sich eine Liste mit den verfügbaren Testdaten:
+Laden Sie die Datei ```Atest.utf8.mrc``` in das Verzeichnis ```Downloads ``` Ihres Homeverzeichnisses herunter (Rechtsklick auf den Dateinamen und "Ziel speichern unter..." wählen).
 
 ![](media/04/image1.png)
 
-Laden Sie die Datei ```Atest.utf8.mrc ```in das Verzeichnis ```Downloads ```Ihres Homeverzeichnisses herunter.
+## Start von Solr
 
-## Start von VuFind
-
-Starten Sie VuFind:
+Starten Sie die Suchmaschine Solr im Terminal (erforderlich nach jedem Neustart):
 
 ```
-cd /usr/local/vufind2\
-./vufind.sh start
+/usr/local/vufind/solr.sh start
 ```
 
 ## Anpassung der Einstellungen für den Import
 
-Öffnen Sie mit Mousepad die Datei ```marc_local.properties ```im Verzeichnis ```/usr/local/vufind2/import/ ```:
-
-![](media/04/image2.png)
-
-Editieren Sie die drei Werte „collection“, „institution“ und „building“ wie folgt:
+Öffnen Sie die Datei `marc_local.properties ` im Verzeichnis `/usr/local/vufind/import/` mit einem Texteditor und editieren Sie die drei Werte `collection`, `institution` und `building` wie folgt:
 
 ![](media/04/image3.png)
 
-Speichern Sie die Änderungen.
+Achten Sie darauf, dass Sie jeweils das führende `#`-Zeichen entfernen. Speichern Sie die Änderungen.
 
 ## Starten des Importes
 
-Öffnen Sie ein weiteres Terminal:
-
-```
-cd /usr/local/vufind2
-```
-
 Starten Sie den Import:
 
 ```
-./import-marc.sh /home/stefan/Downloads/Atest.utf8.mrc
+/usr/local/vufind/import-marc.sh ~/Downloads/Atest.utf8.mrc
 ```
 
-(Achten Sie darauf, hierbei „stefan“ durch den Namen Ihres Benutzers zu ersetzen.)
-Während des Importes wird für jeden Datensatz aus der Datei eine Statusmeldung in der Form „Added record 2519 from file:99840540X“ ausgegeben. Zum Abschluss meldet der Import unter anderem, wie viele Datensätze er dem Index hinzugefügt hat:
+Während des Importes werden diverse Statusmeldungen ausgegeben. Zum Abschluss meldet der Import unter anderem, wie viele Datensätze er dem Index hinzugefügt hat:
 
 ![](media/04/image4.png)
 
-## Neustart von VuFind
-
-Wechseln Sie nun in das erste Terminal. Drücken Sie die Enter-Taste, um einen Cursor sichtbar zu machen. Starten Sie VuFind neu:
-
-```
-./vufind.sh restart
-```
-
 ## Suche in VuFind
 
 Öffnen Sie VuFind in Firefox und starten Sie eine leere Suche, indem Sie den Suchschlitz leer lassen und einfach „Suchen“ anklicken.
@@ -69,52 +46,42 @@ Wechseln Sie nun in das erste Terminal. Drücken Sie die Enter-Taste, um einen C
 ![](media/04/image5.png)
 
 
-Sie können unter anderem erkennen, dass alle 2.519 importierten Datensätze mit der leeren Suche gefunden wurden. Außerdem wird die Suchdauer mit 8,08 Sekunden angegeben. (Bei Ihnen kann dieser Wert abweichen.)
+Sie können unter anderem erkennen, dass alle 2.455 importierten Datensätze mit der leeren Suche gefunden wurden. Außerdem wird die Suchdauer angegeben (hier: 0,48s).
 
-Die Suchdauer lässt sich verkürzen, indem Sie den Index optimieren.
+Die Suchdauer lässt sich verkürzen, indem Sie den Index optimieren. Außerdem werden Suchanfragen automatisch in einen Cache geladen, so dass eine erneute identische Suche schneller erfolgt.
 
 ## Index optimieren
 
-Wechseln Sie in das Terminal, in welchem Sie den Datenimport durchgeführt haben:
+Führen Sie im Terminal folgenden Befehl aus:
 
 ```
-cd util
-php optimize.php
+php /usr/local/vufind/util/optimize.php
 ```
 
 Die Optimierung läuft ohne Anzeigen im Terminal ab und ist beendet, wenn wieder ein Cursor im Terminal erscheint.
 
-## Suche in VuFind
-
-Führen Sie erneut eine leere Suche durch:
-
-![](media/04/image6.png)
-
-Die Suchdauer ist nun geringer geworden (hier: 2,23 Sekunden).
+Durch die Optimierung des Suchindex werden die Suchen in VuFind jetzt geringfügig schneller erfolgen. In der Dokumentation wird empfohlen, nach jeder Indexierung von neuen Daten den Suchindex zu optimieren.
 
 ## Sicherungspunkt in VirtualBox setzen
 
-Fahren Sie Xubuntu herunter und setzen Sie in VirtualBox einen weiteren Sicherungspunkt namens „mit geladenen Daten aus Testimport“.
+Fahren Sie das Betriebssystem herunter und setzen Sie in VirtualBox einen weiteren Sicherungspunkt namens „mit Testimport“.
 
 ## Weitere Informationen zum Datenimport
 
-Bei jedem Datenimport werden die einzelnen Felder eines Datensatzes einem Indexfeld im Solr-Index zugeordnet. Dies geschieht mit Hilfe von Zuordnungsdateien wie der oben verwendeten ```marc_local.properties```. Eine Zuordnungsdatei steuert, welche Felder aus den zu importierenden Daten in welches Indexfeld im Solr-Index importiert werden.
+Beim Datenimport werden die einzelnen Felder eines Datensatzes einem Indexfeld im Solr-Index zugeordnet. Dies kann mit Hilfe von Einstellungsdateien wie der oben verwendeten ```marc_local.properties``` beeinflusst werden. Die Einstellungen steuern, welche Felder aus den zu importierenden Daten in welches Indexfeld im Solr-Index importiert werden.
 
 Direkt in VuFind importieren können Sie Daten in den Formaten:
 
-* MARC21 (binäres MARC),
-* MARCXML und
-* XML.
+* MARC21 (binäres MARC)
+* MARCXML
+* XML
 
-Für den Import von Daten in XML-Formaten sind größere Anpassungen erforderlich. Dies betrifft ebenfalls das Harvesting von Daten über OAI-PMH ein. Innerhalb des Tutorials werden wir uns ausschließlich mit dem Datenimport in den beiden MARC-Formaten beschäftigen.
+Für den Import von Daten in XML-Formaten sind größere Anpassungen erforderlich. Dies betrifft ebenfalls das Harvesting von Daten über OAI-PMH. Innerhalb des Tutorials werden wir uns ausschließlich mit dem Datenimport in den beiden MARC-Formaten beschäftigen.
 
 ## Quellen
 
-Java Tuning. VuFind Documentation.
-<https://vufind.org/wiki/performance>
+VuFind Dokumentation: Performance (Stand 11.8.2017)
+<https://vufind.org/wiki/administration:performance>
 
-MARC Records. VuFind Documentation.
-<https://vufind.org/wiki/importing_records>
-
-Starting and Stopping VuFind. VuFind Documentation.
-<https://vufind.org/wiki/starting_and_stopping_vufind>
+VuFind Dokumentation: Indexing (Stand: 21.4.2017)
+<https://vufind.org/wiki/indexing>

05_Konfiguration_Ueberblick.md

@@ -1,7 +1,6 @@
 # Überblick zur Konfiguration
 
-Diese Themen werden wir in den Kapiteln zur Konfiguration von VuFind
-behandeln:
+Diese Themen werden wir in den Kapiteln zur Konfiguration von VuFind behandeln:
 
 * Allgemeine Einstellungen
 * Anpassung der Katalogoberfläche
@@ -9,30 +8,42 @@ behandeln:
 * Konfiguration von Kataloganreicherungen
 * Konfiguration der Suche
 
-Weitere Möglichkeiten zur Konfiguration werden in der VuFind-Dokumentation beschrieben (siehe unten im Abschnitt „Weiterführende Informationen“).
+Weitere Möglichkeiten zur Konfiguration werden in der [VuFind-Dokumentation](https://vufind.org/wiki/configuration) beschrieben.
 
-Bevor wir uns mit der eigentlichen Konfiguration beschäftigen, sind einige Vorbereitungen notwendig.
+Bevor wir uns mit der eigentlichen Konfiguration beschäftigen, ist eine kurze Vorbereitung notwendig.
 
-## Vorbereitung für die Konfiguration
+## Vorbereitung der Konfiguration
 
-Für die Konfigurationsdateien von VuFind gibt es ein globales und ein lokales Verzeichnis. Das globale Verzeichnis befindet sich unter dem Pfad ```/usr/local/vufind2/config/```. Das lokale Verzeichnis befindet sich unter ```/usr/local/vufind2/local/config```. Befindet sich eine Konfigurationsdatei auch im lokalen Verzeichnis, so wird für den entsprechenden Teil der Konfiguration die Datei aus dem lokalen Verzeichnis verwendet. Sie sollten alle Konfigurationsdateien, in welchen Sie Veränderungen vornehmen möchten, in das lokale Verzeichnis kopieren.
+Für die Konfigurationsdateien von VuFind gibt es ein globales und ein lokales Verzeichnis:
 
-Während des Tutorials werden wir mit den Dateien ```config.ini```und ```facets.ini```arbeiten. Die Datei ```config.ini```ist die zentrale Konfigurationsdatei von VuFind. Die Datei ```facets.ini```enthält Einstellungen zu den Facetten.
+* Das globale Konfigurationsverzeichnis befindet sich unter dem Pfad `/usr/local/vufind/config/vufind`
+* Das lokale Konfigurationsverzeichnis befindet sich unter dem Pfad `/usr/local/vufind/local/config/vufind`
 
-Öffnen Sie im Dateimanager das Verzeichnis ```/usr/local/vufind2/local/config/vufind/```:
+Befindet sich eine Konfigurationsdatei auch im lokalen Verzeichnis, so überschreiben die dort enthaltenen Informationen die globalen Einstellungen. Es wird empfohlen, Konfigurationsänderungen ausschließlich im lokalen Konfigurationsverzeichnis vorzunehmen. Dazu müssen ggf. Konfigurationsdateien, in denen Sie Veränderungen vornehmen möchten, zunächst in das lokale Verzeichnis kopiert werden.
+
+Während des Tutorials werden wir mit den Dateien `config.ini` und `facets.ini` arbeiten. Die Datei `config.ini` ist die zentrale Konfigurationsdatei von VuFind. Die Datei `facets.ini` enthält Einstellungen zu den Facetten.
+
+Lassen Sie sich die Inhalte des lokalen Konfigurationsverzeichnisses im Terminal anzeigen:
+
+```
+ls /usr/local/vufind/local/config/vufind
+```
 
 ![](media/05/image1.png)
 
-Die Dateien ```config.ini```und ```NoILS.ini```wurden während der Installation beim Schritt „Autokonfiguration“ angelegt.
+Die Dateien `config.ini` und `NoILS.ini`wurden während der Installation beim Schritt „Autokonfiguration“ angelegt. Für unser Tutorial fehlt noch die Datei `facets.ini`.
 
-Kopieren Sie die Datei ```facets.ini```aus dem Verzeichnis ```/usr/local/vufind2/config/vufind/```in das Verzeichnis ```/usr/local/vufind2/local/config/vufind/```.
+Kopieren Sie die Datei ```facets.ini```aus dem globalen Konfigurationsverzeichnis in das lokale Konfigurationsverzeichnis mit folgendem Befehl:
+
+```
+cp /usr/local/vufind/config/vufind/facets.ini /usr/local/vufind/local/config/vufind
+```
+
+Wenn Sie sich die Inhalte des lokalen Konfigurationsverzeichnisses erneut anzeigen lassen, sollte jetzt die Datei `facets.ini` enthalten sein.
+
+![](media/05/image2.png)
 
 ## Quellen
 
-Local Settings Directory. VuFind Documentation.
-<https://vufind.org/wiki/vufind2:local_settings_directory>
-
-## Weiterführende Informationen
-
-Configuration and Customization (VuFind 2.x). VuFind Documentation.
-<https://vufind.org/wiki/vufind2:configuration_and_customization>
+VuFind Dokumentation: Local Settings Directory (Stand 21.12.2015)
+<https://vufind.org/wiki/configuration:local_settings_directory>

06_Konfiguration_Allgemein.md

@@ -1,43 +1,46 @@
 # Allgemeine Einstellungen
 
-Die allgemeinen Einstellungen von VuFind sind in der Datei ``` config.ini```untergebracht. Sie sollten Änderungen an der Konfiguration nur innerhalb der Datei in Ihrem lokalen Konfigurationsverzeichnis durchführen. Die Konfigurationsdatei ist in sich dokumentiert und besteht aus Abschnitten. Die Namen der Abschnitte stehen in eckigen Klammern.
+Die allgemeinen Einstellungen von VuFind sind in der Datei ` config.ini` untergebracht. Die Konfigurationsdatei enthält selbst viele Kommentare, welche die Einstellungsmöglichkeiten erläutern. Die Datei ist in Abschnitte eingeteilt, deren Namen jeweils mit eckigen Klammern markiert sind.
 
-Im Folgenden werden einige allgemeine Einstellungen kurz näher vorgestellt. Um diese Einstellungen durchzuführen, müssen Sie die ```config.ini ```mit Mousepad bearbeiten.
+Im Folgenden werden einige allgemeine Einstellungen kurz näher vorgestellt. Um diese Einstellungen durchzuführen, müssen Sie die `config.ini` mit einem Text Editor bearbeiten.
+
+Konfigurationsänderungen werden sofort im Katalog wirksam (Konfigurationsdatei speichern, Webseite neu laden).
 
 ## E-Mail und Titel
 
-Diese Einstellungen finden sich im Abschnitt „\[Site\]“.
+Diese Einstellungen finden sich im Abschnitt `[Site]`. Beispiel:
 
 ```
 email = stefan.niesner@smail.fh-koeln.de
 title = "MALIS14"
 ```
 
-## Sprache und Zeitzone
+## Sprache, Zeitzone und Datumsformat
 
 ```
-Language = de
-Locale = de_DE
-Timezone = "Europe/Berlin"
+language = de
+locale = de_DE
+timezone = "Europe/Berlin"
+displayDateFormat = "d-m-Y"
 ```
 
 ## Merkliste
 
-Um die Funktion der Merkliste zu aktivieren
+Um die Merklisten-Funktion zu aktivieren:
 
 ```
 showBookBag = true
 ```
 
+Ist die Merkliste aktiviert, erscheint diese unter anderem als Option "In die Zwischenablage" neben den Suchtreffern.
+
+![](media/06/image1.png)
+
 In der mitgelieferten deutschen Übersetzung wurde die Funktionalität der Merkliste mit “Zwischenablage” übersetzt. Im weiteren Verlauf dieser Anleitung wird erklärt, wie Sie Übersetzungen anpassen können.
 
 ## Mehrfachauswahl
 
-Ist die Merkliste aktiviert, erscheint diese unter anderem als Möglichkeit bei der Mehrfachauswahl von Treffern:
-
-![](media/06/image1.png)
-
-Um weitere Möglichkeiten anzubieten, aktivieren Sie diese Option:
+Option zur Mehrfachauswahl von Treffern (Checkbox bei jedem Suchtreffer und Buttons zum Drucken, Speichern usw.) aktivieren:
 
 ```
 showBulkOptions = true
@@ -47,28 +50,28 @@ showBulkOptions = true
 
 ## Exportformate
 
-Die Exportformate werden im Abschnitt „\[Export\]“ eingeschaltet oder ausgeschaltet. In der Werkseinstellung sind RefWorks, EndNote und EndNoteWeb aktiviert. MARC, MARCXML, RDF, BibTeX und RIS (Research Information System Format) sind deaktiviert:
+Die Exportformate werden im Abschnitt `[Export]` eingeschaltet oder ausgeschaltet. In der Werkseinstellung sind RefWorks, EndNote und EndNoteWeb aktiviert. MARC, MARCXML, RDF, BibTeX und RIS (Research Information System Format) sind deaktiviert:
 
-![](media/06/image3.png)
-
-Um zum Beispiel RIS als einziges Exportformat anzubieten müssen Sie diese Einstellungen vornehmen:
+Um zum Beispiel RIS als einziges Exportformat anzubieten müssen Sie folgende Einstellungen vornehmen:
 
 ```
 RefWorks = false
 EndNote = false
 EndNoteWeb = false
-RIS = true
+MARC = false
+MARCXML = false
+RDF = false
+BibTeX = false
+RIS = "record,bulk"
 ```
 
-![](media/06/image4.png)
+![](media/06/image3.png)
 
 ## Navigation innerhalb der Einzeltreffer
 
 In der Werkseinstellung wird ein Einzeltreffer so angezeigt, dass keine Navigation zum vorherigen oder nächsten Treffer aus der Trefferliste möglich ist:
 
-![](media/06/image5.png)
-
-Um diese Navigation einzuschalten, aktivieren Sie die folgende Einstellung innerhalb des Abschnitts „\[Record\]“:
+Um diese Navigation einzuschalten, aktivieren Sie die folgende Einstellung innerhalb des Abschnitts `[Record]`:
 
 ```
 next_prev_navigation = true
@@ -79,19 +82,28 @@ next_prev_navigation = true
 
 ## Übersetzungen
 
-Die Übersetzungen für Elemente von VuFind werden über Konfigurationsdateien im Verzeichnis ```/usr/local/vufind2/languages/```gesteuert. Die Datei für Deutsch ist ```de.ini```. Innerhalb der Datei steht jede Zeile für eine Übersetzung in der Form
+Die Übersetzungen für Elemente von VuFind werden über Dateien im Verzeichnis `languages` gesteuert. Die Datei für Deutsch ist `de.ini`. Die Standardsprachdatei für die deutsche Übersetzung liegt also im Pfad `/usr/local/vufind/languages/de.ini`
+
+Innerhalb der Datei steht jede Zeile für eine Übersetzung in der Form
 
 ```
 Book Bag = "Zwischenablage"
 ```
 
-Die Übersetzung hinter dem Gleichheitszeichen muss in Anführungszeichen stehen.
+Die Übersetzung hinter dem Gleichzeichen muss in Anführungszeichen stehen.
 
-Um Übersetzungen anzupassen, sollten Sie im lokalen Konfigurationsverzeichnis ebenfalls eine ```de.ini``` anlegen. Wechseln Sie dazu im Dateimanager in das Verzeichnis ```/usr/local/vufind2/local```und erstellen Sie dort ein neues Verzeichnis namens ```languages ```. Erstellen Sie in diesem Verzeichnis eine neue, leere Datei namens ```de.ini```und öffnen Sie diese mit Mousepad.
+Um Übersetzungen anzupassen, sollten Sie ebenso wie bei der übrigen Konfiguration Änderungen im Verzeichnis `local` vornehmen. Innerhalb von VuFind werden die Einstellungen für die Übersetzungen vererbt. Einträge für eine Sprache im lokalen Sprachverzeichnis erhalten dabei den Vorrang gegenüber Einträgen in der Standardsprachdatei. Bei Übersetzungen ist keine vollständige Kopie der Standardsprachdatei notwendig. Es reicht aus, wenn Sie Ihre Änderungen in eine neue Datei schreiben. Erstellen Sie dazu mit folgenden Befehlen im Terminal den Ordner `languages` und die Datei `de.ini`:
 
-Wie weiter oben im Abschnitt „Merkliste“ angemerkt ändern wir nun den Begriff „Zwischenablage“ in „Merkliste“.
+```
+mkdir /usr/local/vufind/local/languages
+touch /usr/local/vufind/local/languages/de.ini
+```
 
-Fügen Sie dazu die folgenden Zeilen in Ihre Sprachdatei ein:
+Um eine bestimmte Übersetzung anzupassen, identifizieren Sie diese zuerst in der Standardsprachdatei. Dann kopieren Sie diese Einträge in Ihre lokale Sprachdatei und passen die Übersetzung wie gewünscht an.
+
+Wie weiter oben im Abschnitt „Merkliste“ angemerkt, ändern wir nun den Begriff „Zwischenablage“ in „Merkliste“.
+
+Fügen Sie dazu mit einem Texteditor die folgenden Zeilen in Ihre Sprachdatei `/usr/local/vufind/local/languages/de.ini` ein:
 
 ```
 Add to Book Bag = "In die Merkliste"
@@ -111,24 +123,21 @@ View Book Bag = "Merkliste ansehen"
 Your book bag is empty = "Ihre Merkliste ist leer"
 ```
 
-  --------- ----------------------------------------------------------------------------------------
+---------
+
  **!!!** Achten Sie unbedingt darauf, dass alle Zeilen in der Datei alphabetisch sortiert sind.
-  --------- ----------------------------------------------------------------------------------------
 
-Innerhalb von VuFind werden die Einstellungen für die Übersetzungen vererbt. Einträge für eine Sprache im lokalen Sprachverzeichnis erhalten dabei den Vorrang gegenüber Einträgen in der Standardsprachdatei. Dies hat den zusätzlichen Vorteil, dass die Standardsprachdatei als Referenz genutzt werden kann. Um eine bestimmte Übersetzung anzupassen, identifizieren Sie diese zuerst in der Standardsprachdatei. Dann kopieren Sie diese Einträge einfach in Ihre lokale Sprachdatei und passen die Übersetzung wie gewünscht an.
+--------- 
 
-Nach der Anpassung führen Sie diese Befehle im Terminal aus:
+Damit die Änderungen wirksam werden, müssen wir noch den Cache für die Sprachinformationen leeren. Führen Sie dazu diesen Befehl im Terminal aus:
 
 ```
-cd /usr/local/vufind2/local/cache
-sudo rm –rf languages
+sudo rm -rf /usr/local/vufind/local/cache/languages
 ```
 
-Der zweite Befehl löscht das Verzeichnis mit dem Cache für die Sprachinformationen.
-
 Anschließend werden die angepassten Übersetzungen in VuFind angezeigt.
 
 ## Quellen
 
-Language / Localization Support. VuFind Documentation.
-<https://vufind.org/wiki/vufind2:language_localization_support>
+VuFind Dokumentation: Language Support (Stand 31.05.2016)
+<https://vufind.org/wiki/development:architecture:localization>

07_Konfiguration_Katalogoberflaeche.md

@@ -2,132 +2,91 @@
 
 Die Gestaltung der Katalogoberfläche basiert auf sogenannten Templates. Es gibt HTML-Templates für den Aufbau einer Seite und CSS-Templates für das Layout. Die HTML-Templates enthalten außerdem Programmcode in der Skriptsprache PHP, in welcher die Webseiten von VuFind programmiert sind. Alle Templates zusammen werden als Theme bezeichnet.
 
-In diesem Kapitel werden wir ein eigenes Theme anlegen, den Footer von VuFind anpassen und das VuFind-Logo gegen ein eigenes Logo austauschen. Diese Schritte sollen Ihnen exemplarisch ein Grundverständnis für die Anpassung des Themes von VuFind geben.
+In diesem Kapitel werden wir ein eigenes Theme anlegen, den Footer von VuFind anpassen und das VuFind-Logo gegen ein eigenes Logo austauschen. Diese Schritte sollen Ihnen exemplarisch ein Grundverständnis für die Anpassung von Themes in VuFind geben.
 
-## Eigenes Theme anlegen
+## Eigenes Theme erstellen
 
-Öffnen Sie im Dateimanager das Verzeichnis ```/usr/local/vufind2/themes/```.
-
-Erstellen Sie darin ein neues Verzeichnis mit dem von Ihnen gewünschten Namen für Ihr eigenes Theme. (Hier werden wir den Namen „malis14“ für unser Theme verwenden.)
-
-Erstellen Sie in diesem Verzeichnis eine neue Datei namens ```theme.config.php```und öffnen Sie diese Datei in Mousepad.
-
-Fügen Sie folgenden Code ein:
+Mit Version 4.1 bietet VuFind ein Kommandozeilen-Tool, um ein neues Theme zu erstellen. Das letzte Wort im folgenden Befehl definiert den Namen für das neue Theme (hier werden wir `malis14` verwenden).
 
 ```
-<?php
-return array(
-    'extends' => 'bootprint3'
-);
+php /usr/local/vufind/public/index.php generate theme malis14
 ```
 
-Dies veranlasst VuFind dazu, alle in Ihrem Theme nicht definierten Templates durch entsprechende Templates aus dem Theme „bootprint3“ zu ersetzen. Das Theme „bootprint3“ ist das Standard-Theme von VuFind.
+Die Dateien für das neue Theme liegen anschließend im Ordner `/usr/local/vufind/themes/malis14`. Die lokale Konfigurationsdatei `/usr/local/vufind/local/config/vufind/config.ini` wurde automatisch angepasst. Sie können nun über die Webseite in einem neuen Menüpunkt `Layout` zwischen dem Standard-Theme (Bootstrap) und dem neuen Theme umschalten.
 
-## Theme für VuFind konfigurieren
-
-Öffnen Sie die Datei ```config.ini```aus Ihrem lokalen Konfigurationsverzeichnis und passen Sie darin im Abschnitt „\[Site\]“die Zeile
-
-```
-theme = bootprint3
-```
-
-wie folgt an
-
-```
-theme = malis14
-```
+![](media/07/image0.png)
 
 ## Anpassung des Footers
 
-Legen Sie im Verzeichnis Ihres Themes ein neues Verzeichnis ```templates```an.
-
-Wechseln Sie zum Verzeichnis ```/usr/local/vufind2/themes/bootstrap3/templates/```. Kopieren Sie daraus die Datei ```footer.phtml```in das Verzeichnis ```templates```Ihres Themes.
-
-Öffnen Sie anschließend die Datei mit Mousepad.
-
-Löschen sie diese beiden Zeilen
+Kopieren Sie mit dem folgenden Befehl die Template-Datei `footer.phtml` aus dem Standard-Theme (`/usr/local/vufind/themes/bootstrap3/templates/`) in das Verzeichnis `templates` Ihres Themes.
 
 ```
-<li><a href="<?=$this->url('alphabrowse-home')?>"><?=$this->transEsc('Browse Alphabetically')?></a></li>
-<li><a href="<?=$this->url('search-reserves')?>"><?=$this->transEsc('Course Reserves')?></a></li>
+cp /usr/local/vufind/themes/bootstrap3/templates/footer.phtml /usr/local/vufind/themes/malis14/templates/
 ```
 
-Löschen Sie dann diese beiden Zeilen
+Öffnen Sie anschließend die Datei mit einem Text Editor, löschen Sie die folgenden Zeilen und speichern Sie die Datei:
 
-```
-<li><a href="#"><?=$this->transEsc('Ask a Librarian')?></a></li>
-<li><a href="#"><?=$this->transEsc('FAQs')?></a></li>
-```
+* `<li><a href="<?=$this->url('alphabrowse-home')?>"><?=$this->transEsc('Browse Alphabetically')?></a></li>`
+* `<li><a href="<?=$this->url('search-reserves')?>"><?=$this->transEsc('Course Reserves')?></a></li>`
+* `<li><a href="<?=$this->url('content-page', ['page' => 'asklibrary']) ?>"><?=$this->transEsc('Ask a Librarian')?></a></li>`
+* `<li><a href="<?=$this->url('content-page', ['page' => 'faq']) ?>"><?=$this->transEsc('FAQs')?></a></li>`
 
-Speichern Sie anschließend die Datei.
+Durch die Löschungen wurde die Möglichkeit zum Aufruf der Funktionen „Alphabetisch durchstöbern“ (Browse Alphabetically), Semesterapparat (Course Reserves), „Fachauskunft der Bibliothek“ (Ask a Librarian) und „Häufig gestellte Fragen“ (FAQs) auf der Startseite von VuFind entfernt. Diese Funktionen werden wir innerhalb des Tutorials nicht konfigurieren.
 
-Durch die Löschungen wurde die Möglichkeit zum Aufruf der Funktionen „Alphabetisch durchstöbern“ („Browse Alphabetically“), Semesterapparat („Course Reserves“), „Fachauskunft der Bibliothek“ („Ask a Librarian“) und „Häufig gestellte Fragen“ („FAQs“) auf der Startseite von VuFind entfernt. Diese Funktionen werden wir innerhalb des Tutorials nicht konfigurieren.
-
-**Footer vor der Anpassung**
-
-![](media/07/image1.png)
-
-**Footer nach der Anpassung**
+Die Änderung wird sofort auf der Webseite sichtbar:
 
 ![](media/07/image2.png)
 
 ## Änderung des Logos über dem Suchschlitz
 
-Erstellen Sie im Verzeichnis Ihres Themes ein neues Verzeichnis namens ```images```. Legen Sie dort das gewünschte Logo ab. In unserem Fall ist das die Datei ```malis.png```.
+Legen Sie im Verzeichnis `/usr/local/vufind/themes/malis14` das gewünschte Logo ab. Wenn Sie kein eigenes Logo parat haben, können Sie das hier verwendete  `malis.png` herunterladen:
 
-Kopieren Sie aus dem Verzeichnis ```/usr/local/vufind2/themes/bootprint3/```das Verzeichnis ```less```und alle darin enthaltenen Dateien in das Verzeichnis Ihres Themes.
+```
+wget https://raw.githubusercontent.com/felixlohmeier/vufindtutorialde/master/media/07/malis.png -O /usr/local/vufind/themes/malis14/malis.png
+```
 
-Wechseln Sie in das Verzeichnis ```less```und öffnen Sie darin die Datei ```bootprint.less```mit Mousepad.
+Stellen Sie mit folgendem Befehl sicher, dass das Logo vom Webserver gelesen werden kann:
+```
+chmod +r /usr/local/vufind/themes/malis14/malis.png
+```
 
-Suchen Sie (Strg + F) den untenstehenden Abschnitt und ändern Sie die hier grün markierten Zeilen ab:
+Öffnen Sie nun im Verzeichnis `/usr/local/vufind/themes/malis14/less` die Datei `custom.less` mit einem Text Editor.
+
+1. Ersetzen Sie `@image-path: "../../local_theme_example/images";` durch `@image-path: "../../images";`
+2. Ersetzen Sie den Abschnitt `header` wie folgt:
 
 ```
 header {
-  margin-top:18px;
-  .fa.fa-bars {font-size:21px}
   .navbar {
-    border-radius:5px 5px 0 0;
-    padding:0 10px;
-    #searchForm {display:none !important}
     .navbar-brand {
       background-image:url('../../images/malis.png');
       color:transparent;
       height:100px;
-      margin-top:5px;
       width:100px;
-      &:hover,&:active,&:focus {
-        color:transparent;
+      &:hover,&:active,&:focus { color:transparent; }
     }
   }
+}
 ```
 
-Unter „background-image“ tragen Sie den Pfad Ihres Bildes ein. Die Angaben bei „height“ und „width“ müssen den tatsächlichen Abmessungen Ihres Bildes in Pixeln sein. Das hier verwendete Bild ist 100 Pixel hoch und 100 Pixel breit.
+Unter `background-image` tragen Sie den Pfad Ihres Bildes ein. Die Angaben bei `height` und `width` müssen den tatsächlichen Abmessungen Ihres Bildes in Pixeln entsprechen. Das hier verwendete Bild ist 100 Pixel hoch und 100 Pixel breit.
 
-Führen Sie diese Befehle im Terminal aus:
+Führen Sie abschließend den folgenden Befehl im Terminal aus, um die veränderte Konfiguration zu aktivieren:
 
 ```
-cd /usr/local/vufind2/
-php util/cssBuilder.php
+php /usr/local/vufind/util/cssBuilder.php
 ```
 
-Der zweite Befehl baut aus den Dateien im Verzeichnis „less“ jedes Themes (!!!) eine neue Datei namens ```compiled.css```im Unterverzeichnis ```css```zusammen:
+Der Befehl baut aus den Dateien im Verzeichnis `less` jedes(!) Themes eine neue Datei namens `compiled.css` im Unterverzeichnis `css` zusammen.
 
-![](media/07/image3.png)
-
-Wenn Sie anschließend in Firefox die VuFind-Startseite neu aufrufen, wurde das bisher dort sichtbare VuFind-Logo durch Ihr Logo ersetzt. Dieses Logo wird auch auf allen Unterseiten von VuFind angezeigt.
-
-**Startseite vorher**
-
-![](media/07/image4.png)
-
-**Startseite nachher**
+Wenn Sie anschließend in Firefox die VuFind-Startseite neu aufrufen, wird oben links das verwendete Logo angezeigt.
 
 ![](media/07/image5.png)
 
 ## Quellen
 
-User Interface Customization (VuFind 2.x). VuFind Documentation.
-<https://vufind.org/wiki/vufind2:customizing_the_user_interface>
+VuFind Dokumentation: User Interface Customization (Stand 18.10.2017)
+<https://vufind.org/wiki/development:architecture:localization>
 
-Using LESS. VuFind Documentation.
-<https://vufind.org/wiki/using_less>
+VuFind Dokumentation: LESS / SASS (Stand 2.8.2017)
+<https://vufind.org/wiki/development:architecture:less>

08_Konfiguration_Facetten.md

@@ -1,12 +1,12 @@
 # Konfiguration der Facetten
 
-Die Facetten innerhalb von VuFind basieren auf einzelnen Indexfeldern im Solr-Index. Die Anzeige und das Verhalten der Facetten in VuFind werden durch Einstellungen in der Datei ```facets.ini```gesteuert.
+Die Facetten innerhalb von VuFind basieren auf einzelnen Indexfeldern im Solr-Index. Die Anzeige und das Verhalten der Facetten in VuFind werden durch Einstellungen in der Datei `facets.ini` gesteuert.
 
-## facets.ini
+## Konfigurationsdatei facets.ini
 
-Öffnen Sie die Datei ```facets.ini```aus Ihrem lokalen Konfigurationsverzeichnis mit Mousepad.
+Öffnen Sie die Datei `facets.ini` aus Ihrem lokalen Konfigurationsverzeichnis mit einem Text Editor.
 
-Der mit „\[Results\]“ beginnende Abschnitt enthält die Facetten. Jede Zeile enthält einen Eintrag in der Form
+Der mit `[Results]` beginnende Abschnitt enthält die Facetten. Jede Zeile enthält einen Eintrag in der Form
 
 ```
 SolrIndexName = Anzeigename der Facette
@@ -16,60 +16,36 @@ Der Anzeigename selbst ist in englischer Sprache und wird innerhalb von VuFind
 
 Einträge mit einem Semikolon am Beginn der Zeile sind ausgeblendet und werden nicht dargestellt.
 
-Die Reihenfolge innerhalb von VuFind entspricht der Reihenfolge innerhalb des Abschnitts „\[Results\]“. Möchten Sie die Facetten in einer anderen Reihenfolge anzeigen lassen, sortieren Sie einfach die entsprechenden Zeilen in der Datei ```facets.ini```um.
+Die Reihenfolge innerhalb von VuFind entspricht der Reihenfolge innerhalb des Abschnitts `[Results]`. Möchten Sie die Facetten in einer anderen Reihenfolge anzeigen lassen, sortieren Sie die entsprechenden Zeilen um.
 
 ## Ausblenden von Facetten
 
-Blenden Sie die Facetten für Institution und Gebäude aus:
+Blenden Sie die Facetten für Institution, Gebäude, Signatur (callnumber-first), Genre, Ära und Region aus, indem Sie ein Semikolon vor den jeweiligen Eintrag schreiben:
 
-```
-;institution = Institution
-;building = Library
-```
-
-Blenden Sie die Facette für die Signatur (callnumber-first) aus:
-
-```
-;callnumber-first = "Call Number"
-```
-
-Blenden Sie die Facetten für Genre, Ära und Region aus:
-
-```
-;genre_facet = Genre
-;era_facet = Era
-;geographic_facet = Region
-```
+* `;institution = Institution`
+* `;building = Library`
+* `;callnumber-first = "Call Number"`
+* `;genre_facet = Genre`
+* `;era_facet = Era`
+* `;geographic_facet = Region`
 
 ## Hinzufügen von Facetten
 
 Fügen Sie eine Facette für den Bestand als erste Facette hinzu:
 
-```
-collection = Collection
-```
+* `collection = Collection`
 
-## Übersetzung des Inhalts der Facette „Format“
+## Zwischenstand
 
-Schalten Sie die Übersetzung für den Inhalt der Facette „Format“ ein:
-
-```
-translated_facets[] = format
-```
-
-**Facetten vor der Anpassung**
-
-![](media/08/image1.png)
-
-**Facetten nach der Anpassung**
+Die Änderungen an den Facetten werden sofort auf der Webseite wirksam:
 
 ![](media/08/image2.png)
 
-## Übersetzung des Inhalts anderer Facetten
+## Übersetzung des Inhalts von Facetten
 
 Grundsätzlich können die Inhalte aller Facetten übersetzt werden.
 
-Zunächst müssen Sie analog zur Facette „Format“ definieren, dass eine bestimmte Facette übersetzt werden soll. Dies geschieht durch einen Eintrag, der mit ```translated_facets[] =``` beginnen muss und dem der Name des Indexfeldes folgen muss, auf welchem die Facette basiert.
+Zunächst müssen Sie definieren, dass eine bestimmte Facette übersetzt werden soll. Dies geschieht durch einen Eintrag weiter hinten in der Datei (etwa Zeile 176), der mit `translated_facets[] =` beginnen muss und dem der Name des Indexfeldes folgen muss, auf welchem die Facette basiert.
 
 Für die Sprache wäre dies also
 
@@ -85,27 +61,27 @@ Gehen Sie analog zum Kapitel „Übersetzungen“ in der Anleitung für die allg
 German = "Deutsch"
 English = "Englisch"
 French = "Französisch"
-Japanese = "Japanisch"
 Spanish = "Spanisch"
 Italian = "Italienisch"
+Polish = "Polnisch"
 ```
 
-  --------- -------------------------------------------------------------------------------------------------------------------------------------
-  **!!!**   Achten Sie unbedingt darauf, keine typographischen Anführungszeichen zu verwenden. Diese werden als Teil der Übersetzung angesehen.
-  --------- -------------------------------------------------------------------------------------------------------------------------------------
+---------
 
-**Vor der Anpassung**
+**!!!** Achten Sie unbedingt darauf, keine typographischen Anführungszeichen zu verwenden. Diese werden als Teil der Übersetzung angesehen.
 
-![](media/08/image6.png)
+--------- 
 
-**Nach der Anpassung**
+Die Facette "Sprache" sollte anschließend wie folgt aussehen:
 
 ![](media/08/image7.png)
 
+Damit die Änderung der Sprachdatei wirksam wird, müssen Sie den Cache für die Übersetzung leeren (vgl. Kapitel Übersetzung).
+
 ## Quellen
 
-Facets. VuFind Documentation.
-<https://vufind.org/wiki/adding_facets>
+VuFind Dokumentation: Facets (Stand: 21.12.2015)
+<https://vufind.org/wiki/configuration:facets>
 
-Working wiith Facets. VuFind Documentation.
-<https://vufind.org/wiki/working_with_facets>
+VuFind Dokumentation: Adding Facets. (Stand: 26.1.2016)
+<https://vufind.org/wiki/indexing:adding_facets>

09_Konfiguration_Kataloganreicherungen.md

@@ -1,34 +1,31 @@
 # Konfiguration von Kataloganreicherungen
 
-In VuFind lassen sich diese Elemente der Kataloganreicherung nutzen und konfigurieren:
+In VuFind lassen sich folgende Elemente der Kataloganreicherung nutzen und konfigurieren:
 
 * Titelbilder (Book Covers)
 * Rezensionen (Item Reviews)
 * Auszüge (Item Excerpts)
 * Buchvorschau (Book Previews)
 
-Die Einstellungen für die Kataloganreicherungen finden Sie im Abschnitt ```[Content]``` der ```config.ini```.
+Die Einstellungen für die Kataloganreicherungen finden Sie im Abschnitt `[Content]` der `config.ini`.
 
-  --------- -----------------------------------------------------------------------------------------------------------------------------------------------------------
-  **!!!**   Vor der Nutzung von Google Book Search sollten Sie sich mit den Nutzungsbedingungen unter <https://developers.google.com/books/branding> vertraut machen.
-  --------- -----------------------------------------------------------------------------------------------------------------------------------------------------------
+--------- 
+
+**!!!**   Vor der Nutzung von Google Book Search sollten Sie sich mit den Nutzungsbedingungen unter <https://developers.google.com/books/branding> vertraut machen.
+
+---------
 
 ## Titelbilder (Book Covers)
 
-**Standardeinstellung**
+**Standardeinstellungen (deaktiviert)**
 
-```
-;coverimages = Syndetics:MySyndeticsId,Amazon:MyAccessKeyId,Booksite,
-LibraryThing:MyLibraryThingId,Google,OpenLibrary,Summon:MySerialsSolutionsClientKey,Contentcafe:MyContentCafeID
-;makeDynamicCovers = true
-```
+* `;coverimages = Syndetics:MySyndeticsId,Amazon:MyAccessKeyId,Booksite,LibraryThing:MyLibraryThingId,Google,OpenLibrary,Summon:MySerialsSolutionsClientKey,Contentcafe:MyContentCafeID,LocalFile:PathToFile`
+* `;makeDynamicCovers = true`
 
-**Empfohlene Einstellung**
+**Empfohlene Einstellungen**
 
-```
-coverimages = Booksite,Google,OpenLibrary
-makeDynamicCovers = grid
-```
+* `coverimages = Booksite,Google,OpenLibrary`
+* `makeDynamicCovers = grid`
 
 Ohne Anmeldung frei zur Verfügung stehen Coverbilder von Booksite, Google und Open Library. Sofern Sie über ein Konto eines der anderen unterstützen Dienste verfügen, können Sie diesen Dienst hinzufügen. Sie müssen dabei Ihre jeweilige ID angeben.
 
@@ -54,7 +51,7 @@ Mit dem Wert „grid“ werden Titelbilder generiert, welche den Titel und den N
 
 ## Rezensionen (Item Reviews)
 
-**Standardeinstellung**
+**Standardeinstellung (deaktiviert)**
 
 ```
 ;reviews = Syndetics:MySyndeticsId,SyndeticsPlus:MySyndeticsID,
@@ -79,7 +76,7 @@ Die Rezensionen werden in der Einzeltrefferanzeige im Reiter „Rezensionen“ a
 
 ## Auszüge (Item Excerpts)
 
-**Standardeinstellung**
+**Standardeinstellung (deaktiviert)**
 
 ```
 ;excerpts = Syndetics:MySyndeticsId,SyndeticsPlus:MySyndeticsId
@@ -89,29 +86,30 @@ Auszüge stehen momentan nur von Syndetics zur Verfügung. Sofern Sie dort über
 
 ## Buchvorschau (Book Previews)
 
-**Standardeinstellung**
+**Standardeinstellungen (deaktiviert)**
 
-```
-;previews = Google,OpenLibrary,HathiTrust
-;GoogleOptions['link']  = full,partial
-;OpenLibraryOptions  = full,partial
-```
+* `;previews = Google,OpenLibrary,HathiTrust`
+* `;GoogleOptions['link']  = full,partial`
+* `;OpenLibraryOptions  = full,partial`
 
 **Empfohlene Einstellung**
 
-```
-previews = Google,OpenLibrary
-GoogleOptions['link']  = full,partial
-OpenLibraryOptions  = full,partial
-```
+* `previews = Google,OpenLibrary`
+* `GoogleOptions['link']  = full,partial`
+* `OpenLibraryOptions  = full,partial`
 
-Mit ```GoogleOptions['link']``` stellen Sie ein, dass der Link zu Google Books innerhalb der Trefferliste und der Einzeltrefferanzeige erscheint. Die Einstellung “OpenLibraryOptions” ist vergleichbar mit der für Google
-Books. Sofern Sie nur für vollständig beim jeweiligen Anbieter verfügbare Bücher den Link anzeigen lassen möchten, setzen Sie die Einstellung auf “full”. Mit “partial” wird auch für unvollständig verfügbare Bücher der Link angezeigt.
+Mit `GoogleOptions['link']` stellen Sie ein, dass der Link zu Google Books innerhalb der Trefferliste und der Einzeltrefferanzeige erscheint. Die Einstellung `OpenLibraryOptions` ist vergleichbar mit der für Google Books. Sofern Sie nur für vollständig beim jeweiligen Anbieter verfügbare Bücher den Link anzeigen lassen möchten, setzen Sie die Einstellung auf `full`. Mit `full,partial` wird auch für unvollständig verfügbare Bücher der Link angezeigt.
+
+## Ergebnis
+
+Blättern Sie ein wenig durch die Trefferliste, da nicht für alle Testdaten Cover und weitere Informationen vorhanden sind. So könnte es aussehen:
+
+![](media/09/image6.png)
 
 ## Quellen
 
-Use of External Content. VuFind-Documentation.
-<https://vufind.org/wiki/use_of_external_content>
+VuFind Dokumentation: Use of External Content (Stand: 21.12.2015)
+<https://vufind.org/wiki/configuration:external_content>
 
-Book Previews. VuFind Documentation.
-<https://vufind.org/wiki/book_previews>
+VuFInd Dokumentation: Book Previews (Stand: 21.12.2015)
+<https://vufind.org/wiki/configuration:book_previews>

README.md

@@ -8,7 +8,10 @@ Das Vorhaben wurde auf dem [6. VuFind-Anwendertreffen](http://www.vufind.de/anwe
 
 - [x] ODT mit Pandoc in Markdown umwandeln
 - [x] Gitbook mit Suchfunktion einrichten
-- [ ] Anleitung für VuFind 4 anpassen
+- [ ] Anleitung aktualisieren (VuFind 4)
+    - [ ] Kapitel 1-2 (VirtualBox/Xubuntu)
+    - [x] Kapitel 3-9 (VuFind 4.1)
+    - [ ] Kapitel 10-12 (neue Beispieldaten benötigt)
 - [ ] Test im Kurs [Bibliotheks- und Archivinformatik an der HTW Chur](https://www.gitbook.com/read/book/felixlohmeier/kurs-bibliotheks-und-archivinformatik)
 - [ ] Erweiterung um Kapitel zu Datenimport über OAI-PMH