Hilfe:Wiki/Wikistruktur

Aus SELFHTML-Wiki
Wechseln zu: Navigation, Suche

Text-Info

Lesedauer
20min
Schwierigkeitsgrad
Anfänger


In diesem Bereich soll die Struktur und Seitenhierarchie des SELFHTML-Wikis behandelt werden. Das SELFHTML-Wiki verwendet zwar dieselbe Software wie die Wikipedia, es ergeben sich aber einige strukturelle Unterschiede. Während die Wikipedia als Lexikon die Aufgabe der Beschreibung von jeweils einzelnen Stichwörtern hat, verwendet SELFHTML eine inhaltlich begründete hierarchische Dokumentation anstatt alle Artikel in einer Hierarchieebene im Hauptnamensraum abzulegen.

Seitenhierarchie[Bearbeiten]

Um diese Strukturierung abzubilden und gleichzeitig die technischen Möglichkeiten der verwendeten MediaWiki-Software (Brotkrumen/Breadcrumb-Navigation) nutzen zu können, werden Seiten und Unterseiten angelegt: (Beschreibungsartikel).

Beispiele für Seitennamen:

Unter anderem für die Auffindbarkeit mittels der Suchfunktion über das Stichwort allein (img, font, while), werden zusätzliche Seiten mit ebendiesem Stichwort als Titel angelegt, welche aber nur als Weiterleitung auf die eigentliche Beschreibungsseite dienen (Stichwortartikel).

Empfehlung: Es ist oft sinnvoll innerhalb von Wikiseiten einen Link auf diese Weiterleitung ([[img]]) anzulegen, als den genauen Pfad [[HTML/Elemente/img]] anzugeben.

Eindeutige Stichwörter[Bearbeiten]

Ist ein Stichwort einmalig, wird im Stichwortartikel lediglich eine Weiterleitung auf die Beschreibung eingefügt.

Mehrdeutige Stichwörter[Bearbeiten]

Eine Begriffsklärung ist notwendig, wenn ein Stichwort mehrere Begriffe aus unterschiedlichen Bereichen bezeichnet. Wenn z. B. verschiedene Programmier- oder Auszeichnungssprachen gleiche Begriffe unterschiedlich behandeln, werden im SELFHTML-Wiki (etwas abweichend von der Regelung in der Wikipedia) zwei Vorgehensweisen verwendet.

Variante 1 – Stichwort führt auf Begriffsklärungsseite

Die Seite Stichwort bekommt einen Text, der die Begriffe und deren Bereiche auflistet und zu ihren Beschreibungsseiten verlinkt.

Am Ende des Artikels wird die Vorlage:Begriffsklärung eingefügt.

Variante 2 – Stichwort führt auf meistverwendete Beschreibungsseite

Wird ein Stichwort in einem Bereich sehr häufig verwendet und in den anderen eher nebensächlich, bekommt die Stichwortseite eine Weiterleitung auf dessen Beschreibungsseite.

Auf allen Beschreibungsseiten eines mehrdeutigen Begriffs, vor allem aber auf den Zielseiten bei Variante 2, ist am Anfang die Vorlage:Begriffsklärungshinweis einzubinden.

Namenskonventionen[Bearbeiten]

Der Name einer Wikiseite sollte so gewählt werden, dass er das Thema widerspiegelt. Leitgedanken sind:

  • Wenn ich nach dem Thema suchte, welchen Namen wählte ich?
  • Ein weiterer Anhaltspunkt ist die Vorstellung eines typischen internen Wiki-Links auf den Artikel. "Gängige Bezeichnung" geht vor "korrekte Bezeichnung".
  • Gibt es Synonyme für den Artikeltitel oder fasst ein Artikel mehrere Themen zusammen, sollten unter diesen Titeln Weiterleitungen (so genannte Redirects) angelegt werden.

Zusammengesetzte Wörter[Bearbeiten]

Zusammengesetzte Wörter werden im Deutschen zusammengeschrieben. Der Bindestrich bietet die Möglichkeit, anstelle der sonst bei Zusammensetzungen üblichen Zusammenschreibung die einzelnen Bestandteile als solche zu kennzeichnen, sie gegeneinander abzusetzen und sie dadurch für den Lesenden hervorzuheben. Die Schreibung mit Bindestrich bei Fremdwörtern (z. B.: 7-Bit-Code, Stand-by-System) folgt den für das Deutsche geltenden Regeln. Ist man unsicher, kann ein Blick ins Glossar von SELFHTML eventuell eine Klärung bringen. Zur Not starten Sie einen Google-Battle.

