Achtung!

Der Webbaukasten wird nicht mehr aktiv betreut und nicht mehr weiter entwickelt. Verwenden Sie stattdessen das CMS-Angebot des RRZE.
Die Dokumentation des CMS-Angebotes finden Sie auf der Website wordpress.rrze.fau.de.

Zur Konfiguration der unterschiedlichen Skripten zur Navigation werden lediglich zwei Dateien benötigt:

Standardmäßig werden diese beiden Dateien im Verzeichnis vkdaten innerhalb des Webverzeichnisses gespeichert.

Konfigurationsdatei navigationsindex.txt

Diese Konfigurationsdatei enthält den Index aller Webseiten (Webbaum), die Teil einer Navigation sein sollen. Es wird definiert, wo und unterhalb welchem Kontext eine Seite liegt, sowie ob und welche Aliase oder Accesskeys diese hat.

Die Indexdatei kann sich in 3 Teile aufgliedern:

  • Definition des Webbaums
  • Definition der Accesskeys
  • Anzeigeeinstellung für die Darstellung der Hauptnavigation

Der wichtigste Teil besteht aus der Definition des Webbaums. Die anderen Teile sind optional.

Definition des Webbaums

Die Seiten des Webbaums werden in der Indexdatei innerhalb des Erstreckungsbereiches der Anweisungen <navigation> ... </navigation> angegeben. (Skripten in einer Version nach 2010 benötigen den Erstreckungsbereich nicht mehr).
Dabei wird jede einzelne Seite auf einer eigenen Zeile angegeben. Die Zeile hat die Form:

Schlüssel <tab> Titel [<tab> Alias/Abkuerzung/Dateiname] 

Die Form des Schlüssels wird durch die folgende Definition bestimmt.

Beschreibung der Schlüssel-Syntax bei der Erstellung eines Navigationsbaumes
U Ursprung, erste Seite. In der Regel die Startseite des Webauftritts
A0 bis A9 Navigationseinträge. Hier träge man die Seiten oder Verzeichnisse ein, die auf der ersten navigationsebene angezeigt werden sollen.
A1-B1 bis A1-B9 Navigationseinträge auf der zweiten Ebene unterhalb des Oberpunktes A1
A1-B1-C1 bis A1-B1-C9 Navigationseinträge auf der dritten Ebene unterhalb des Oberpunktes A1 und Unterhalb des zweiten Punktes B1.
Allgemein: An, An-Bm, An-Bm-Co, usw. Seiten innerhalb der Navigation
Zn Zusatzseiten. Diese werden nicht bei der Hauptnavigation angezeigt und bei Aufruf werden sie ebenfalls nicht in der Breadcrumb-Liste gezeigt. Solche Sieten eignen sich zur Definition von Zusatzseiten, die weder Teil des normalen Inhalts sind, noch zum technischen Menü gehören.
Sn Sonderseiten, die nicht in der Navigation erscheinen sollen, jedoch in der Breadcrumb unterhalb der Startseite. Diese Seiten eignen sich zur Definition eines technischen Menüs.

Der Titel enthält den Seitennamen, wie er in der Navigation auftauchen soll. Der Name wird dabei auch als Datei- oder Verzeichnisname genutzt, sofern nicht im optionalen drauf folgenden Feld ein Alias angegeben ist.

Externe Links oder Nicht-HTML-Dokumente in der Navigation

Optional kann für Zieladressen, die nicht Teil des normalen Webauftritts sind oder für die es keine Webseiten gibt (z.B. PDF-Dokumente), eine URL-Angabe mitgeliefert werden. In diesem fall kann es so aussehen:

Schlüssel <tab> Titel [<tab> Alias/Abkuerzung/Dateiname] 
Schlüssel-URL<tab>http://www.example.org/ 

