Wiki-Seite anlegen

Aus schokokeks.org Wiki
Wechseln zu: Navigation, Suche

Das Team von schokokeks.org hat stets das Ziel, dem Benutzer seine Arbeit mit und auf dem Server zu vereinfachen. Dennoch gibt es gelegentlich die Notwendigkeit für Dokumentation und Hilfestellung. Hier in diesem Wiki werden die Texte sowohl von den Administratoren geschrieben, können aber auch von jedem Benutzer bearbeitet und ergänzt werden. Auch neue Inhalte dürfen gerne angelegt werden.


Anmeldung am Wiki

Um Änderungen am Wiki vorzunehmen muss man sich Anmelden. Am Kopf jeder Seite befindet sich ein Link zur Anmelde-Seite. Das Anlegen von Benutzerkonten haben wir aufgrund des hohen Spam-Aufkommen deaktiviert. Wenn Sie ein Benutzerkonto anlegen möchten wenden Sie sich bitte an einen der Administratoren.

Wenn Sie ein Konto registrieren, benutzen Sie bitte Ihren System-Benutzernamen oder Ihren vollen Namen, damit wir die Benutzer identifizieren können. Wir behalten uns vor, Namen die wir nicht zuordnen können zu löschen.

Name eines Artikels

Die Wahl des Namens für einen neuen Artikel ist ausgesprochen wichtig. Angenommen Sie möchten über die Ruby-Bibliothek xmpp4r schreiben, so wäre der korrekte Name - ganz einfach - xmpp4r. In dem Fall ist der Namen eindeutig und zukünftige Konflikte mit gleichnamigen Anleitungen können ausgeschlossen werden. Es gibt aber auch Ausnahmen. Der Name Key-Login ist nicht eindeutig genug für einen Artikel über das Authentifizierungverfahren via Public Key mit SSH. Hier sollte der Seitenname Key-Login (OpenSSH) heißen.

Stil-Richtlinien

Die wichtigste Regel zu Beginn:

  • Eine Hilfe-Seite ist besser als keine Hilfe-Seite, egal in welchen Stil sie verfasst ist.

Dennoch freuen wir uns, wenn Sie beim Schreiben gleich auf folgende Punkte achten:

  • Die Anleitungen sollten so weit wie möglich in der dritten Person von einem Benutzer sprechen. Der Begriff Benutzer ist dabei dem Begriff Kunde vorzuziehen.
  • Der Benutzer sollte mit Sie angesprochen werden
  • Bei der männlichen Form ist das weibliche Pendant immer mitgemeint. Bitte kein Binnenmajuskel oder Ähnliches.
  • Versuchen Sie, so einfach wie möglich zu erklären. Vermeiden Sie Tech-Speek.
  • Verwenden Sie deutsche Begriffe, sofern diese gebräuchlich sind. Also nicht Mutterbrett statt Motherboard aber aktualisieren statt updaten.
  • Schreiben Sie in ganzen Sätzen mit möglichst korrekter, deutscher Grammatik.

Wiki-Vorlagen

Für die Vereinfachung von komplexen Layout-Konstrukten stehen einige Wiki-Vorlagen zu Verfügung.

Achtung-Feld (AlertBox)

Diese Vorlage sollte für wichtige Hinweise in der Anleitung genutzt werden.

Verwendung

{{AlertBox
 |title=<titel>
 |content=<text>
 }}

Aussehen

Alert.png
<titel>

<text>


Hinweis-Feld (Box)

Diese Vorlage darf für einfach Boxen verwendet werden, wo sie dem Autor passend erscheinen.

Verwendung

{{Box
 |title=<titel>
 |content=<text>
 |image=Category-Help.png
 }}

Aussehen

Category-Help.png
<titel>

<text>

Wiki-Syntax

Es gibt noch sehr viele weitere Möglichkeiten, Wiki-Texte zu formatieren. Eine Umfassende Hilfestellung gibt die Bearbeitungshilfe der Wikipedia, die auf der selben Wiki-Technologie aufbaut.