Stichwort im Singular[Bearbeiten]

Die bevorzugte Schreibweise für ein Stichwort im Seitentitel sollte dessen Singular (Einzahl) sein. Die Einhaltung dieser Empfehlung dient hauptsächlich der Konsistenz bei der Seitenbenennung. Wenn es angemessen erscheint, kann davon abgewichen werden.

Dopplungen vermeiden[Bearbeiten]

Durch die Strukturierung ergibt sich der Kontext, in dem ein allgemeines Wort zu sehen ist, oftmals bereits aus der Struktur selbst. Dass es sich bei Elemente um HTML-Elemente handelt, wird bereits daraus klar, dass bei einem Seitentitel wie HTML/Elemente dieses Elemente eine Unterseite von HTML ist. Bei HTML/HTML-Elemente bringt der Teil „HTML-“ keine Vorteile mehr, er verlängert nur den Seitentitel.

Noch ein Beispiel: Referenz:CSS/Eigenschaftenreferenz – Der Namensraum Referenz zeigt bereits deutlich genug, dass die Seiten darin eine Referenz darstellen, sodass statt …/Eigenschaftenreferenz ein …/Eigenschaften ausreichend ist.

Sonderzeichen vermeiden[Bearbeiten]

Zur Benennung von Seiten sollten wenn möglich nur Buchstaben, Ziffern, Leerzeichen und das Bindestrich-Minus verwendet werden. Andere Zeichen ergeben oftmals beim Verlinken schlecht lesbare URLs. Die korrekte Schreibweise kann im Artikeltext geklärt werden.

Beispielsweise werden Funktionsnamen mitunter mit einem anschließenden Klammernpaar geschrieben, das andeuten soll, dass es sich um eine Funktion handelt. Diese Klammern sind aber nur syntaktisch notwendiges „Beiwerk“ bei der Anwendung und gehören nicht direkt zum Namen der Funktion. Und besonders bei Stichwortseiten für mehrdeutige Bezeichner ist es eher von Nachteil, wenn sie in vielen syntaktischen Schreibweisen existieren, statt nur in einer mit dem „nackten“ Namen.

Bestimmte Zeichen wie \, /, $, |, ", :, #, <, >, [, ], {, } dürfen nicht im Titel des Artikels enthalten sein, da diese als Steuerzeichen besondere Funktionen innerhalb eines URL oder der Wiki-Syntax haben. Die Zeichen !, @ und * sind laut Spezifikation ebenfalls in URLs reserviert (sub-delim), diese Zeichenklasse wird von RFC3986 (URI Generic Syntax) aber für Pfadanteile ausdrücklich zugelassen. Soll ein Artikel ein Thema behandeln, das solche Zeichen enthält (z.B. $_GET für PHP), sind Umschreibungen zu finden, die ohne diese Sonderzeichen auskommen. Der innerhalb des Artikels angezeigte Artikelname kann mit dem Magic Word {{DISPLAYTITLE}} verändert werden. {{DISPLAYTITLE:$_GET}} führt dazu, dass zu Beginn des Artikels die korrekte Schreibweise angezeigt wird. Die Angabe eines optionalen Parameters {{DISPLAYTITLE:$_GET|x}} führt dazu, dass der sonst übliche Hinweis auf die Änderung des Titels (Link zu dieser Seite als $1, $1 steht für den Originaltitel) wegfällt. Hinweis: {{DISPLAYTITLE}} ist, besonders im Zusammenhang mit Seiten, die Variablen (Magic words) enthalten, fehleranfällig. Bitte diese Funktion nur in wirklich notwendigen Fällen benutzen.

Große Anfangsbuchstaben[Bearbeiten]

Die Software dieses Wikis, Mediawiki, ist so eingestellt, dass ein Seitenname im Hauptnamensraum mit einem Großbuchstaben beginnt. Unterseiten dürfen auch mit einem Kleinbuchstaben beginnen.

Abkürzungen[Bearbeiten]

Bei Abkürzungen sollte der Artikel unter dem gebräuchlichen Namen verfasst werden. Für die weniger übliche Form wird eine Weiterleitung eingerichtet.

Unterseiten[Bearbeiten]