Aufgrund von Usabilty-Aspekten, empfehlen wir jedoch grundsätzlich in der Navigation nur echte Seiten aufzunehmen die Teil des eigenen Webauftritts sind. Verlinkungen zu fremden Webseiten oder zu Dateien sollten immer innerhalb einer Webseite erfolgen, nachdem mit einem erklärenden Text deutlich gemacht wird, was den Leser hinter dem Link erwartet.

Beispiel

Folgendermaßen könnte eine einfacher Webbaum definiert werden:

  <navigation>
	U 	Startseite 	index	
		A1	Aktuelles			
			A1-B1	Meldungen
			A1-B2	Archiv
		A2	Wir über uns	wir
		A3	Dienstleistungen	dienste
			A3-B1	Programmierung
			A3-B2	Beratung

	S1 Impressum
	S2 Kontakt
	S3	Suche
	S4  Inhaltsuebersicht	
  </navigation>		

Der Webauftritt, der mit obigen Index definiert wurde, enthält 7 Inhaltsseiten (Aktuelles, Meldungen, Archiv, Wir über uns, Dienstleistungen, Programmierung und Beratung). Sowie die Startseite und 4 Sonderseiten (Impressum, Kontakt, Suche, Inhaltsuebersicht), die nur technischen oder organisatorischen Charakter haben.
Für die Seiten Startseite, Wir über uns und Dienstleistungen wurden die Aliase index, wir und dienste definiert.

Folgender Datei- und Verzeichnisbaum wird duch obige Definition aufgebaut:

/index.shtml
/aktuelles/index.shtml
/aktuelles/meldungen.shtml
/aktuelles/archiv.shtml
/wir.shtml
/dienste/index.shtml
/dienste/programmierung.shtml
/dienste/beratung.shtml
/impressum.shtml
/kontakt.shtml
/suche.shtml
/inhaltsuebersicht.shtml

Jedes im Baum definierte Verzeichnis erhält automatisch eine Indexdatei mit Namen index. Des weiteren erhält per Standardeinstellung jede Datei die Endung .shtml. (Dies ist über die untrige Konfiguration änderbar).

Zu Bemerken ist, daß die Datei- und Verzeichnisnamen automatisch nach folgenden Schema ermittelt werden:

  • Alle Leerzeichen im Titel werden durch ein - ersetzt. Mehr als ein - hintereinander werden zu einem einzigen -.
  • Alle Umlaute werden umgewandelt in ihre Umschreibung. Beispielsweise wird aus einem ä im Titel ein ae im Dateinamen.
  • Alle Buchstaben werden in Kleinschrift umgewandelt.
  • Alle Sonstigen zeichen werden gelöscht.
  • Wenn es sich um eine Datei handelt, wird die Standarerweiterung angehängt. Zum Beispiel .shtml

Beispielsweise wird aus dem Titel Wir über uns der Dateiname wir-ueber-uns.shtml oder der Verzeichnisname wir-ueber-uns.

Konfigurationsdatei vorlagen.conf

Die Hauptnavigation läßt sich in ihrer Bedienung und der inhaltlichen Darstellung beeinflussen. So ist es beispielsweise möglich, zu bestimmen, ob Accesskeys angezeigt werden sollen, ob der gesamte Klickbaum sichtbar sein soll, oder ob die Kapitelnummern der Seiten angezeigt werden sollen.

Übersicht der Einstellungen für die Konfigurationsdatei vorlagen.conf
ZeigeBaum 1
Ansicht eines aufgeklappten Navigationsbaums

Abbildung: Navigation mit Oberpunkten

Ist dieser Wert auf 1 gesetzt, wird bei der Nutzung des Navigationsmenüs der gesamte Klickpfad angezeigt. Nicht nur der aktuelle Zweig wird angezeigt, sondern auch alle Links der hierarchisch höheren Navigationsebenen. In anderen Worten: Untermenüs werden jeweils aufgeklappt, während hierarchisch höhere Punkte sichtbar bleiben.

