Hostsharing Wiki Konventionen

Aus Hostsharing Wiki
Wechseln zu: Navigation, Suche

Praktisches über den Umgang mit dem HS Wiki und der Software Mediawiki.


Allgemein - Klauen erwünscht!

Das Wiki verändert sich mit dem zunehmenden Wissen seiner Benutzer. Daher kann man beim Neuanlegen einer Seite durchaus mal schauen, wie ist eine andere Seite (die gut und sinnvoll aussieht) aufgebaut. Am Besten lernt man, indem man den Quelltext guter Seiten oder Absätze studiert. Auch der eine oder andere Blick in die Hilfe ist zu Beginn sehr sinnvoll. Aber lasse dich nicht abschrecken. Ändern, Korrigieren, das Arbeiten, geht hier von der ersten Minute an. Also los, mach mit!

Was soll ins Wiki

Nur reine Dokumentation.

Also nicht: Aktuelles, Produkte, Preise, Hostsharing eG. von der www.hostsharing.net Seite.

Seiten anlegen

Das funktioniert dadurch, dass man auf einer vorhandenen Seite einen Link anlegt:

[[Link]]

Danach klickt man den Link und befindet sich auf der neuen, noch leeren Seite. Die kann man jetzt mit "Bearbeiten" mit Inhalten füllen.

Eine oder mehrere Seiten?

Bitte nicht sofort viele Seiten zu einem Thema anlegen und miteinander verlinken, das stört wahrscheinlich nur unnötig den Lesefluss. Oft ergibt sich die Struktur während des Schreibens von selbst, wie in Guter_Stil beschrieben.

Zuerst schreibt man einfach alle Information in eine einzige Seite, gliedert mit Headlines und vertraut auf die seiteninterne Navigation (TOC – Table Of Content), die schon sehr gut ist. Erst wenn die Seite wirklich zu lange wird oder man neue Bereiche erkennt, die klar abgrenzbar sind, teilt man die Seite auf. Dann kann man eine eigene Menüleiste kreieren und einsetzen, um wiederum Zusammenhänge zwischen den Seiten herzustellen.

Seiten überarbeiten

Bitte beim Überarbeiten bereits vorhandener komplexer Seiten vorsichtig sein, wenn jemand schon gut strukturiert hat und sich auch offenbar tiefe Gedanken dazu gemacht hat. Dann kann der Originalautor auch auf dessen Benutzerseite angeschrieben werden (oder natürlich HS-Intern direkt kontaktiert werden): "Du ich hätte da mal eine Idee..."

Außerdem bietet jede Seite eine Diskussionsseite, die in der Regel von den Autoren auch beobachtet wird (die Autoren erhalten bei Änderungen ein Mail). Diese kann ebenfalls zur Kommunikation verwendet werden.

Anrede des Lesers

Siehe auch Guter Stil und die zugehörige Diskussion.

Solange keine völlig unpersönliche Sprache gewählt ist, wirst du als Leser in der zweiten Person mit "Du" angesprochen. Die erste Person "ich" wird gemieden, damit auch andere an dem Text weiter arbeiten können. Benötigen wir ausnahmsweise die erste Person, verwenden wir wir. :-)

Namenskonvention

Eine Verpflichtung zu bestimmten Namensformen gibt es erst mal keine. Suche Dir einfach einen passenden Namen aus. Seiten können verschoben oder unter anderem Namen aufgerufen werden. Alles lässt sich nachträglich ändern!

Seiten, die sich auf eine bestimmte Software beziehen, sollten so benannt werden, dass der Name der Seite mit dem Namen der Software beginnt. So taucht die Seite in den von MediaWiki automatisch erstellten Seitenlisten alphabetisch unter dem Namen der Software einsortiert auf und ist für Leser leichter aufzufinden. Installationsanleitungen sollten "Xyz installieren" heißen, wenn die Software Xyz heißt, wenn es mehrere Versionen der Software gibt, sollte auch die Versionsnummer mit in den Seitentitel aufgenommen werden und insgesamt müssen Installationsanleitungen natürlich entsprechend kategorisiert werden.

Seiten, die einen sehr allgemeinen Titel tragen und grundsätzliche Erklärungen beinhalten (Hive) verdienen es vielleicht, ins Glossar übernommen zu werden:

[[Kategorie:Glossar]]

Kategorisieren

Jede Seite und jede Vorlage sollte kategorisiert werden. Das geschieht am Ende der Seite durch einen speziellen Link mit dem Namensraum "Kategorie":

[[Kategorie:HSDoku]]
[[Kategorie:Installationsanleitungen]]
[[Kategorie:Plone]]

Alle Seiten, die die Dokumentation betreffen, werden grundsätzlich der Kategorie "HSDoku" zugeteilt. Alle Vorlagen bekommen die Kategorie "Vorlage".

Weiterleitungen und Synonyme

Weiterleitungen

Es kommt ab und zu vor, dass man im Text etwas erwähnen möchte, das an anderer Stelle schon beschrieben ist, aber der Name des Links passt einfach nicht. So lange es sich um eine andere Wortform handelt, bietet sich die Einrichtung einer Weiterleitung an.

