DokuWiki: Tags

Ein weiteres wichtiges Element des DokuWiki-System ist die Möglichkeit, Tags zu vergeben und Artikel somit zu kategorisieren. Diese kategorisierten Artikel lassen sich sehr einfach auflisten, Tags eignen sich somit besonders gut für Inhaltsverzeichnisse oder Themensammlungen wie beispielsweise die Dokumentation oder die FAQ. Für Tags wird das vorinstallierte Tag-Plug-in verwendet. Weitere Informationen zu diesem Plug-in gibt es in der offiziellen Dokumentation.

Tag setzen

Um Tags nutzen und sich die getaggten Seiten anzeigen lassen zu können muss zunächst bei einem Artikel das enstprechende Tag gesetzt werden.

Sobald also ein neuer Artikel finalisiert oder ein alter Hilfe-Artikel fertig überarbeitet wurde muss das entsprechende Tag ausgewählt und dann auf der Seite gesetzt werden.

Zum Setzen eines Tags wird folgende allgemeine Syntax verwendet:

{{tag>[TAGNAME]}}

Dieser Befehl muss auf jeder Seite, die mit einem Tag versehen werden soll eingetragen werden. TAGNAME muss dabei durch den gewünschten Namen des Tags ersetzt werden. Es empfiehlt sich, den Befehl direkt unter der ersten Überschrift zu setzen. Auf diese Weise hat man immer sofort einen Überblick über alle auf einer Seite gesetzten Tags. Es können auch mehrere Tags auf einer Seite gesetzt werden. Nach dem Setzen der Tags muss die Seite mit einem Klick auf die Schaltfläche „Speichern“ gespeichert werden.

Nun sind die Tags gesetzt und werden auch auf der Seite selbst neben der Adresse angezeigt.

Weiter unten findet sich eine Auflistung aller bisher im Lernstatt DokuWiki verwendeten Tags.

Es können jederzeit auch beliebige weitere Tags gesetzt werden. Um alle damit kategorisierten Seiten angezeigt zu bekommen muss allerdings - wie im nächsten Kapitel beschrieben - noch ein weiterer Befehl verwendet werden.

Listen von Seiten mit Tags anzeigen

Nachdem man eine Reihe von Artikeln mit einem Tag versehen hat kann man sich nun automatisch all diese Artikel in einer Liste anzeigen lassen. Diese Liste wird mit jedem neuen Artikel den man mit dem entsprechenden Tag versieht automatisch angepasst, man spart sich also das umständliche manuelle anpassen. Aus diesem Grund ist der Einsatz von Tags neben dem unten gezeigten Zusammenstellen von häufig gestellten Fragen oder der Kategorisierung aller Dokumentations-Artikel auch in vielen weiteren Kontexten sehr sinnvoll. Tags sind zudem mit der Rechteverwaltung kompatibel, die Liste der angezeigten Seiten mit einem bestimmten Tag berücksichtigt die Berechtigungsstufe des jeweiligen Nutzers und zeigt diesem nur Seiten an die er auch tatsächlich sehen darf.

Zum Anzeigen einer Liste aller Artikel mit einem Tag wird folgender Befehl verwendet:

{{topic>[:TAGNAME]}}

TAGNAME muss wieder durch den Namen des gewünschten Tags ersetzt werden. Hinter dem Befehl können - wie im Beispiel der FAQ oder der Dokumentation - noch Attribute wie &noheader und &nouser stehen um das Aussehen der Liste weiter zu verändern. Weitere Informationen dazu gibt es in der offiziellen Dokumentation.

Dieser Befehl muss nun auf der Seite eingefügt werden auf der später die Liste angezeigt werden soll. Nach dem Speichern wird die Liste dann an genau der Stelle angezeigt an welcher der Befehl eingefügt wurde.

Beispiele für den Einsatz von Tags

Wie oben erwähnt sind für die Seite der häufig gestellten Fragen (FAQ) und die Hauptseite der Dokumentation bereits Tags vergeben und die Listen aller Artikel mit den entsprechenden Tags werden auf diesen Seiten schon angezeigt. Für alle neu zu erstellenden Tags müssen diese Listen - wie oben beschrieben - noch angezeigt werden. Falls im Laufe der Zeit weitere Tags hinzu kommen können diese hier in der Liste ergänzt werden sodass jeder DokuWiki Administrator schnell einen Überblick über sämtliche verwendeten Tags und die dazugehörigen Seiten zur Anzeige gewinnen kann.

Name Befehl zum Setzen des Tags Beschreibung Liste wird angezeigt auf folgender Seite
FAQ
{{tag>[faq]}}
Markiert alle Artikel, die später auf der Seite zur FAQ angezeigt werden sollen https://doku.lspb.de/doku.php?id=lernstatt:faq
Dokumentation
{{tag>[dokumentation]}}
Markiert alle Artikel, die später auf der Hauptseite der Dokumentation erscheinen sollen https://doku.lspb.de/doku.php?id=lernstatt:dokumentation:index

Anmerkung: Wenn diese Tabelle bearbeitet wird müssen die Befehle zum Setzen der Tags erneut eingetragen werden da das DokuWiki automatisch versucht diese in Tags umzuwandeln und sie dabei zerstört.