Abbildung zeigt ein typisches Beispiel dieser Navigation. Wie man auch an der Abbildung erkennen kann, bietet sich diese Art der Navigation hauptsächlich bei solchen Webauftritten an, bei denen eine überschaubare Menge von Seiten vorhanden ist. Bei einem Webauftritt mit sehr vielen Untermenüs, die wiederum viele weitere Untermenüs haben, kann diese Art der Navigation dazu führen, daß Benutzer nach unten Scrollen müssen.

Wird der Wert deaktiviert, d.h. auf 0 gesetzt, wird nur der Klickpfad als solcher angezeigt, nicht aber die jeweils hierarchisch höherliegenden Menüs.
Dies bietet sich dann an, wenn der Webauftritt über sehr viele Seiten verfügt, so daß ein normales Menü den Benutzer dazu zwingen würde, nach unten zu scrollen um alle Punkte sehen zu können.

Ansicht eines aufgeklappten Navigationsbaums ohne Ansicht der benachbarten Menüs

Abbildung: Navigation mit reinem Klickpfad

Mit der Version ab Februar 2012 steht weiterhin der Wert 2 zur Verfügung. Diese Einstellung sorgt dafür, daß die gesamte Navigation immer aufgeklappt ist. Eine solche Darstellung wird benutzt für Menüs bei denen mittels CSS3 und HTML5 die Usability und das Aufklappverhalten geregelt werden soll.

ZeigeGeschwister 0
Anzeige der beachbarten Seiten

Abbildung 5: Navigation mit Klickpfad und benachbarten Seiten

Diese Einstellung bietet sich an in Kombination mit der Einstellung ZEIGEBAUM 0.
Die Einstellung bewirkt, daß beim jeweils aktuellen angewählten Element (Seite oder Verzeichnis) die benachbarten Seiten ebenfalls angezeigt werden und nicht nur der Klickpfad.

Accessibility_DFNNumbers 1
Ansicht Navigation mit Kapitelnummerierung

Abbildung: Navigation mit Kapitelnummerierung

Diese Einstellung erlaubt die Darstellung des Menüs mit einer Kapitelnummerierung für die Inhalte.
Dabei wird die Nummerierung automatisch erstellt, gemäß dem Vorkommen der jeweilen Seiten innerhalb der Konfigurationsdatei navigationsindex.txt.

BreadCrumbPartTAG <img src="/img/breadcrumbarrow.gif" height="9" width="20" alt=" " />

Diese Angabe wird für die Anzeige der Breadcrumb-Navigation verwendet. Hier wird definiert, durch welche HTML-Anweisung einzelne Elemente der Breadcrumbleiste voneinander getrennt werden.

Accessibility_Dot <span class="skip">. </span>

Bei allen Navigationen bei denen die Links über Listenelemente oder zusammenstehende Zeile angezeigt werden, kann ein unsichtbarer Punkt hinzugefügt werden. Diese Punkt dient alleine dazu, daß Screenreader, die den Text vorlesen, eine hörbare Sprechpause einlegen; Damit erhöht sich die Zugänglichkeit des Menüs.
Die Sichtbarkeit des Punktes kann über CSS so gestaltet werden, daß dieser in der optischen Darstellung nicht sichtbar ist.

TopLinkListe U, S1

Bei der Anzeige der Hauptnavigation werden normalerweise nur die Seiten ausgegeben, die im obigen Navigationsblock mit dem Schlüssel A beginnen.
Durch Angabe weitere Schlüssel kann man die Navigation jedoch dahingehend erweitern, daß auch andere Seiten (beispielsweise die Seiten für das Inhaltsverzeichnis) als Oberpunkte angezeigt werden. Dies bietet sich besonders dann an, wenn Sie kein technisches Menü anzeigen lassen wollen.

Beispiel

Folgendermaßen sieht eine Definition standardgemäß aus:

ZeigeBaum	1
TopLinkListe	U, S1

Mit diesem Beispiel wird die Navigation den Klickpfad mit allen Obermenüs angezeigt. Außerdem werden die Kapitelnummerierungen angezeigt.
Die Abbildung 3 entspricht diesen Einstellungen.