ubuntuusers.de

Du betrachtest eine alte Revision dieser Wikiseite.

Syntax

Sie soll das Einfügen der verschiedenen Formatierungen beim Erstellen der Seite erleichtern:

Textformatierung

Es gibt fünf mögliche Textformatierungen, die im Wiki klar definiert sind, und immer für die vorgesehenen Zwecke verwenden werden:

Textformatierung
Syntax Schaltfläche Ergebnis Ausschließlich verwenden für
'''fett''' ./fett.png Fettschrift Dateinamen, Verzeichnisse, Paketnamen, Formatnamen
''"kursiv"'' ./kursiv.png "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 || || unterstrichen_ || || __unterstrichen__ || Hervorheben von einzelnen Wörtern im Text. Bitte unbedingt __sparsam__ verwenden! || || GROSSBUCHSTABEN || || || Variablen innerhalb von Befehlen oder Konfigurationsdateien ||

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. Als Variable kann zusätzlich ein Dateiname angegeben werden:
foobar DATEINAME -verbose 

Farbiger Text oder farblich hervorgehobener Text ist im Wiki grundsätzlich nicht erlaubt.

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 kopieren und einfügen 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 Überschriftenebene das Inhaltsverzeichnis dargestellt werden soll.

Ist JavaScript aktiviert, werden alle Überschriften berücksichtigt und das Inhaltsverzeichnis kann durch einen linke Maustaste-Klick auf das [+] expandiert werden.

Siehe auch: Wiki/Textbausteine (Abschnitt „Inhaltsverzeichnis“)

Tags

Schlagworte oder "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 "tag:" und einer kommaseparierten Liste aus den Kategorien. Beispiel:

#tag: Server, Netzwerk

Erst durch dieses tagging (engl. mit einem Etikett versehen) ist die Erstellung einer Wortwolke möglich. Als Hauptzweck steht die Ordnung im Wiki im Vordergrund.

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):

  1. intern ins Wiki (Schaltfläche ./wiki_link.png)

  2. extern auf beliebige Webseiten (Schaltfläche link.png)

  3. 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“. Bitte Hinweis unter der Tabelle beachten.
[#Anker Alternativtext] [#berschriften Überschriften] Überschriften Link auf eine Überschrift innerhalb eines Artikels (hier zum Abschnitt „Überschriften”). Bitte Hinweis unter der Tabelle beachten.
[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.
[WikiName:Artikelname: Titel der Seite] [wikipedia:Ubuntu: Der link zu Ubuntu] Der link zu Ubuntu Link auf einen Wikiartikel in Wikipedia. Vollständige Übersicht: Wiki/InterWiki.

Achtung: Da manche Zeichen in den Links der Überschriften nicht dargestellt werden, ist der korrekte Link über das Symbol „./anker.png“ zu ermitteln, welches erscheint, wenn man mit der Maus auf eine Überschrift geht. Überschriften, die einen Doppelpunkt enthalten, können gar nicht verlinkt werden, daher dürfen diese in Überschriften nicht verwendet werden!

Externe Links werden im Wiki zusätzlich mit einer Flagge gekennzeichnet, damit der Leser direkt die Sprache der verlinkten Seite sehen kann und außerdem deutlich wird, dass der Link aus ubuntuusers.de herausführt. Ausnahmen sind z.B. Wikipedia-Links wie Ubuntu oder Ubuntu. 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

    1. Unterpunkt 1

    2. 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="titel"-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, farblich 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. Dieser Zeilentrenner kann für zusätzliche Hinweise, z.B. eine Zeilennummerierung, genutzt werden um eine bessere Übersichtlichkeit zu erreichen.

Bilder

Hinweis:

Bilder, welche in den Wiki-Artikel eingefügt werden, dürfen die max. Werte von 150 kB Größe und 600 Pixel Breite 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.png 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.

  • 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

Diese Revision wurde am 22. Dezember 2011 19:27 von Heinrich_Schwietering erstellt.
Die folgenden Schlagworte wurden dem Artikel zugewiesen: Syntax, Wiki, Inyoka, Einsteiger