Es ist oft sinnvoll, Seiten mit sehr vielen Kapiteln auf Unterseiten zu verteilen, die von der Mutterseite aus über Links zu erreichen sind. Die sich aus der Seitenhierarchie ergebende Breadcrumb-Navigation erleichtert die thematische Übersicht.

[[Portalseite/Hauptseite/Unterseite]].

Gegenprobe: Kann die Unterseite auch ohne ihre "Mutterseite" existieren, ist sie nicht als Unterseite, sondern als "normale" Seite anzulegen.

Die einfachste Methode, eine neue Unterseite zu erstellen, ist durch das Setzen eines neuen [[Links]], der mit einem Schrägstrich beginnt. Die Seite, auf die der Link verweist, ist der Hauptseite „untergeordnet“ und hat damit den auch in anderen Links benutzten Titel [[Hauptseite/Unterseite]]. Es ist auch möglich, Unterseiten von Unterseiten und Unter-Unterseiten zu erstellen. Die Software erstellt dabei am Anfang der Seite automatisch eine Breadcrumb-Navigation mit Links auf die zugehörigen Oberseiten.

Nicht gewünschte Verwendungen[Bearbeiten]

  1. Neue Entwürfe von Artikeln (z. B. [[Beispielartikel/Neuer Entwurf]]) dürfen nicht als Unterseiten von Artikeln erstellt werden, da sie sonst auch über Zufälliger Artikel erreichbar sind. Solche Entwürfe sollten immer im Benutzernamensraum erstellt und bearbeitet werden, bis sie für den Artikelnamensraum die nötige Qualität erlangt haben.
  2. Eine Hierarchisierung von Artikeln soll über Inhaltsverzeichnisse, Kategorien und Navigationselemente erreicht werden, nicht aber über massive Verwendung von Unter(unter)seiten. Die Dateien werden hier nicht in den Pfaden einer Festplatte sondern in einer Datenbank abgelegt.

Wie erstellt man eine Benutzerunterseite?[Bearbeiten]

  1. Öffnen Sie Ihre Benutzerseite, geben Sie einen Link wie [[/Name der Unterseite]] ein und speichern Sie die Änderung.
  2. Nun klicken Sie auf den Link. Es erscheint das Textbearbeitungsfeld, in dem Sie die neue Seite mit Inhalt füllen können.

Wir empfehlen Benutzern, neue Unterseiten zu erstellen, sofern es Ihnen bei der Organisation Ihrer eigenen Arbeit hilft. Allerdings ist SELFHTML-Wiki kein kostenloser Webspace-Provider! Benutzerseiten und -unterseiten mit Inhalten, die nichts mit der Erstellung dieses Wikis zu tun haben, werden in der Regel spätestens nach einmaliger Verwarnung gelöscht.

Weiterleitung[Bearbeiten]

Eine Weiterleitung (auch Redirect), ist die (aus Sicht des Besuchers: automatische) Umleitung eines Artikels auf einen anderen. Sie hat die Aufgabe, das Finden eines Inhaltes zu ermöglichen und zugleich bisherige Verlinkungen (insbesondere externe Verlinkungen) nicht ins Leere laufen zu lassen.

Um eine Weiterleitung anzulegen, tragen Sie im Textfeld der entsprechenden Seite folgendes ein:

  1. am Zeilenanfang ein # ohne Leerzeichen dahinter
  2. dann das Wort REDIRECT oder WEITERLEITUNG und anschließend ein Leerzeichen
  3. dann die Zielseite als Wikilink
Das geben Sie ein So sieht es aus
#REDIRECT [[Neuer Seitenname]] 1. REDIRECT Neuer Seitenname

Nun erscheint im Kopf der neuen Seite der Hinweis „weitergeleitet von <Alter Seitenname>“.

Eine Weiterleitung darf nicht auf eine weitere Weiterleitung verweisen.

Namensräume[Bearbeiten]

Information: Struktur der alten SELFHTML Doku

Die Struktur der ursprünglichen SELFHTML Doku wurde nach 2003 nicht mehr erweitert. Parallel dazu gab es SELFHTML-aktuell.

2010 wurden deshalb für das SELF-Wiki eine Vielzahl von Namensräumen konfiguriert:

  • Doku: (für den Hauptteil der Dokumentation)
  • Artikel: (Beiträge zu speziellen Themen)
  • Kurse: (Lehrgänge zu einzelnen Themen)
  • Themen: (Beiträge zu Themenschwerpunkten)
  • Referenzen: (Übersichtstabellen für den Profi)
  • Glossar: ( kurze Erläuterungen zu Fachbegriffen)

