[[Vorlage(Überarbeitung, 21.03.2011, Wiki/Syntax, frustschieber )]] [[Inhaltsverzeichnis(2)]] 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 Hat man Javaskript erlaubt erhält man im Kopfbereich des Bearbeitungsfensters eine Symbolleiste mit folgenden Möglichkeiten: [[Bild(Baustelle/Wiki/Syntax/wiki_leiste.png)]] * [#Textformatierung Textformatierung] * [#berschriften Überschriften] verschiedener Ebenen * [#Textbausteine Textbausteine] * Textformat = Textformatierung = Es gibt drei mögliche Textformatierungen, die im Wiki klar definiert sind: ||Syntax||Ergebnis||Ausschließlich verwenden für|| ||``'''fett'''``||'''Fettschrift'''|| Dateinamen, Verzeichnisse, Paketnamen, Formatnamen|| ||``''"kursiv"''``||''"Kursivschrift"''|| Menüelement, Schaltflächen, G-Conf Schlüssel|| ||```Monotype```|| `Monotype`|| Befehle und ihre Optionen, Terminalausgaben im Fließtext, Modul, Benutzer, Gruppe|| 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 [[Vorlage(Tasten, enter+enter)]]. 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 == === Überschrift 3 === }}} = Inhaltsverzeichnis = Nach den einleitenden Blöcken getestet und Wissen kann ein Inhaltsverzeichnis eingefügt perwerden. Inyoka kann automatisch Inhaltsverzeichnisse generieren. Dazu werden die vorhandenen [#Uberschriften Überschriften]basierend auf den verwendeten Überschriften. Das Inhaltsverzeichnis wird durch folgendes Makro generiert: Trägt man am Anfang des Artikels noch vor den einleitenden Worten Folgendes ein {{{ [[Inhaltsverzeichnis]] }}} wird das Inhaltsverzeichnis aus den [#Uberschriften Überschriften] automatisch erstellt. Das Makro [[Inhaltsverzeichnis]] wird in Wikiartikeln unmittelbar vor den eigentlichen Text gesetzt, und somit also nach dem "getestet"- und Wissensblock. Schreibt man ``[[Inhaltsverzeichnis(1)]]`` werden nur die Überschriften der ersten Ebene berücksichtigt. Über einen Klick auf das '''`[-]`''' hinter einem Eintrag lassen sich Unterüberschriften ausblenden; '''`[+]`''' hinter einer Überschrift bedeutet, dass sich weitere vorhandene Unterebenen per Mausklick "ausklappen" lassen. = Tags = Die Tags stehen immer __am Ende__ des Artikel. Jeder Artikel sollte mindestens einen Tag besitzen, welcher ihn einer der hier genannten [:Kategorien:Kategorien] zuordnet. Alle Tags werden auch dazu benutzt, die [:Wiki/Tags:Wortwolke] zu generieren. = Links und Anker = Es gibt drei Arten von Verweisen (Links): intern ins Wiki, extern auf beliebige Webseiten und InterWiki-Links (Links auf Portale und andere Wikis): ##||<-4 rowclass="titel">'''Links'''|| ||'''Syntax'''||'''Icon'''||'''Beispiel'''||'''Beschreibung'''|| ||``[:Seitenname:]`` || || [:Wiki:] || Link auf die Wikiseiten „Wiki“ || ||``[:Seitenname:Alternativtext]``||[[Bild(wiki_link.png)]]||[:System:Alternativtext] || Link auf die Wikiseite "System" mit frei wählbarem Alternativtext.|| ||``[http://www.example.com]``||[[Bild(link.png)]]||[http://wiki.ubuntuusers.de]|| Link auf die Wikiseite von example.com|| ||``[http://www.example.com Homepage von Example]``||[[Bild(link.png)]]||[http://www.ubuntuusers.de Homepage uu.de]|| Link auf die Wikiseite von example.com, wobei anstelle des Links an sich der Text angezeigt wird.|| || ``[wikipedia:Artikelname:alternativer Text]`` || || [wikipedia:Ubuntu: Der link zu Ubuntu] || Link auf einen Wikiartikel in Wikipedia. Vollständige Übersicht: [:Wiki/InterWiki:]. || Der Alternativtext sollte so aussagekräftig sein, so dass auch beim Vorlesen des Textes klar wird, worum es geht. Daher sind Alternativtexte wie „hier“ oder „auf dieser Seite“ zu vermeiden. == 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 [:Wiki/Syntax/Flaggen:Liste aller Flaggen] sind: ##||<-3 rowclass="titel">'''Flaggen zum Kennzeichnen externen Links'''|| ||'''Flagge'''||'''Syntax'''||'''Sprache'''|| ||{de}||``{de}``||Deutsch|| ||{en}||``{en}``||Englisch|| Die Flaggen sind dabei hinter den Link zu setzen, also z.B. [http://kernel.org Linux Kernel] {en}. [[Bild(Wiki/Icons/Portal/anchor.png,, align=right)]] == Anker == Anker sind Hyperlinks innerhalb des Textes auf existierende Überschriften, wie am Anfang dieses Artikels verwendet. Die Syntax für Anker innerhalb des Artikels lautet: {{{ [#Überschrift Alternativtext] }}} bzw. für Links auf Anker auf anderen Seiten: {{{ [:Seitenname#Überschrift: Alternativtext] }}} Achtung: Umlaute wie in "Überschrift" werden nicht korrekt wiedergeben! = 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 1. Unterpunkt 2 Die Anzahl der vorangestellen Leerstellen bestimmt die Ebene (Staffelung) des Punktes. = Tabellen = Tabellen dienen der übersichtlichen Darstellung von Daten mit inhaltlichem Zusammenhang. {{{#!vorlage Tabelle Zelle 1 Zelle 2 Zelle 3 +++ <-3> Zelle über drei Spalten }}} Diese Tabelle wird mit diesem Code erzeugt: {{{ {{{#!vorlage Tabelle Zelle 1 Zelle 2 Zelle 3 +++ <-3> Zelle über drei Spalten \}}} }}} Eine ausführliche Darstellung zu den Möglichkeiten von Tabellen, z.B. Textausrichtung, Verbinden von Zellen usw findet sich unter [:Wiki/Syntax/Tabellen: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. ##Jede Code-Zeile die ''"+++"'' beinhaltet bewirkt eine neue Tabellenzeile, weshalb diese Zeichenfolge nicht in normalen Zellen verwendet werden kann. Zusätzliche Angaben, wie z.B. eine Zeilennummerierung, sind bei diesem Zeilentrenner möglich und können den Tabellencode noch lesbarer machen. = Bilder = {{{#!vorlage 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 [:Wiki/Bildschirmfotos: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 [#Bild-mit-Bildunterschrift Bildunterschrift] genutzt werden. Eine ausführliche Darstellung zu Bildern, u.a. auch Bilder mit Bildunterschriften, Anlegen einer Bildersammlung oder Fliesstext um die Bilder findet sich unter [:Wiki/Syntax/Bilder:Bilder] == Einfache Bilder == ##||<-2 rowclass="kopf" tablewidth="97%"> Danach kann das Bild mit folgender Syntax eingebunden werden:|| ||Syntax|| Ergebnis || || ``[[Bild(Bild.png)]]`` ||<80%> Fügt ein (auf der aktuellen Seite) hochgeladenes Bild ein. || || ``[[Bild(Seitenname/Bild.png)]]`` || Fügt ein auf der Seite "Seitenname" hochgeladenes Bild ein. || ##||<-2 rowclass="kopf" tablewidth="97%"> Als zweiten Parameter kann man die Breite und/oder Höhe definieren:|| ##||Syntax|| Ergebnis || || ``[[Bild(Bild.png, 200)]]`` || Skaliert das Bild auf 200 Pixel Breite|| ##Alternativ kann man auch die Schaltfläche ''"Bild"'' [[Bild(inyoka_bild.png)]] genutzt werden, um den entsprechenden Syntax einzufügen. Der Positionsparameter muss auf Englisch ##angegeben werden. == Externe Bilder == {{{#!vorlage Warnung Im Wiki sind keine externen Bilder erwünscht! Bilder sind hier zu speichern, wenn man sie in einem Artikel verwenden will. Nur so kann eine dauerhafte Erreichbarkeit sichergestellt werden. Dabei ist unbedingt das Urheberrecht zu beachten! Eine Ausnahme stellt lediglich das Einbinden von Bildern der Domain ubuntuusers.de da, wie z.B. Teile des hier verwendeten Designs (zur Dokumentation). }}} = Code einfügen = Möchte man den Code mit Syntaxhervorhebung formatieren - was die Lesbarkeit deutlich erhöht, so nutzt man folgende Syntax: ``{{{#!code sprache }}}`` `sprache` muss dabei durch die entsprechende (unterstützte) Sprache ersetzt werden, wobei auf Kleinschreibung zu achten ist! Ein Python Beispiel wird dann so dargestellt: {{{#!code python #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. ##||<-2 rowclass="kopf" tablewidth="97%"> Danach kann der Anhang mit folgender Syntax eingebunden werden:|| ||Syntax|| Ergebnis || || ``[[Anhang(Anhang, Beschreibung)]]`` ||<80%> Fügt einen (auf der aktuellen Seite) hochgeladenen Anhang ein. || || ``[[Anhang(Seitenname/Anhang, Beschreibung)]]`` || Fügt einen auf der Seite "Seitenname" hochgeladenen Anhang ein. || || ``[[Anhang(Anhang, Beschreibung)]]`` ||<80%> 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. __Wichtig__ ist die Leerstelle zwischen `Vorlage,` und `TASTE` ! Ein paar Beispiele: {{{ [[Vorlage(Tasten, a)]] [[Vorlage(Tasten, enter)]] [[Vorlage(Tasten, ctrl+a)]] }}} [[Vorlage(Tasten, a)]] , [[Vorlage(Tasten, enter)]] , [[Vorlage(Tasten, ctrl+a)]] Eine vollständige Übersicht über alle möglichen darstellbaren Tasten erhält man unter [:Wiki/Syntax/Tasten:Tasten]. = Links = * Die allgemeine Benutzung des Wikis außerhalb des Editierens an sich findet man auf der Seite [:Wiki/Benutzung:Benutzung]. * Eine vollständige Übersicht über alle Makros und Vorlagen findet man in [:Wiki/Textbausteine:]. * Eine ausführliche Einführung in die Benutzung des Forums findet man unter [:Forum/Syntax:]. * Eine komplette Übersicht findet man auf der Seite [:Wiki/Syntax-Übersicht:Syntax-Übersicht]. * Wer noch die Beschreibung der alten Tabellensyntax benötigt, findet diese in der [http://wiki.ubuntuusers.de/Wiki/Syntax/Tabellen?rev=198214 Artikelrevision 198214]. ## * [:Wiki/Syntax: Wiki-Syntax] * [:Wiki/Referenz: Wiki-Referenz] * [http://de.selfhtml.org/css/ Selfhtml zu CSS] {de} * [http://www.css4you.de/ CSS 4 You] {de} # tag: Wiki, Syntax