Aus Ubuntu-Forum Wiki

1 Allgemeines

Dieser Artikel soll Fragen, die beim Verfassen zum Formatieren von Wiki-Artikeln auftreten, beantworten. Ein optisch gut aufbereiteter Artikel fördert dessen Verständlichkeit und macht beim Lesen und Schreiben einfach mehr Spaß.

Um die Übersichtlichkeit zu wahren, werden nur die wichtigsten Formatierungen erwähnt. Am Ende des Artikels wird auf weiterführende Seite verwiesen.

2 Links darstellen

2.1 Interne Links

Verweise auf eine Wiki-Seite

• [[name]] » Name muss einer Seite des Wikis genau entsprechen
• [[name#abschnitt]] » Verweis auf einen Abschnitt (eine Überschrift) einer Seite

Umleitung auf eine Wiki-Seite

Man kann auch eine Seite direkt auf eine andere Seite oder einen Abschnitt in dieser umleiten lassen. Das macht zum Beispiel Sinn, wenn verschiedene Namen eines Artikels möglich sind oder ein Thema zwar eine eigene rechtfertigen würde, es aber schon hinreichend im Kontext eines anderen erklärt wurde. Dazu muss dann nur eine neue Seite erstellt werden, die nur den folgenden Inhalt hat:

• Umleitung auf eine Seite

#REDIRECT [[name]]

• Umleitung auf einen Unterpunkt

#REDIRECT [[name#abschnitt]]

2.2 Externe Links

• Eingabe des kompletten URL » wird genauso wiedergegeben
• [URL name_des_links] » Name des Links wird angezeigt

2.3 Grafiken

Auch Grafiken werden als Verweis gehandhabt. Dazu muss eine Grafik zunächst hochgeladen oder aus den schon vorhandenen ausgewählt werden. Dann kann sie mit dem Syntax [[Bild:name_des_bildes]] in den Artikel eingebunden werden.

2.3.1 Versionsangaben

Nicht ganz unwichtig ist die Ubuntu-Version, für die ein Beitrag geschrieben wurde. Daher sollten entsprechende Icons an den Beginn, noch vor dem Inhaltsverzeichnis, gesetzt werden:

Bitte immer mit der aktuellsten Version beginnen, also 10.10, 10.04, 9.10...

Syntax der Icons

» [[Bild:1004.png]] (Lucid Lynx)

3 Schriftgestaltung

Um Code oder Befehle zu kennzeichnen, genügt es, die betreffende(n) Zeile(n) mit einem Leerzeichen zu beginnen:

sudo apt-get update

Wenn ein bestimmter Text nicht als Wiki-Code interpretiert werden soll, so muss er in folgende Tags gesetzt werden: <nowiki>unformatierter Text</nowiki>

4 Gliederung

4.1 Überschriften

Überschriften werden durch ='-Zeichen eingeschlossen und gekennzeichnet. Dabei muss jeweils die gleiche Anzahl am Anfang und am Ende der Überschrift stehen. Ihre Anzahl gibt die Gliederungsebene an:

* Überschriften erster Ebene werden nicht verwendet, da sie der Artikelüberschrift vorbehalten sind. Absätze bzw. eine neue Zeile wird mit einer Leerzeile im Text erreicht.

Dadurch soll die eine bessere Abgrenzung zur Artikel-Titel erreicht werden. Außerdem gibt der Editor der Wiki-Software diese Ebene auch als Anfangswert vor.

4.2 Aufzählungen und Einrückungen

5 Vorlagen

5.1 Format-Vorlagen

Format-Vorlagen werden dazu verwendet, um bestimmte Textstellen besonders hervorzuheben. Dies geschieht wiki-weit. Es muss also nur eine Datei verändert werden, um sämtliche Textstellen neu zu gestalten.

Beispiel

Soll nun das Aussehen aller Hinweise geändert werden, muss nur die entsprechende Vorlage dafür angepasst werden. Das vermindert den Aufwand bei einer Design-Umstellung oder -Änderung erheblich, da nicht jeder Hinweis einzeln auf jeder Seite angepasst werden muss. Die Vorlage selber besteht aus CSS-Code, der die Formatierung des Textes beschreibt.

Um eine Vorlage nutzen zu können, muss nur der folgende Code in den Artikel eingefügt werden. Dann muss der Name der Vorlage (ohne de Präfix Vorlage:)eingetragen und der Text an die Stelle des Mustertextes gesetzt werden.

{| {{Name}}
| Mustertext
|}

Dabei ist wichtig, dass die erste und letzte Zeile nur die angegebenen Inhalte haben - sie dienen als Anfangs- und Endmarkierung. Der auszugebende Text kann dabei auch mehrere Zeilen umfasse.

Der Code für einen Hinweis würde dementsprechend folgendermaßen aussehen:

{| {{Hinweis}}
| Darstellung aller Hinweise
|}

• Vorlagen » häufig verwendete Vorlagen im Wiki

6 Syntaxhervorhebungen

Viele Artikel beinhalten Auszüge von Quellcode, manche auch ganze Programme. Um die Übersichtlichkeit und Lesbarkeit dieser Artikel zu steigern, kann man die Schlüsselworte des jeweiligen Codes farbig hervorheben. Das kann dieses Wiki automatisch mit Hilfe einer Erweiterung vornehmen.

Dazu muss man lediglich folgendes im Quellcode hinzufügen:

Syntax

<source lang="php">
<?php
  echo 'Nice Job, Developers!';
?>
</source>

Hinter den Parameter lang="xxx" kann man noch den Parameter line setzen. Damit schaltet man die Zeilennummerierung für den Quellcode ein.

Anzeige

<?php
  echo 'Nice Job, Developers!';
?>

• GeSHi-Erweiterung für Syntaxhervorhebung weiterführender Artikel

7 Tipp

Da man sich immer den Quellcode einer Seite ansehen kann, kann man sich so auch den dort verwendeten Code zu Nutze machen.

8 Links

Intern

• Formatierung » Wiki-Texte formatieren
• Formatierung/Tabellen » Wiki-Tabellen erstellen

Extern

• Mediawiki-Handbuch » Kapitel zur Formatierung