Hostsharing Wiki Konventionen: Unterschied zwischen den Versionen

Aus Hostsharing Wiki
Zur Navigation springen Zur Suche springen
Zeile 24: Zeile 24:


Alle Seiten, die die Dokumentation betreffen, werden grundsätzlich der Kategorie "HSDoku" zugeteilt.
Alle Seiten, die die Dokumentation betreffen, werden grundsätzlich der Kategorie "HSDoku" zugeteilt.
== 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:
<pre><nowiki>
#REDIRECT [[Hives]]
</nowiki></pre>
Damit wird [[Hives]] auf [[Hive]] ungelenkt.
'''Synonyme'''
Ein Synonym hingegen, dass nicht allgemein, sondern nur speziell in dem aktuell bearbeiteten Text vorkommen soll, kann durch Umbenennung des Links erreicht werden. Hier linkt [[User|Einrichten eines Benutzers]] in Wirklichkeit auf [[User]]:
<pre><nowiki>
Hier linkt [[User|Einrichten eines Benutzers]] in Wirklichkeit auf [[User]]:
</nowiki></pre>


== Anmerkungen und Diskussionen ==
== Anmerkungen und Diskussionen ==

Version vom 20. Mai 2009, 22:14 Uhr

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

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.

Namenskonvention

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.

Kategorisieren

Praktisch jede Seite 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.


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 [[Hives]]

Damit wird Hives auf Hive ungelenkt.

Synonyme

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

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

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 rein. Man kann 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 fehlendem Fachwissen, die Seite zu korrigieren, beschreibt man den Fehler in der Diskussionsseite und kategorisiert die Seite als "Baustelle" durch den entsprechenden Link am Ende:

----
[[Kategorie:Baustelle]]