Dass Hive und Hives auf die gleiche Seite zeigen, ist das Ergebnis einer Weiterleitung. Die originale Seite trägt den Namen "Hive", damit der Link Hives auf die gleiche Seite zeigt, bedient er sich eines Redirects. Wenn man einen solchen Link anlegt, zeigt er zuerst einmal auf die neue Seite "Hives". Dort kann man folgendes eintragen:

#REDIRECT [[Hive]]

Damit wird Hives auf Hive ungelenkt.

Synonyme

Ein Synonym hingegen, das nicht allgemein, sondern nur speziell in dem aktuell bearbeiteten Text vorkommen soll, kann durch Umbenennung innerhalb des Links erreicht werden. Hier linkt Einrichten eines Benutzers in Wirklichkeit auf User:

Hier linkt [[User|Einrichten eines Benutzers]] in Wirklichkeit auf [[User]]:

Weiterführende Links

Ist ein Thema zu umfangreich, um es auf einer Seite abzuhandeln, erhält die Hauptseite einen Absatz Weiterführende Links. Hier werden die direkt darunter liegenden Seiten verlinkt.

Für die Seite Pakete zum Beispiel sieht das so aus:


== Weiterführende Links ==
* [[WEB-Paket]]
* [[Static-Web]]

Im Beispiel muss natürlich auch in der Seite WEB-Paket ein entsprechender Absatz abgelegt werden, da sie ebenfalls auf "tiefer" liegende Seiten verweist.

Es bleibt dem Autor überlassen, ob der Absatz "Weiterführende Links" ganz oben oder ganz unten in der Seite angelegt wird, nur irgendwo in der Mitte hat er naturgemäß wenig Sinn. "Ganz oben" hat auf allen Seiten Sinn, die so lang sind, dass er sonst nicht gleich am Bildschirm auftaucht.

Menüleiste

In besonderen Fällen kann eine Menüleiste wie zum Beispiel Vorlage:HSDoku-DomainLinks‏‎ verwendet werden. Und zwar dann, wenn die durch die Menüleiste verlinkten Seiten in sehr engem thematischen Zusammenhang stehen, und es dem Benutzer ermöglicht werden soll, schnell zwischen den zusammengehörenden Seiten zu wechseln. Eine Menüleiste darf nur auf den Seiten eingesetzt werden, die direkt von ihr verlinkt werden. Die Menüleiste entfernt und ersetzt den sonst eingeblendeten Titel der Seite!

Löschen und Ersetzen von Seiten

Löschen

Seiten werden nur in sehr begründeten Ausnahmefällen gelöscht, z.B. Spam, Seiten, deren Funktion einen temporären Charakter hatte und die durch Änderungen überflüssig geworden sind oder Seiten, die nicht mit sinnvollen Inhalten gefüllt werden (können). Löschen kann diese Seiten nur ein Administrator im Wiki. Daher wird eine solche Seite als Löschkandidat markiert, indem die entsprechende Vorlage:Löschkandidat an den Anfang gestellt (und der Grund für den Löschvorschlag in der zugehörigen Diskussionsseite festgehalten) wird:

{{Löschkandidat}}

Es ist immer vorher zu prüfen, ob die Seite nicht ersetzt werden kann. Das gilt insbesondere dann, wenn davon auszugehen ist, dass Links auf diese Seite zeigen, ob von innerhalb des Wikis oder von außen.

Ersetzen

Meist werden Seiten ersetzt, Zum Beispiel dann, wenn die auf der ursprünglichen Seite beschriebene Methode veraltet ist. Da aber immer noch Links auf die urprüngliche Seite zeigen können, löschen wir den Inhalt und verwenden als Seiteninhalt einzig und allein die Vorlage:Ersetzt, um mit ihrer Hilfe einen Link auf die neue Seite zu setzen und eine Begründung anzugeben. Dadurch wird gleichzeitig die ursprüngliche Seite aus allen Kategorien entfernt, außer Kategorie:Veraltet.

Anmerkungen und Diskussionen

Jede Seite hat zusätzlich einen Bereich für die Diskussion. Ist der Inhalt der Seite fehlerhaft, falsch oder einfach diskussionswürdig, schreibt man das entsprechend da hinein. Man kann auch Diskussionen in seine Beobachtungsliste aufnehmen und wird dann bei Änderungen/Antworten durch Andere benachrichtigt.

Es wird leicht übersehen, neben dem Link "Bearbeiten" gibt es ein kleines "+", das einem die Antwort erleichtert, man kann sogar einen Betreff eingeben, der als Überschrift erscheint.

Seiten mit fehlerhaften oder falschen Inhalten

Ist man nicht in der Lage, zum Beispiel aufgrund fehlenden Fachwissens, die Seite zu korrigieren, beschreibt man den Fehler in der Diskussionsseite und kategorisiert die Seite als "Baustelle" durch die Vorlage:Baustelle:

{{Baustelle}}