DE:Wiki syntax

From OpenStreetMap Wiki
Jump to navigation Jump to search

Wiki-Syntax

Eine Wiki-Seite zu editieren ist relativ einfach, es muss nur der Text eingetragen werden. Andererseits sollte man einige Konventionen einhalten und für die Formatierung sollte man einige Kenntnisse besitzen. Die Grundlagen der Konventionen und die meistbenutzten Formatierungen (Wiki-Markup) werden in diesen Artikel erläutert.

Wichtig
Benutze den Schalter „Vorschau zeigen“, um zu sehen, wie Dein Text und Deine Formatierung aussehen wird.
Benutze den Schalter so oft wie nötig, bevor Du Deine Änderung speicherst.
Ändere nur kleine Teile, also nur eine geringe Anzahl von Zeilen, eine Liste, Tabelle oder einen neuen Abschnitt.
Im Notfall kannst Du Deine Änderungen in der Versionsgeschichte der Seite zurücknehmen. Benutze dies aber nur, wenn es nötig ist.
Für Experimente verwendet man den Sandkasten des OSM-Wikis. Hier kann man ohne Gefahr alles ausprobieren, mit dem man noch nicht vertraut ist.



Bearbeitungsmethode

Fließtext
  • Ohne Formatierungen wird ein Text als Fließtext ausgegeben.
  • Ein Zeilenumbruch unterbricht den Fließtext nicht.
  • Für einen neuen Abschnitt füge eine leere Zeile ein.

Beispiel:

Text erscheint wie eingegeben, der Fließtext wird bei Zeilenumbrüchen nicht unterbrochen.

Wiki Text:

Text erscheint wie eingegeben,
der Fließtext wird bei
Zeilenumbrüchen nicht
unterbrochen.