Leider erwies sich das als unübersichtlich und kontraproduktiv.

Lösung

Alle Artikel werden direkt im Hauptnamensraum einsortiert.

Auch die Einteilung in Bereiche wie Basiswissen, Grundlagen, Praxisnah, Weiterführendes Wissen und Technische Ergänzungen wird nicht weiterverfolgt.

Namensraum ist ein Wiki-Konzept zur Gruppierung von Seiten. So unterscheidet das SELFHTML-Wiki z. B. etwa Benutzer-, Diskussions- und interne SELFHTML-Wiki-Seiten.

Der Namensraum ist ein Präfix, das mit einem Doppelpunkt vor dem eigentlichen Seitentitel steht. Beispiel: [[Benutzer:Round]] ist eine Seite aus dem Namensraum "Benutzer", "Round" werden die Initialen des betreffenden Benutzers sein. Davon unbeschadet kann im Hauptnamensraum ein Artikel [[Round]] lauten, ohne dass das zu Konfikten führt.

Auch die Suche unterscheidet nach Namensräumen. Deshalb muss bei der Suche von Artikeln daran gedacht werden, all diejenigen Namensräume zu wählen, in denen man einen Hinweis vermutet. Anders herum sollten Namensräume, in denen man keine Ergebnisse vermutet, nicht durchsucht werden.

Die Nummer eines Namensraums kann bei CSS-Dateien genutzt werden.

Namensräume im SELFHTML-Wiki
Nr. Präfix Bedeutung
0 ohne Prefix Der Hauptnamensraum, in dem im SELFHTML-Wiki die Seiten der Dokumentation liegen.

In einigen Situationen muss auf den Hauptnamensraum mit einem : vor dem Seitennamen Bezug genommen werden.

1 Diskussion: Eine Diskussionsseite zu einem bereits existierenden Artikel im Grundnamensraum
2 Benutzer: Die projektbezogene persönliche Seite eines Benutzers
3 Benutzer Diskussion: Die Diskussionsseiten der Benutzer
4 SELFHTML: Der Metabereich des SELFHTML-Wiki (Meta-Dokumente, Interne Seiten, Konventionen, Regeln) sowie andere Themen, den SELFHTML-Raum betreffend
5 SELFHTML Diskussion: Diskussionsseiten zum SELFHTML-Wiki-Namensraum
6 Datei: In diesem Namensraum sind Bilder und andere mediale Dateien beheimatet.
7 Datei Diskussion: Diskussionsseiten zu den einzelen Mediendateien
8 MediaWiki: Enthält Texte, Systemmeldungen u.ä. der MediaWiki-Software
9 MediaWiki Diskussion: Diskussionsseiten zu MediaWiki
10 Vorlage: Enthält Vorlagen (Textbausteine, Templates), (siehe Vorlagen)
11 Vorlage Diskussion: Diskussionsseiten zu Vorlagen
12 Hilfe: Technische Hilfe zu MediaWiki, der Software, auf der das SELFHTML-Wiki läuft
13 Hilfe Diskussion: Diskussionsseiten zu Hilfeseiten
14 Kategorie: Hier finden Sie die Kategorien, nach denen Inhalte im SELFHTML-Wiki geordnet werden
15 Kategorie Diskussion: Diskussionsseiten zu Kategorien
100 Doku: Enthält die Dokumentation zu einzelnen Themen im SELFHTML-Wiki obsolet, geht im HNR auf
101 Doku Diskussion: Diskussionsseiten zu Grundlagen-Artikeln obsolet, geht im HNR auf
102 Beispiel: Enthält die Code-Seiten für anklickbare Beispiele
103 Beispiel Diskussion: Diskussionsseiten zu Beispielen
110 Kurse: Enthält Lehrgänge zu einzelnen Themen des SELFHTML-Wiki obsolet, geht im HNR auf
111 Kurse Diskussion: Diskussionsseiten zu Kurs-Seiten
120 Referenz: Enthält Referenzen zu den einzelnen Themen des SELFHTML-Wikis (Alias: Referenzen)
obsolet, geht im HNR auf
121 Referenz Diskussion: Diskussionsseiten zu Referenz-Seiten (Alias: Referenzen Diskussion)
130 Themen: Enthält Artikel zu Themenschwerpunkten rumd um Webpublishing obsolet, geht im HNR auf
121 Themen Diskussion: Diskussionsseiten zu Themenschwerpunkt-Seiten
140 Artikel: Enthält Artikel zu den einzelnen Themen des SELFHTML-Wiki obsolet, geht im HNR auf
141 Artikel Diskussion: Diskussionsseiten zu Artikel-Seiten
180 Glossar: Kurze Erklärungen und Informationen zu diversen Stichwörtern obsolet, geht im HNR auf
181 Glossar Diskussion: Diskussionsseiten zu den Glossar-Seiten

