Wiki-Tutorial

Aus DebianforumWiki
Zur Navigation springen Zur Suche springen
Wiki ‹ Wiki ‹ Wiki-Tutorial


Hinweis.png Hinweis: Diese Artikel soll die Grundlagen vermitteln, damit jeder an unserem Wiki mithelfen kann. Schau auch in den Quelltext dieser Seite.


Wenn du gute Artikel verfassen willst, musst du 2 Dinge wissen:

  1. Wie wird Text in einem Wiki formatiert
  2. Welche Konventionen gibt es in unserem Wiki zu beachten

Es ist auch wichtig, dass du dich in dieser Reihenfolge damit auseinander setzt. Denn kannst du mit der Wikisyntax nichts anfangen, wird dein Text unstrukturiert und unübersichtlich. Außerdem kannst du dich dann nur schwer an die Konventionen halten, da wir dank MediaWiki viele über Vorlagen machen können.

Wikisyntax

Dieses kleine Tutorial ist mehr ein Crashkurs, als eine vollständige Referenz. Für weitergehende Fragen verweise ich deshalb an dieser Stelle auf das sehr gute Handbuch des MediaWiki.

Für alle die schon im alten MoinMoin-Wiki aktiv waren, dürfte vieles bekannt vorkommen. Alle die schon mal bei z.B. der Wikipedia bereits ein MediaWiki benutzt haben, denen werden ich wohl nichts neues erzählen.

Absätze und Paragraphen

Fangen wir also mit der Syntax des Wikis an. Das wichtigste Element ist wohl die Strukturierung durch die Einteilung in Absätze und Paragraphen.

Absätze erzeugt man im MediaWiki einfach durch eine Leerzeile. So wird z.B. aus: 

Das ist der erste Absatz.

Das ist der zweite Absatz.

Dieses hier:

Das ist der erste Absatz.

Das ist der zweite Absatz.

Kommen wir also zu den Paragraphen. Paragraphen sind Abschnitte eines Artikels, die unter einer Überschrift zusammengefasst sind. So ist etwa die Einführung ein Paragraph. Die Überschrift eines Paragraphes wird automatisch vom Wiki in das Inhaltsverzeichnis eines Artikels aufgenommen. In der Praxis wird ein Paragraph dadurch gebildet, dass man eine Überschrift angibt und dann ganz gewohnt weiterschreibt. Du kannst also einen Paragraphen folgendermaßen erzeugen: 

== Einführung ==

Um gute Artikel zu verfassen gibt es erst einmal technisch 2 Dinge die man beachten muss:
...

Wie man sieht wird also eine Überschrift durch ein "==" links und rechts definiert. Du kannst auch Paragraphen in einander Verschachteln, indem man für jede Ebene ein zusätzliches "=" eingibt. Damit kannst du deinen Artikel recht einfach gut strukturieren.

Textformatierung

Weiterhin kann man Textformatierungen vornehmen, das sind die aus Office bekannten Funktionen einen Text kursiv oder fett erscheinen zu lassen.

Willst du Text fett darstellen, wird er einfach von ''' eingeschlossen. 


'''Dieser Text ist fett.'''

Dieser Text ist fett.

Fast genauso kannst du kursiven Text darstellen, er muss nur statt von ''' mit '' eingeschlossen werden. 


''Dieser Text ist kursiv.''

Dieser Text ist kursiv.

Du kannst das auch jederzeit kombinieren: 

