Benutzer-Werkzeuge

Webseiten-Werkzeuge


kh16:edit-info:start

Editier-Infos

Zur Wiki-Syntax

Die Art und Weise, wie man bei DokuWiki die Inhalte eingibt, wird hier erklärt: https://www.dokuwiki.org/wiki:syntax

Kurze Einführung in die Namensräume eines Wikis

Der Inhalt eines Wikis wird thematisch organisiert, diese Organisation erfolgt in Namensräumen. Ein Namensraum übernimmt hierbei die Funktion eines Ordners oder eines Unterordners, wie ihr ihn auch schon zu Dokumentenorganisation auf euerer Festplatte einsetzt. Nur nennt man dieses Namensraum (namespace).

Im Gegensatz zu Verzeichnissen oder Ordner ist das Trennzeichen kein Slash ‘/’ oder Backslash ‘\’, sondern der Doppelpunkt ’:’. Der Rest funktioniert hier fast analog. Verlinkungen in einem Wiki werden mit zwei eckigen Klammern durchgeführt, was für interne Verweise wie folgt ausschaut.

[[:kh16:projects:]]           <- Verweis auf den untergeordneten Namensraum 
                                 ‘projects’, mit absolutem Pfad.
[[:kh16:projects:myProject]]  <- Verweis auf eine Seite myProject, die unter 
                                 dem Namensraum ‘projects’ untergeordnet 
                                 ist. Dieses entsprich im Vergleich zum 
                                 Dateisystem einer Datei oder einem Dokument.
[[:kh16:projects:myProject:]] <- Verweis auf einen Namensraum ‘myProject’, 
                                 das dem Namensraum ‘projects’ untergeordnet ist.

Der Unterschied wird hierbei durch den letzten Doppelpunkt bestimmt, der ausdrückt, dass Namensräume und keine Dokumente gemeint sind. Im Grunde wie bei der Referenzierung in Dateisystemen, mit einem wichtigen Unterschied. Auch ein Namensraum besitzt eine eigene Seite, die bearbeitet werden kann. Diese Seite trägt automatisch den Namen ‘start’ und ist vergleichbar mit der index.html auf einem Webserver. Sie wird beim Aufrufen des Namensraumes automatisch geladen, wird aber i.d.R. niemals angegeben.

Abbildung der Namensräume als URL

Für den Browser werden die Namensräume in einen Pfad umgeschrieben, der in seinem Verlauf alle Namensräume und am Ende die betreffende Seite enthält. Daher können die gewünschten Seiten einfach über den Pfad referenziert und gefunden werden. Das mach auch externe Verlinkungen in Foren, Twitter oder Facebook einfacher, als die Übergabe von parametrierten URLs. Hier einige Beispiele, wie das Wiki die Namensräume für die URL in einen Pfad umschreibt.

[[:kh16:projects:]]           wird zu wiki.kreativhack.de/kh16/projects/start
[[:kh16:projects:myProject]]  wird zu wiki.kreativhack.de/kh16/projects/myProject
[[:kh16:projects:myProject:]] wird zu wiki.kreativhack.de/kh16/projects/myProject/start

Damit ergeben sich die beiden wichtigen Ordnungselemente des Wikis. Der Namensraum, der einen Container für weitere untergeordnete Namensräume bereitstellt und die Seiten, die alle für uns relevanten Informationen beinhalten.

Nach dem das geklärt ist bleibt die Frage, wie benenne ich meine Namensräume und Seiten? Die Antwort hier drauf ist möglichst kurz aber treffend, denn keiner gibt gerne lange unnötige Referenzen ein. Daher verwendet als Seiten- oder Namensraumbezeichnung kurze Wörter, die den Inhalt treffen. Der entsprechende Name ist auch nur für den Pfad oder die URL interessant, den die internen Verlinkungen werden wenn möglich automatisch umbenannt. Das Wiki verwende für die internen Links immer die Bezeichnung der ersten Überschrift der Seite oder des Namensraumes, auf die der Link zeigt. Sollte diese automatische Bezeichnung für den Link einmal nicht so gewünscht sein, kann man den Verweis auch noch mit einer manuellen Beschriftung versehen. Hierbei wir die Alternativbeschriftung im Link am Ende einfach mit dem Bar ‘|’ abgetrennt, was wie folg aussieht:

[[:kh16:projects:myProject:|Mein cooles Tomatenbewässerungssystem mit dem Pi]]

Absolute oder relative Verlinkung

Genau wie beim Dateisystem kann man relative und absolute Referenzen setzten. Fängt eine Referenz mit einem ’:’ Doppelpunkt an, dann wird absolut von der Dokumentenwurzel an referenziert. Lässt man diesen Doppelpunkt weg, wird die Referenz relativ von der aktuellen Position des Dokumentes in dem man den Link setzt referenziert. Dieses kann man auch erreichen, wenn man am Anfang des Links ein ’.:’ setzt. Ein ’..:’ führt uns für den Start der Referenzierung eine Ebene in den Namensräumen weiter nach oben.

[[:kh16:projects:]] <- absolute Verlinkung von der Dokumentenwurzl
[[.:projects:]]     <- relative Verlinkung von der aktuellen Position
[[..:projects:]]    <- relative Verlinkung die eine Namensraumebene höher beginnt

Anlegen eines eigenen Projektnamensraums

Für euer Projekt solltet ihr euch einen eigenen Projektnamensraum sichern. Hierfür sind folgende Kriterien zu beachten

  • Der Projektnamensraum sollte unter dem Namensraum :projects: untergeordnet werden
  • Verwendet einen kurzen Namen für euren Namensraum
  • Ordnet weitere Seiten eurem Namensraum unter
  • Unterhalb eures Projektnamensraums arbeitet ihr mit relativen Referenzen

Am besten ist es, wenn ihr auf den Namensraum Projekte geht, die eine Auflistung aller Projekte enthält und dort diese Seite bearbeitet. Vorher kopiert ihr euch noch nachfolgendes Codetemplate und fügt dieses an einer passenden Stelle ein und passt den Link der auf euer Projekt verweisen soll entsprechend an.

Vorlage für Projektliste:

/* Den Text in der Überschrift des 3. Grades gegen euren Projektnamen austauschen */
==== MyProject ====

/* Den nachfolgenden Blindtext bitte gegen einen kurzen Anreißer zu eurem Project ersetzen */
The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. The quick brown fox jumps over the lazy dog. 

[[:kh16:projects:MyProject:]] /* Hier bitte den absoluten Pfad zu eurem Projektnamensraum eintragen
/* Wenn eure Projektseite extern liegt, tragt statt dessen die externe URL ein. Beispiel: [[http://www.myProject.org]] */
----
/* Hier eine Leerzeile zum nächsten Projekt einplanen */

Wenn ihr alle Daten angepasst habt, speichert die Änderungen ab. Jetzt sollte der Link auf der Seite in roter Farbe erscheinen, da noch kein Inhalt hinterlegt ist. Klickt diesen an, bearbeitet die Seite und schon wurde ein neuer Projektnamensraum für euch erstellt. Nach dem Speichern wird der Link auf der Projekte Seite in grün dargestellt, da es jetzt einen Inhalt hinterlegt wurde.

Wollt ihr weitere Unterseiten für euer Projekt anlegen, so könnt ihr das auf die gleiche Art und Weise in eurem Projektnamensraum erstellen. Jetzt sollten aber relative Verlinkungen verwendet werden.

[[.:Overview]]  <- Link auf eine Übersichtsseite für euer Projekt.

Geht man nach diesem Schema vor, können keine Seiten 'verloren gehen', da es immer eine Referenz auf die Unterseiten gibt. Zum Schluss ist es dann noch sinnvoll, jede Seite mit einer Überschrift der Klasse 1 zu beginnen, da diese für die Benennung der Links verwendet wird.


Spezialkrams

Mein toller Wiki-Text… Und hier ein Link zur Startseite mit dem Namen „der Link“: der Link oder auch so

kh16/edit-info/start.txt · Zuletzt geändert: 2016/11/10 02:29 von Frank Bartels