• Teilen
  • Bookmark "Wiki-Artikel schreiben" auf del.icio.us
  • Bookmark "Wiki-Artikel schreiben" auf Digg
  • Bookmark "Wiki-Artikel schreiben" auf Reddit
  • Bookmark "Wiki-Artikel schreiben" auf StumbleUpon
  • Bookmark "Wiki-Artikel schreiben" auf Facebook
  • Bookmark "Wiki-Artikel schreiben" auf Twitter
  • Bookmark "Wiki-Artikel schreiben" auf Slashdot

Wiki-Artikel schreiben

neue Seite anlegen

Du kannst eine Seite bearbeiten (Eintrag bearbeiten) oder eine neue (neuer internen Link) anlegen:

Eintrag bearbeiten

Einträge bearbeiten kannst du, indem du die jeweilige Seite öffnest und unten oder oben links auf „Seite bearbeiten“ klickst.

Neuer internen Link

Falls die Seite, die du anlegen willst noch nicht existiert musst du diese durch das Setzten eines neuen internen Links anlegen, dies wird dir hier erklärt:

Kategorie suchen

Du suchst dir auf der Wikihauptseite eine passende Kategorie. Falls du keine passende finden kannst, nutze bitte das Forum, damit die Projektleitung eine Kategorie anlegen kann oder für dich eine auswählt.

Link setzten

Du setzt einen internen Link, indem du den Namen des Beitrags in solche Klammern setzt:

[[ ]]
[[Kategorie: Name]]  #Seite "Name" im Namespace "Kategorie"

Vor den Seitennamen kommt vor einem Doppelpunkt : der sog. Namespace, dieser stellt die Kategorie der Seite dar. Eine Übersicht über die verfügbaren Namespaces bekommst du hier oder mit einem Klick auf den Übersicht-Button.
→ Der Seitenname sollte so kurz wie möglich sein, warum erfährst du im Abschnitt Anwendung.

Seite anlegen

Der Name erscheint nach dem Einfügen des internen Links in eine beliebige Seite (hierzu eignet sich der Spielplatz) und anschließendem Speichern der Seite rot:
Name
Mit einem Klick darauf kannst du die Seite anlegen und somit dieses Thema eröffnen.

Alternative: "Seite-anlegen-Box"

Solch eine Box befindet sich auch auf der Startseite (nur für angemeldete Benutzer sichtbar):
In der ersten Box wählst du einen passenden Namespace aus, in der zweiten trägst du den Namen der Seite ein.
→ Der Seitenname sollte so kurz wie möglich sein, warum erfährst du im Abschnitt Anwendung.

Syntax

Wenn du mehr über die Syntax erfahren willst kannst du hier nach sehen.

Absätze

Absätze müssen mit

\\


erzwungen werden

kursiv, fett, unterstrichen, Überschriften

Kursiv, fett, unterstrichen,…. kannst du bequem über die Werkzeugleiste des Bearbeitungsfensters einfügen, indem du die Wörter markierst und auf die Schaltfläche klickst.

Interne Links

interne Links kann man so anlegen und umschreiben:

[[link |name]]
#Beispiel:
[[einleitung|freies OS]]

freies OS

Externe Links