Seiten in Namensräumen lassen sich wie jede normale Neue Seite anlegen und Verlinken.

Falls ein Begriff mehrere Bedeutungen hat, zum Beispiel einer aus dem Bereich JavaScript und einer aus dem Bereich PHP, dann verweist eine Begriffsklärung auf die beiden namensgleichen Seiten in den verschiedenen Dokumentationen.

Siehe auch

Einzelseiten statt Monsterseiten[Bearbeiten]

Wenn eine Seite zu groß wird, werden unter anderem Bearbeitungen immer unhandlicher. Dieses Problem kann man teilweise umgehen, indem man nur einen Bereich zum Bearbeiten wählt und nicht die gesamte Seite.

Diese Bereiche ergeben sich automatisch anhand von Zwischenüberschriften. Für jede Überschrift setzt das verwendete Wiki-System automatisch einen Anker, der aus dem Text der Überschrift gebildet wird, sodass man diesen Teilbereich aus dem Inhaltsverzeichnis der Seite oder von anderswo aus verlinken kann (…/Seitenname#Überschrift).

Im Gegensatz zur Verlinkung auf eine Seite an sich, werden die Links auf Anker bei einer Änderung der Überschrift nicht weiter berücksichtigt. Beim Verschieben/Umbenennen einer Seite wird zumindest unter dem alten Namen eine Weiterleitung erstellt. Anker werden nur im Browser ausgewertet und beim Klicken auf Links nicht an den Server übermittelt, sodass dieser rein technisch nicht in der Lage ist, Weiterleitungsmaßnahmen zu ergreifen. Zur Unterstützung beim Pflegen von Links gibt es auch keine Funktion „Verweise auf Anker finden“. Genauer gesagt, sie tauchen auf keiner der Wartungslisten auf. Im Gegensatz dazu kann man Links auf eine bestimmte Seite problemlos anzeigen lassen und die Wartungslisten verwenden.

Das bedeutet vor allem für Themen, die regelmäßig auch direkt angesprungen werden, dass die Stabilität von Verweisen leidet. Solche Themen sind beispielsweise die Beschreibungen von Eigenschaften und Methoden der Javascript-Objekte oder von Attributen der HTML-Elemente. Nicht unbedingt darunter fallen zum Beispiel Abschnitte in einem Tutorial.

  • JavaScript/…/window ist die Seite für allgmeine Informationen zum window-Objekt
  • Die Seiten für Eigenschaften und Methoden werden benannt:
    • JavaScript/…/window/name
    • JavaScript/…/window/blur
    • usw.

Allerdings ist diese Vereinzelung teilweise auch nachteilig für den Leser. Wenn er sich zwischen den Abschnitten hin- und herbewegen möchte, muss er die Seiten wechseln. Die im Browser eingebaute Suchfunktion wirkt nur auf einzelne Seiten und nicht übergreifend. Beispielsweise bestehen reguläre Ausdrücke üblicherweise aus Sonderzeichenkombinationen, die sich schwer bis gar nicht über Suchmaschinen finden lassen. Die Browser-Suchfunktion kann sie jedoch innerhalb einer Seite finden, bei aufgeteilten Seiten hingegen nicht mehr.

Diese Nachteile kann man ohne das Hinzufügen der Nachteile für das Bearbeiten von großen Seiten umgehen, indem auf der übergeordneten Seite oder einer eigens angelegten Zusammenfassungsseite diese Einzelseiten wie eine Vorlage eingebunden werden. An deren Stelle erscheint für den Leser der gespeicherten Seite der Inhalt dieser Vorlage / Einzelseite, im Code bleibt weiterhin der Vorlagen-Verweis stehen.

der Seite für JavaScript/…/window
Allgemeiner Text über das window-Objekt. == Eigenschaften == {{:JavaScript/…/window/name}} usw. == Methoden == {{:JavaScript/…/window/blur}} usw.


Siehe auch[Bearbeiten]