Syntax
Artikel wird überarbeitet
Dieser Artikel wird momentan überarbeitet.
Geplante Fertigstellung: 21.03.2011
Derzeitig gültiger Artikel: Wiki/Syntax
Bearbeiter: frustschieber
Solltest du dir nicht sicher sein, ob an dieser Anleitung noch gearbeitet wird, kontrolliere das Datum der letzten Änderung und entscheide, wie du weiter vorgehst.
Achtung: Insbesondere heißt das, dass dieser Artikel noch nicht fertig ist und dass wichtige Teile fehlen oder sogar falsch sein können. Bitte diesen Artikel nicht als Anleitung für Problemlösungen benutzen!
Diese Seite gibt einen Überblick über die wichtigsten Formatierungen von Artikeln für das Wiki von ubuntuusers.de.
Allgemein gilt:
Versuche möglichst kurze, eindeutige Sätze zu schreiben. Die Aussagen sollen Anderen helfen und klar verständlich sein. Umschreibungen verwirren oft den eigentlichen Sinn eines Artikels.
Ein Artikel behandelt ein Thema
Über die gewünschten Struktur und die Elemente eines guten Wiki-Beitrags erfährt man alles im Artikel Wiki-Referenz
Hat man JavaScript aktiviert, sieht man im Kopfbereich des Bearbeitungsfensters diese Symbolleiste mit folgenden Möglichkeiten:
Sie soll das Einfügen der verschiedenen Formatierungen beim Erstellen der Seite erleichtern:
Überschriften verschiedener Ebenen
Textformat
Textformatierung¶
Es gibt drei mögliche Textformatierungen, die im Wiki klar definiert sind:
Textformatierung | |||
Syntax | Schaltfläche | Ergebnis | Ausschließlich verwenden für |
'''fett''' | Fettschrift | Dateinamen, Verzeichnisse, Paketnamen, Formatnamen | |
''"kursiv"'' | "Kursivschrift" | Menüelemente, Schaltflächen, G-Conf-Schlüssel, immer in Anführungszeichen! | |
`Monotype || [[Bild (./monotype.png)]] || Monotype || Befehle und ihre Optionen, Terminalausgaben im Fließtext, Module, Benutzer, Gruppen || |
Auch wenn Programme oft den gleichen Namen wie ein Paket haben, so werden sie im Fließtext unformatiert gelassen. Beispiel:
Man kopiert die Datei foo.conf ins Verzeichnis /etc/conf_files. Um das Programm Foobar zu starten, wählt man den Menüpunkt "Anwendungen → Tools → Foobar". Die Meldung zu Beginn bestätigt man mit "OK". Möchte man eine detaillierte Ausgabe, so sollte man unbedingt beim Start die Option --verbose
übergeben.
Zeilenumbrüche¶
Um einen Absatz einzufügen fügt man einen doppelten Zeilenumbruch ein, also ⏎ + ⏎ . Einfache Zeilenumbrüche werden von Inyoka nicht berücksichtigt!
Textbausteine¶
Für viele häufige Formatierungen, z.B. Getestet- und Wissensblock, sind bereits Textbausteine vorhanden, die man einfach einkopieren kann.
Eine Auflistung aller Möglichkeiten findet sich unter Wiki/Textbausteine
Überschriften¶
Um Wikiartikel zu strukturieren und lesbarer zu gestalten sollten, wie auch in diesem Artikel, Überschriften verwendet werden. Die Syntax lautet:
= Überschrift 1 = == Überschrift 2 == entspricht der 2.Ebene === Überschrift 3 === entspricht der 3.Ebene/Stufe
Überschriften dürfen keinen Doppelpunkt beinhalten (siehe Anker)! Weiterhin ist in Überschriften keinerlei Formatierung erlaubt, also z.B. keine Fettschrift, keine Links etc.
Inhaltsverzeichnis¶
Trägt man am Anfang des Artikels noch vor den einleitenden Worten Folgendes ein
[[Inhaltsverzeichnis()]]
wird automatisch ein Inhaltsverzeichnis aus den Überschriften generiert. Das Makro [[Inhaltsverzeichnis()]]
wird in Wikiartikeln unmittelbar vor den eigentlichen Text gesetzt, und somit also nach dem "Getestet-" und "Wissensblock". In der Klammer kann eine Zahl angegeben werden, bis zu welcher Überschriftenebenen das Inhaltsverzeichbis dargestellt werden soll.
Ist Javaskript aktiviert, werden alle Überschriften berücksichtigt und das Inhaltsverzeichnis kann durch einen -Klick auf das [+]
expandiert werden.
Siehe auch: Wiki/Textbausteine (Abschnitt „Inhaltsverzeichnis“)
Tags¶
Diese "Tags" stehen immer am Ende des Artikel.
Jeder Artikel muss mindestens einen Tag besitzen, um dadurch einer der hier genannten Kategorien zugeordnet zu sein. Die Tag-Liste besteht aus einer "#", dem Schlüsselwort "tags:" und einer kommaseparierten Liste aus den Kategorien. Beispiel:
#tag: Server, Netzwerk
Das Fähnchen in Seitensprache ist bei externen Links Pflicht! Siehe auch: Kennzeichnung externe Links
Erst durch dieses tagging (engl. mit einem Etikett versehen), ist die Wortwolke generierbar. Als Hauptzweck erfolgt dadurch die Ordnung im Wiki, auch Hierarchierung genannt.
Links und Anker¶
Generell sollte immer ein Alternativtext angegeben werden, der so aussagekräftig ist, so dass auch beim Vorlesen des Textes klar wird, worum es geht. Daher sind Alternativtexte wie „hier“ oder „auf dieser Seite“ zu vermeiden.
Es gibt drei Arten von Verweisen (Links): intern ins Wiki (Schaltfläche ), extern auf beliebige Webseiten (Schaltfläche ) und InterWiki-Links (Links auf Portale und andere Wikis):
Links & Anker | |||
Syntax | Beispiel | Ergebnis | Beschreibung |
[:Seitenname:Alternativtext] | [:System:Alternativtext] | Alternativtext | Link auf die Wikiseite „System“ mit frei wählbarem Alternativtext. |
[:Seitenname#Überschrift:] | [:System#Optimierung:] | System (Abschnitt „Optimierung“) | Link auf die Wikiseite „System“ und darin auf die Überschrift (= Anker) „Optimierung“ |
[Internetadresse Alternativtext] | [http://www.ubuntu.com Homepage von Ubuntu] {en} | Homepage von Ubuntu 🇬🇧 | Link auf die Seite ubuntu.com, wobei der Alternativtext „Homepage von Ubuntu” angezeigt wird. |
[wikipedia:Artikelname:Alternativtext] | [wikipedia:Ubuntu: Der link zu Ubuntu] | Der link zu Ubuntu | Link auf einen Wikiartikel in Wikipedia. Vollständige Übersicht: Wiki/InterWiki. |
[Anker Alternativtext] | [#berschriften Überschriften] | Überschriften | Link auf eine Überschrift innerhalb eines Artikels (hier zum Abschnitt „Überschriften”). |
Kennzeichnung externer Links¶
Externe Links werden im Wiki zusätzlich mit einer Flagge gekennzeichnet, damit der Leser direkt die Sprache der verlinkten Seite sehen kann. Flaggen werden durch einfache geschweifte Klammer gekennzeichnet, welche das Kürzel (zwei Buchstaben) des Landes einschließen.
Die am häufigsten genutzten Flaggen aus der Liste aller Flaggen sind:
Externe Links | ||
Flagge | Syntax | Sprache |
🇩🇪 | {de} | Deutsch |
🇬🇧 | {en} | Englisch |
🇫🇷 | {fr} | Französisch |
Die Flaggen sind dabei hinter den Link zu setzen, also z.B. Linux Kernel 🇬🇧.
Listen¶
Listen können verschiedene Ebenen haben und auch beliebig verschachtelt werden. Wichtig ist, dass mindestens ein Leerzeichen vor und nach jedem Listenelement stehen muss.
␣*␣ Punkt 1 ␣*␣ Punkt 2 1. Unterpunkt 1 1. Unterpunkt 2
Das sieht dann so aus:
Punkt 1
Punkt 2
Unterpunkt 1
Unterpunkt 2
Die Anzahl der vorangestellten Leerstellen bestimmt die Ebene (Staffelung) des Punktes.
Tabellen¶
Tabellen dienen der übersichtlichen Darstellung von Daten mit inhaltlichem Zusammenhang.
Zelle über drei Spalten | ||
Beschreibung 1 | Beschreibung 2 | Beschreibung 3 |
Zelle 1 | Zelle 2 | Zelle 3 |
Diese Tabelle wird mit diesem Code erzeugt:
{{{#!vorlage Tabelle <rowclass="kopf"-3> Zelle über drei Spalten +++ <rowclass="kopf"> Beschreibung 1 Beschreibung 2 Beschreibung 3 +++ Zelle 1 Zelle 2 Zelle 3 }}}
Eine ausführliche Darstellung zu den Möglichkeiten von Tabellen, z.B. Textausrichtung, frablich vordefinierte Zeilen, Verbinden von Zellen usw. findet sich unter Tabellen
Prinzip¶
Eine Tabelle wird durch folgendes Grundgerüst erstellt:
{{{#!vorlage Tabelle 1. Zeile/1.Spalte 1. Zeile/2.Spalte 1. Zeile/3.Spalte +++ Es folgt Zeile 2 2. Zeile/1.Spalte 2. Zeile/2.Spalte 2. Zeile/3.Spalte }}}
Jeder Zeilenumbruch stellt eine Spalte in einer Tabellenzeile dar. Weitere Zeilen werden durch drei "+"-Zeichen, gefolgt von einem Zeilenumbruch hinzugefügt. Zusätzliche Angaben, wie z.B. eine Zeilennummerierung, sind bei diesem Zeilentrenner möglich und können zur besseren Übersichtlichkeit beitragen.
Bilder¶
Hinweis:
Bilder, welche in den Wiki-Artikel eingefügt werden sollen, sollten eine Größe von max. 150 kB haben. Außerdem darf die Breite 600 Pixel nicht überschreiten.
Um ein Bild zu verkleinern, empfiehlt es sich, das Bild auf eine indizierte Farbpalette mit 64 oder 256 Farben umzustellen, weitere Informationen findet man im Artikel Bildschirmfotos.
Das bevorzugte Dateiformat ist PNG, JPG-Bilder funktionieren aber auch.
Um ein Bild in den Text einzufügen, muss zuerst einmal eine Datei auf einer Seite hochgeladen werden. Dazu auf der jeweiligen Wiki-Seite den Punkt "Weitere Aktionen → Dateianhänge verwalten" wählen. Danach gibt es verschiedene Möglichkeiten, das Bild einzubinden. Normalerweise sollte das Bild als "einfaches Bild" eingebunden werden. Nur wenn es etwas Wichtiges zu erläutern gibt, soll eine Bildunterschrift genutzt werden.
Eine ausführliche Darstellung zu Bildern, u.a. auch Bilder mit Bildunterschriften, Anlegen einer Bildersammlung oder Fließtext um die Bilder findet sich unter Bilder
Einfache Bilder¶
Bilder | |
Syntax | Ergebnis |
[[Bild(Bild.png)]] | Fügt ein (auf der aktuellen Seite) hochgeladenes Bild ein. |
[[Bild(Seitenname/Bild.png)]] | Fügt ein auf der Seite "Seitenname" hochgeladenes Bild ein. |
[[Bild(Bild.png, 200)]] | Skaliert das Bild auf 200 Pixel Breite |
Code einfügen¶
Für Terminalausgaben, Auszüge aus Konfigurationsdateien können in einem einfachen Codeblock eingefasst werden:
{{{ Terminalausgabe }}}
Möchte man den Code mit Syntaxhervorhebung formatieren - was die Lesbarkeit deutlich erhöht, so nutzt man folgende Syntax:
{{{#!code sprache Text }}}
sprache
muss dabei durch die entsprechende (unterstützte) Sprache ersetzt werden, wobei auf Kleinschreibung zu achten ist! Nach Markieren des Textes kann über die Schaltfläche Codeblock die gewünschte Sprache ausgewählt werden. Ein Python-Beispiel würde dann so dargestellt:
1 2 | #mein Hallo-Welt-Programm in Python print 'Hallo Welt!' |
Anhänge¶
Um einen Anhang in den Text einzufügen, muss zuerst einmal eine Datei (Deb-Pakete sind nicht als Anhang erlaubt!) auf einer Seite hochgeladen werden. Dazu auf der jeweiligen Wiki-Seite den Punkt "Weitere Aktionen → Dateianhänge verwalten" wählen.
Anhänge | |
Syntax | Ergebnis |
[[Anhang(Anhang)]] | Fügt einen (auf der aktuellen Seite) hochgeladenen Anhang ein. |
[[Anhang(Seitenname/Anhang)]] | Fügt einen auf der Seite "Seitenname" hochgeladenen Anhang ein. |
[[Anhang(Anhang, Beschreibung)]] | Fügt einen (auf der aktuellen Seite) hochgeladenen Anhang mit der Beschreibung ein. |
[[Anhang(Seitenname/Anhang, Beschreibung)]] | Fügt einen auf der Seite "Seitenname" hochgeladenen Anhang mit der Beschreibung ein. |
Tasten¶
Die allgemeine Syntax ist:
[[Vorlage(Tasten, TASTE)]]
wobei TASTE
durch die entsprechende Taste ersetzt werden muss. Ein paar Beispiele:
[[Vorlage(Tasten, a)]] [[Vorlage(Tasten, enter)]] [[Vorlage(Tasten, ctrl+a)]]
A , ⏎ , Strg + A
Eine vollständige Übersicht über alle möglichen darstellbaren Tasten erhält man unter Tasten.
Links¶
Wiki - Übersicht
Benutzung - Die allgemeine Benutzung des Wikis außerhalb des Editierens
Wiki-Referenz - Sprache (Ausdruck), Anspruch und Regeln für einen Artikel
Wiki/Textbausteine - Eine vollständige Übersicht über alle Makros und Vorlagen
Syntax-Übersicht - Eine komplette Übersicht aller Syntaxelemente
Forum/Syntax - Eine ausführliche Einführung in die Benutzung des Forums