'''''Dieser Text ist fett und kursiv,'' allerdings nicht''''' bis zum Schluss.'''

Dieser Text ist fett und kursiv, allerdings nicht bis zum Schluss.

Ebenso ist es möglich, Text präformatiert darzustellen, etwa für Quelltexte oder ASCII-Art. Dies kann man erledigen, indem man der entsprechenden Zeile ein Leerzeichen voran setzt. Oder indem man den Text in < pre > Tags einschließt. 

< pre >Das ist präformatiert.< /pre >

Das ist präformatiert.

Verlinkung

Ein weiteres wesentliches Konzept ist das, der Verlinkungen. Dabei gibt es zwei Arten von Verlinkung:

  • externe Verlinkungen auf andere Seiten
  • interne Verlinkungen auf andere Artikel

Einen externen Link erzeugst du, indem du die URL des Ziel und einen Text, der angezeigt werden soll, mit einem Leerzeichen getrennt von eckigen Klammer eingibst. Ein Link zum df erzeugst du also mit: 

[http://debianforum.de Debianforum.de, die Antwort auf alle ungestellten Debianfragen]

Debianforum.de, die Antwort auf alle ungestellten Debianfragen

Genauso einfach ist es einen internen Link zu erzeugen. Dies erreichst du, indem du den Artikelnamen in zwei eckigen Klammern einschließt. 

[[Hauptseite]]

Hauptseite

Du kannst wie auch schon bei externen Links den Linktext anpassen, indem du ihn mit einem "|" vom Namen abtrennst. 

[[Hauptseite|Zurück auf Los.]]

Zurück auf Los.

Hinweis.png Hinweis: Es ist auch möglich auf Seiten zu verweisen, die noch nicht erstellt wurden, dann wird der Link rot dargestellt. Achte deshalb immer darauf, dass die Links richtig geschrieben sind.


Referenzen (Quellenangaben)

Man kann auch mittels Referenzen verweisen, die dann zum Beispiel am Ende des Artikels aufgelistet werden. Referenzen werden mit 

<ref>http://www.MeinLink.irgendwo</ref>

gesetzt und mit 

<references/>

aufgelistet.

Aufzählungen

Eine weitere Form zum Strukturieren von Informationen ist die unnummerierte Auflistung. Einfach an den Zeilenanfang ein "*" setzen und der folgende Absatz ist dann ein Punkt in einer Aufzählung: 

* erster Punkt
* zweiter Punkt
* dritter Punkt
* letzer Punkt
  • erster Punkt
  • zweiter Punkt
  • dritter Punkt
  • letzer Punkt
Hinweis.png Hinweis: Bitte achtet darauf, das vor dem "*" kein Leerzeichen steht, sonst wird es keine Liste.



Nummerierte Aufzählungen bekommt man mit "#" anstelle des "*": 

# erster Punkt
# zweiter Punkt
# dritter Punkt
# letzer Punkt
  1. erster Punkt
  2. zweiter Punkt
  3. dritter Punkt
  4. letzer Punkt

Eine weitere Möglichkeit schaut so aus: 

; Beschreibung Nummer 1
: eingerückter Text
: weiterer Text
; Links
: ein Link
: ein zweiter Link
Beschreibung Nummer 1
eingerückter Text
weiterer Text
Links
ein Link
ein zweiter Link

Signatur

Beim Arbeiten in den Diskussionsseiten ist es sehr hilfreich, die einzelnen Punkte den Bearbeitern zuordnen zu können. Deshalb ist es gut, wenn man zu dem was man zu sagen hat, seine Signatur dazu gibt.

Deine Signatur kannst du mit ~~~ erzeugen, allerdings ist es meistens besser die ausführliche Signatur zu benutzen, die mit ~~~~ erzeugt wird. Diese ist zusätzlich mit einem Datum und der Zeit ausgestattet, so sieht man gleich, wann du etwas dazu beigetragen hast.

Vorlagen

Vorlagen sind kleine Textbausteine oder auch Miniskripte, die eingesetzt werden um oft wiederkehrende Textbausteine gleich zu halten. Wir haben hier einige Vorlagen bereits definiert, aber dazu später mehr.

Die Verwendung von Vorlagen ist recht simpel. Man beginnt mit zwei öffnenden geschweiften Klammern, dann kommt der Name der Vorlage gefolgt von einer Liste mit Parametern, die jeweils durch ein "|" getrennt sind. Abschließend kommen zwei schließende geschweifte Klammern. 

{{Hinweis|Das ist eine Vorlage.}}
Hinweis.png Hinweis: Das ist eine Vorlage.


Alle hier im Wiki definierten Vorlagen findest du unter Kategorie:Vorlage. In jeder Vorlage wird auch erklärt wofür sie ist und wie du sie benutzen kannst. Also welche Parameter du angeben musst.

Konventionen und anderes im Debianforum Wiki

Warnung.png Warnung: Dieser Teil stellt den wichtigsten Abschnitt dar um ein einheitliches Aussehen unseres Wiki zu gewährleisten. Bitte halte dich an unsere Konventionen.


Vorlagen

Wir haben bereits einige Vorlagen definiert. Bitte nutze diese, wann immer es geht und sinnvoll ist. Damit wird unser Wiki konsistenter und somit für jeden einfacher zu lesen. Welche Vorlagen es gibt, kannst du hier nachschlagen. Die Vorlagen können jederzeit betrachtet werden und enthalten jeweils eine kleine Erklärung was sie tun.

Die wichtigsten Vorlagen im Schnelldurchlauf:

Shell Kommandos

Willst du einen Befehl darstellen der in der Shell ausgeführt werden soll, dann kannst du dazu Vorlage:UserShell bzw. Vorlage:RootShell benutzen. Benötigst du die Pipe in dem Befehl, wird diese durch Vorlage:Pipe bereitgestellt. Analog das Gleichheitszeichen durch Vorlage:EqualSign. 

{{RootShell|ls -l / {{Pipe}} grep bin}}
root@debian:~# ls -l / | grep bin

{{UserShell|export EDITOR{{EqualSign}}vim}}
user@debian:~$ export EDITOR=vim


Auch ist es möglich mehrere Befehle in einer Vorlage einzubetten. 

{{UserShell|ps -A {{Pipe}} grep init|kill -9 1|echo "ByeBye"}}
user@debian:~$ ps -A | grep init
user@debian:~$ kill -9 1
user@debian:~$ echo "ByeBye"

Zur besseren Übersicht sollte man Zeilenumbrüche VOR dem Trenner einzufügen. 

{{UserShell|ps -A {{Pipe}} grep init
|kill -9 1
|echo "ByeBye"}}
user@debian:~$ ps -A | grep init
user@debian:~$ kill -9 1
user@debian:~$ echo "ByeBye"


Mit Hilfe von Zeilenumbrüchen kann man auch Programmausgaben simulieren. 

{{UserShell|bash --version
GNU bash, version 3.2.39(1)-release (i486-pc-linux-gnu)
Copyright (C) 2007 Free Software Foundation, Inc.}}
user@debian:~$ bash --version
GNU bash, version 3.2.39(1)-release (i486-pc-linux-gnu)
Copyright (C) 2007 Free Software Foundation, Inc.

Zusammenfassung

Nun kannst du gerne dein neues Wissen ausprobieren und ein wenig in unserem Sandkasten spielen.

Abgerufen von „https://wiki.debianforum.de/wiki/?title=Wiki-Tutorial&oldid=14998“