[[http://seite.de |name]]
#Beispiel:
[[http://mein.homelinux.com|Startseite]]

Startseite

Code formatieren

Zur Verwendung siehe Abschnitt Anwendung!

"code"-Tag

Den Code zwischen <code> </code>

hängen
<code> beispiel </code>

beispiel


Natürlich auch mit Syntax-Highlighting: Dazu den Code zwischen <code [Programmiersprache]> </code> hängen
<code php> <?php header("location: seite"); ?> </code>

<?php
   header("location: seite");
?>

"file"-Tag

Den Code einfach zwischen <file [Programmiersprache] [datei.irgendwas]> </file> hängen, dabei wird [datei.irgendwas] durch einen Dateinamen ersetzt. Dadurch wird eine Datei mit dem Inhalt des Blocks und mit dem vorgegebenen Dateinamen zum Download angeboten. Hierfür muss [Programmiersprache] durch eine Programmiersprache ersetzt werden. Bei normalem Text verwendet man plain:

<file plain note.txt> beispiel </file> 
note.txt
 beispiel 

Natürlich funktioniert auch hier Syntax-Highlighting: Dazu den Code zwischen <file [Programmiersprache] [datei.irgendwas]> </file> hängen

<file php test.php> <?php
   header("location: seite");
?> </file> 


test.php
 <?php
   header("location: seite");
?> 

Bilder

Wenn du Bilder für deine Seite brauchst kannst du dies über die Bilderschaltfläche (4. von rechts) in der Werkzeugleiste des Bearbeitungsfensters tun. Wie du bemerken wirst sind schon einige Bilder vorhanden. Weitere kannst du gerne hochladen.
Dann erhältst du zum Beispiel so einen Code:
{{:articles.jpg|}}

Durch Leerzeichen an der richtigen Stelle kannst du das Bild rechts, links oder zentriert darstellen.
Rechts: {{ :articles.jpg|}}



Links: {{:articles.jpg |}}



Zentriert: {{ :articles.jpg }}



Anwendung

Gliederung

Die Seite muss immer mit einer Überschrift des größten Levels (H1) anfangen, diese Überschrift wird nachher von diesem Wiki als Seitentitel verwendet. Nun setzt du je nach Gliederung das Level ausgehend von H1 herunter.

Wraps und weitere Plugins

In der Editorleiste findet sich das Wrap Plugin, mit diesem kannst du einfach Boxen, Spalten und vieles mehr erstellen. Die Verwendung dieses Plugins ist erwünscht!
Ein weiteres Plugin erlaubt das Einfärben von Text, dies kann manchmal auch praktisch sein.
Um eine Übersicht des aktuellen Namespaces zu erstellen kannst du das letzte Plugin in der Liste verwenden, dieses erstellt eine praktische kategorieübersicht.

Befehle

Befehle werden mit der Vorlage Befehl dargestellt, diese findet sich in der Editorleiste unter dem Punkt Vorlagen. Der Befehl wird von <code bash> </code> umrahmt. Dies ergibt mit dem Beispiel <code bash>user@server:~$ echo "test"</code> folgendes Bild:

user@server:~$ echo "test"

Zu Verdeutlichung wird vor den Befehl die sog. Bash-Prompt eingefügt, diese findet sich in verschiedenen Ausführungen ebenfalls in den Vorlagen. Beispiele:

  • user@server:~$
  • user@client:~$
  • user@system:~$
  • (…)

Je nach dem, ob der Befehl auf dem Server oder auf dem Client ausgeführt werden soll, wählt man die passende Vorlage. Für allgemeine Anleitungen, die sowohl für den Server, als auch für den Client gültig sind, kann man die Prompt kürzen:

  • :~$
  • :~#

Dabei stellt die untere einen Login mit dem Benutzer root dar. Diese Prompts finden sich nicht in den Vorlagen.

Befehle oder Pakete im Fließtext

Wenn auf Befehle oder Pakete in einem Text eingegangen wird, sind diese mit ''mit dicktengleicher Schrift'' mit dicktengleicher Schrift zu kennzeichnen.

Normaler Code-Text

Code-text, beispielsweise von Konfigurationsdateien oder Paketauflistungen müssen mit
<code> </code>

 code 

dargestellt werden. Auch hierzu existiert unter Vorlagen eine Vorlage.

Shell-Skripte (downloadbar)

Skripte sollten, wenn möglich mit dem „file“-Tag formatiert werden. So kann das Skript gleich heruntergeladen werden: <file bash test.sh>#!/bin/bash </file>

test.sh
#!/bin/bash 

Hierfür existiert ebenfalls eine Vorlage.

Dateipfade

Dateipfade im Fließtext sollten ''mit dicktengleicher Schrift'' mit dicktengleicher Schrift formatiert werden.

Zeichen

Nicht fertige Seiten oder Stellen müssen mit

 FIXME 

FIXME kenntlich gemacht werden.
Weitere Zeichen kann man hier und hier nachsehen.

Signatur

Der jeweilige Autor ist dazu aufgerufen, unter dem Beitrag seine Signatur zu hinterlassen. Diese kann in der Editorleiste durch einen Klick auf Unterschrift einfügen generiert werden. Es empfiehlt sich vor die Signatur einen Absatz \\<nowiki> sowie eine horizontale Linie <nowiki>---- einzufügen:

\\
----

Anleitungskopf

In den Oberen Bereich des Artikels sollten folgende Angaben gemacht werden:

  • getestete Systeme
  • Konventionen
  • Softwarevoraussetzungen
  • Schwierigkeitsgrad

Beispiel:

<WRAP left info 68%>
**Softwarevoraussetzungen:** Paketverwaltung | Texteditor \\
**Schwierigkeitsgrad:** Einfach \\
**Ausgetestet mit folgenden Betriebssystemen:** Ubuntu (alle Versionen) | Debian (alle Versionen)
</WRAP>

<WRAP left important 68%>
**Achtung! //sudo//:** 
In dieser Anleitung verdeutlicht der Befehl ''sudo'', dass die folgende Codezeile mit Root-Rechten ausgeführt werden muss. 
In normalen **Ubuntu** Installationen (Root-/VServer siehe Debian) kann dies durch den Befehl ''sudo'' erreicht werden. \\
Bei **Debian** wird bei der Installation ein Passwort für den Root-Benutzer festgelegt, so kann man sich entweder direkt als Root  oder als "normaler" Benutzer mit Eingabe von ''su''  als Root einloggen (Root-Passwort benötigt) -> ''sudo'' bleibt dann überflüssig!
</WRAP>

Softwarevoraussetzungen: Paketverwaltung | Texteditor
Schwierigkeitsgrad: Einfach
Ausgetestet mit folgenden Betriebssystemen: Ubuntu (alle Versionen) | Debian (alle Versionen)

Achtung! sudo: In dieser Anleitung verdeutlicht der Befehl sudo, dass die folgende Codezeile mit Root-Rechten ausgeführt werden muss. In normalen Ubuntu Installationen (Root-/VServer siehe Debian) kann dies durch den Befehl sudo erreicht werden.
Bei Debian wird bei der Installation ein Passwort für den Root-Benutzer festgelegt, so kann man sich entweder direkt als Root oder als „normaler“ Benutzer mit Eingabe von su als Root einloggen (Root-Passwort benötigt) → sudo bleibt dann überflüssig!

Diese Vorlage befindet sich ebenfalls unter Vorlagen in der Editorleiste und wird unter Anleitungskopf geführt

Abstract & Tags

Das sog. Abstract wird in DokuWiki aus dem ersten Abschnitt generiert und u.a. zur Volltextsuche verwendet. Dieses Wiki verwendet das Abstract außerdem als Description in den Metadaten. Deshalb ist es wichtig nach der ersten Überschrift (H1) mit einem kurzen Text den Inhalt der Anleitung, sowie die verwendete Software zu beschreiben.
Optional besteht die Möglichkeit zusätzliche Keywords zu setzen, dies geschieht durch Einfügen und Ergänzen folgendes Codes:

{{keywords>word1 word2 wordN}}

Diese Keywords werden anschließend in den Metadaten verwendet.



chrisge 2011/06/22 16:09

Diskussion

Geben Sie Ihren Kommentar ein. Wiki-Syntax ist zugelassen:
LTTDQ
 
  • Teilen
  • Bookmark "Wiki-Artikel schreiben" auf del.icio.us
  • Bookmark "Wiki-Artikel schreiben" auf Digg
  • Bookmark "Wiki-Artikel schreiben" auf Reddit
  • Bookmark "Wiki-Artikel schreiben" auf StumbleUpon
  • Bookmark "Wiki-Artikel schreiben" auf Facebook
  • Bookmark "Wiki-Artikel schreiben" auf Twitter
  • Bookmark "Wiki-Artikel schreiben" auf Slashdot
Sonstiges
Drucken/exportieren
Archiv

Archivierter Inhalt der alten Seite