Textformatierungen
  • Text zwischen je zwei Apostrophen (') wird kursiv angezeigt.
  • Text zwischen je drei Apostrophen (') wird fett angezeigt.
  • Text zwischen je fünf Apostrophen (') wird fett kursiv angezeigt.
  • Ein einzelnes Apostroph (') wird als Apostroph angezeigt.

Beispiel:

Heben Sie Ihren Text mit kursiv, fett or fett kursiv hervor.

Wiki Text:

Heben Sie Ihren Text mit ''kursiv'', '''fett''' or '''''fett kursiv''''' hervor.

Fortgeschrittene Formatierungen
  • Um einen Zeilenumbruch zu verhindern, benutze ein nicht trennbares Leerzeichen   wie zum Beispiel Nr. 1 Hit.
  • Ist ein Text in '<nowiki>' und '</nowiki>' eingeschlossen, wird darin enthaltene Wiki-Syntax nicht ausgewertet. Der Text erscheint so wie er ist auf der Wiki-Seite.
  • Wird ein Text mit '<!-- ', ' -->' eingeklammert, wird dieser Text nicht auf der Wiki-Seite angezeigt (ein Kommentar).

Beispiel:

Nr. 1 Hit


Verwenden sie .... wo notwendig.

Wiki Text:

'''Nr.&nbsp;1&nbsp;Hit'''

Verwenden sie ..<!--Kommentare-->.. wo notwendig.

Der erste oder die ersten paar Buchstabe(n) in einer Zeile bestimmen, in welche Weise die Zeile angezeigt wird.
  • Ein Leerzeichen ( ) als erster Buchstabe beginnt eine unformatierte Zeile, die besonders für Sourcecode Abschnitte empfohlen wird.
  • Ein Asterisk (*), eine Raute (#), ein Semikolon (;) oder ein Doppelpunkt (:) als erster Buchstabe markiert einen Listeneintrag. Mit mehreren solchen Zeichen kann man verschachtelte Listen erzeugen.
  • Eine Zeile, die mit '{|', '|-', '|+', '|', '!' oder '|}' beginnt, gehört zu einer Tabelle.
  • Eine Reihe von Gleichheitszeichen ('=') an Anfang und Ende der Zeile markieren eine Überschrift.
  • Eine Zeile mit einen Buchstaben oder einer Zahl an Anfang wird als Standardtext am Rand des Browser-Fensters umgebrochen.
  • Eine Zeile mit einer oder zwei eckigen Klammern ([) erzeugt einen Link, zwei geschweifte Klammern ({) beginnen eine Vorlage, die als Standardtext angezeigt wird. Link bzw. Vorlage können auch im Text verwendet werden, am Zeilenanfang haben sie keine besondere Bedeutung.
  • Bei allen weiteren noch nicht erwähnten Zeichen wird der Text normalerweise als Standardtext angezeigt.
   


Überschriften

Ein Abschnitt startet mit einer Überschrift, die aus einer Zeile besteht, die mit zwei oder mehr aufeinander folgende Gleichheitszeichen (=) beginnt und endet. Die Anzahl der Gleichheitszeichen zeigt die Verschachtelungstiefe der Überschriften an.

Werden verschiedene Abschnitte benutzt, wird ein Inhaltsverzeichnis vor der ersten Überschrift erzeugt. Dieser Artikel hat zum Beispiel mehr als fünf Abschnitte und besitzt deshalb ein Inhaltsverzeichnis.

Wenn man das Inhaltsverzeichnis an einen anderen Platz setzen will, kann man den Erscheinungsort mit __TOC__ festlegen. Alternativ kann man mit __NOTOC__ irgendwo im Dokument erzwingen, dass das Inhaltsverzeichnis nicht angezeigt wird.

Beispiel:

Überschrift 2

...

Überschrift 3

...

Überschrift 4

Wiki Text:

=== Überschrift 2 ===
...
==== Überschrift 3 ====
...
===== Überschrift 4 =====

Listen

Eine Liste erzeugt man, indem man vor allen Zeilen der Liste einen Stern (*) schreibt. Vor jeder Zeile wird dann ein Punkt angezeigt.

Wenn man anstatt des Sterns (*) den Gartenzaun (#) verwendet, wird eine geordnete Liste erzeugt. Statt des Punktes wird die Liste mit Zahlen angezeigt.

Man kann eine ineinander verschachtelte Liste durch die Erhöhung der Stern- bzw. Gartenzaun-Anzahl erzeugen. Die verschachtelte Liste wird durch unterschiedlich starke Einrückungen dargestellt. Bei verschachtelten Listen kann man Listen mit Punkten und mit Zahlen mischen.

Beispiel:

  • Eine Liste
    1. 2x eingerückt
    2. und Zahlen
  • wieder 1te Einrückung

Wiki Text:

* Eine Liste
*# 2x eingerückt
*# und Zahlen
* wieder 1te Einrückung

Bei einer Definitionsliste beginnt die Zeile mit einem Semikolon (;) gefolgt vom Definitionsbegriff, einem Doppelpunkt (:) und zum Schluss der Definitionstext. Dies wird in zwei Zeilen angezeigt: in der ersten steht der Definitionsbegriff (fett formatiert), in der zweiten der eingerückten Definitionstext.

Zur besseren Lesbarkeit kann man dies auch in zwei Zeilen im Wiki Text eintragen. Dann beginnt die zweite Zeile mit dem Doppelpunkt (:) und danach folgt der Definitionstext.

Obwohl es nicht vorgesehen war, kann man den Doppelpunkt (:) auch ohne den vorangehenden Definitionsbegriff verwenden. Der nachfolgende Text wird dann eingerückt. Wenn man mehrere Zeilen mit Doppelpunkt (:) verwendet, wird eine Liste ohne jegliche Markierung erzeugt. Dadurch ist es möglich, mehrere Abschnitte für die Begriffsdefinition zu verwenden. Wie bei den anderen Listen kann man mit mehreren Doppelpunkten (:) die Anzahl der Einrückungen erhöhen.

Beispiel:

Definitionsbegriff
Definitionstext
mit Fortsetzung

 

keine Definition
nur Text
2x eingerückt

Wiki Text:

 ; Definitionsbegriff
 : Definitionstext
 : mit Fortsetzung


 : keine Definition
 :: nur Text
 :: 2x eingerückt

Hinweis: Jede Zeile, die mit einem der Zeichen '*', '#', ';' oder ':' beginnt, ist ein Listenelement. Ein Listenelement wird durch einen Zeilenumbruch im Wiki Text beendet. Möchte man einen Zeilenumbruch in der Darstellung der Liste haben, trägt man im Wiki Text das Zeichen <br /> ein.

Beispiel:

  • Aufzählungspunkt

endet mit Zeilenumbruch

Wiki Text:

* Aufzählungspunkt
endet mit Zeilenumbruch

Links

Links innerhalb des gleichen Wiki sind einfach. Der Artikel-Name wird in doppelte eckige Klammern [[Wiki-Link]] gesetzt. Der Artikel-Name kann durch einen anderen Text ersetzt werden, indem man nach einem Pipe Zeichen (|) den Text schreibt, der als Link-Text erscheinen soll: [[Wiki-Link | anderer Text]]. Wenn eine bestimmte Sprachversion des Artikels erwünscht ist, wird die Sprache mit ihrem zweistelligen Sprachencode und einem Doppelpunkt (:) vorangestellt. Der Link [[de:Wiki-Link]] führt zur deutschen Fassung des Artikels "Wiki-Link".

Beispiel:

Wiki_Help
Wiki Help (englisch)
Wiki Hilfe (deutsch)

Wiki Text:

[[Wiki_Help]]
[[Wiki_Help | Wiki Help (englisch)]]
[[DE:Wiki_Help | Wiki Hilfe (deutsch)]]

Wenn man zu einem Artikel von Wikipedia verweisen will, schreibt man vor dem Artikelname den Prefix "wikipedia:", also z.B. [[wikipedia:article-name]]. Dieser Link führt zum englischen Wikipedia-Artikel (Standard-Wikipedia). Auch hier kann durch Voranstellen des zweistelligen Sprachencodes und eines Doppelpunktes (:) auf die entsprechende Sprachversion verwiesen werden (z.B. zur deutschen Wikipedia [[wikipedia:de:article-name]]).

Beispiel:

wikipedia:Main_Page
wikipedia:de:Main_Page

Wiki Text:

[[wikipedia:Main_Page]]
[[wikipedia:de:Main_Page]]

Externe Links sind genauso einfach. Trage einfach die Web-Adresse (URL) in den Text ein und es wird ein anklickbarer Link (mit der URL als Text) angezeigt. Wenn nur ein kurzer, durchnummerierter Link (z.B. [7]) angezeigt werden soll, klammert man den Link mit einfachen eckigen Klammern: [externer Link]. Alternativ kann man einen kurzen, erklärenden Link-Text hinter der URL angeben (getrennt mit einem Leerzeichen): [http://wiki.openstreetmap.org OSM-Wiki].

Bitte beachte, dass im Gegensatz zu internen Wiki-Links bei den externen Links ein Leerzeichen ( ) den Link vom Link-Text trennt. Alle externe Links werden durch ein Symbol gekennzeichnet, dass durch das zentrale Stylesheet für das Wiki erzeugt wird.

Beispiel:

http://wiki.openstreetmap.org
Ein kurzer Link [1]


Das OSM-Wiki

Wiki Text:

http://wiki.openstreetmap.org
Ein kurzer Link [http://wiki.openstreetmap.org]
Das [http://wiki.openstreetmap.org OSM-Wiki]

Sourcecode

Ein Leerzeichen ( ) als erster Buchstabe beginnt eine unformatierte Zeile, die mit einen Zeichensatz mit fester Breite und ohne Umbruch am Rand des Browser-Fensters angezeigt wird. Dies ist praktisch für eine kurze Liste von Punkten und wird häufig für Sourcecode Abschnitte verwendet.

Beispiel:


 Leerzeichen am Zeilenanfang 

Wiki Text:

   Leerzeichen am Zeilenanfang

Tabellen

Eine Tabelle ist eine zweidimensionale Matrix von Zeilen und Spalten, die es erlaubt, Information nach zwei Kriterien (eins in den Zeilen, eins in den Spalten) anzuordnen.

Eine Grundtabelle besteht aus folgenden Teilen:

  • Eine Zeile mit den Startzeichen '{|' kennzeichnet den Beginn einer Tabelle.
  • Eine optionale Zeile mit den Startzeichen '|+' kennzeichnet die Titelzeile der Tabelle.
  • Eine oder mehrere Tabellen-Zeilen, die mit den Startzeichen '|-' beginnen und normalerweise keinen weiteren Inhalt besitzen.
  • Nach jeder Tabellen-Zeile folgt eine oder mehrere Zeilen mit Tabellen-Zellen und deren Inhalt. Eine Tabellen-Zelle hat als erstes Zeichen eine Pipe (|) und das zweite Zeichen sollte weder das Pluszeichen (+) noch das Minuszeichen (-) sein, da diese für die Titelzeile bzw. für die Tabellen-Zeile reserviert sind (Empfehlung: Verwende ein Leerzeichen ( )).
  • Eine Zeile mit den Startzeichen '|}' kennzeichnet das Tabellenende.

Zur besseren Lesbarkeit sollte nach den Startzeichen immer ein Leerzeichen eingefügt werden.

Beispiel:

Überschrift
Dies ist eine
2 x 2 Tabelle

Wiki Text:

{| align="center"
|+ Überschrift
|- align="center"
| Dies
| ist eine
|- align="center"
| 2 x 2
| Tabelle
|}

Tabellen unterscheiden sich in einem Punkt wesentlich von Listen. Listen sind auf eine Zeile im Wiki Text beschränkt. Tabellen-Zellen können alles beinhalten, dass man mit der Wiki-Textsprache ausdrücken kann. Dies schließt Abschnitte, Listen, Bilder und andere Medien ein, aber auch Tabellen können in einer Tabellen-Zelle stecken.

Mit Tabellen kann man eine Menge trickreicher Sachen anstellen. Weitere Informationen kann man auf den Hilfeseiten von Wikipedia finden. Deutsch Englisch

Beispiel:

Dies ist ein Tabelle
in einer
anderen Tabelle!

Wiki Text:

{| border="1"
|- align="center"
| Dies ist eine Tabelle
{| align="center"
|- align="center"
| in einer
|} anderen Tabelle!
|}

Vorlagen (en: Templates)

Vorlagen sind Textmakros. Diese bestehen aus Texten in einem speziellen Namensraum (Template:). Vorlagen werden verwendet, wenn in verschiedenen Artikel identische Texte oder Textstrukturen gebraucht werden. Sie werden beim Öffnen des Artikels berechnet und in den Text des Artikels eingefügt. (Man kann dies bei Bedarf unterdrücken.) Für den Aufruf im Wiki-Text setzt man den Vorlagen-Namen zwischen doppelt geschweiften Klammern: {{Vorlagen-Name}}.

Vorlagen können Parameter besitzen. Diese werden durch ein Pipe-Zeichen (|) vom Vorlagen-Namen getrennt: {{Vorlagen-Name | Parameter}}. Bei mehreren unbenannten Parametern ist die Reihenfolge wichtig: {{Vorlagen-Name | Parameter-1 | | Parameter-3 }}, hier benötigt man einen leeren Parameter, wenn der zweite Parameter nicht angeben wird. Sind Parameter benannt, werden sie als Schlüssel-Wert Paare notiert: {{Vorlagen-name | param-X=value-X | param-F = value-F}}. Die Reihenfolge für benannte Parameter ist beim Aufruf egal. Für die bessere Lesbarkeit verwendet man am besten Leerzeichen. In der Vorlage kann ein Parameter einen Standardwert besitzen, wenn kein Wert beim Aufruf der Vorlage angegeben wurde.

Vorlagen können sehr unterschiedlich genutzt werden. Sie ermöglichen identische Texte und Formatierungen auf mehreren, verschiedenen Seiten und man kann damit z.B. Infoboxen (auch mit Parameter und anspruchsvollen Formatierungen) erzeugen. Eine Spezialseite des OSM-Wiki listet die am meisten genutzten Vorlagen auf.

Am Ende der Bearbeitungsseite eines Artikels findet man eine Auflistung aller benutzten Vorlagen. Wenn man diesen Links folgt, erhält man nähere Informationen zur entsprechenden Vorlage und man kann auch den Quelltext der Vorlage studieren.

Warnung: Erzeugen von neuen oder Ändern von existierenden Vorlagen ist nichts für einen Anfänger. Andererseits sollte ein Anfänger wissen, was es mit den komischen, doppelt geschweiften Klammern auf sich hat.

Beispiel:

Icon-Vorlagen für:
    Knoten oder Punkt Knoten
    Linienzug Weg
    geschlosser Linienzug geschlossener Weg
    Fläche oder Gebiet Fäche
    Relation Relation


Die Tag-Vorlage
    key=value
wird häufig genutzt.

Erzeuge Links für
Keep Right
(Hier Köln Zentrum)

Wiki Text:

Icon-Vorlagen für:
  {{Icon|node}} Knoten
  {{Icon|way}} Weg
  {{Icon|closedway}}
            geschlossener Weg
  {{Icon|area}} Fläche
  {{Icon|relation}} Relation

Die Tag-Vorlage
  {{Tag |key|value}}
wird häufig genutzt.

Erzeuge Links für
{{Keepright | lat=50.94 |
long=6.95 | zoom=16 }}
(Hier Köln Zentrum)

Häufig verwendete Vorlagen:

Für neue Seiten häufig eingesetzte Vorlagen sind z. B.:

Zudem können diese bei der Erstellung oder Bearbeitung von Seiten hilfreich sein:

Liste aller Vorlagen:

Links zu weiteren Informationen

  • Die OSM Hilfe-Seite liefert allgemeine Informationen zu diesem Wiki (keine direkte Hilfe zum Editieren/Textauszeichnung).
  • Allgemeine Hinweise zur Nutzung des Wiki-Editors gibt es bei Wikipedia unter Seite bearbeiten (keine direkte Hilfe zu Textauszeichnung).