Wiki-Syntax Teil 1: Einfache Textauszeichnungen
In JBerries wird eine Variation von Mediawiki verwendet, um Texte zu verfassen. Die wichtigsten Textauszeichnungen (und wie sie durch den Editor unterstützt werden) werden vorgestellt: Überschriften, Listen, Tabellen, Formatierungen von Fließtext und Zitate.
- Einführung
- Überschriften
- Syntax
- Heading 2
- Heading 3
- Heading 4
- Heading 5
- Heading 6
- Heading 2
- Heading 2
- Unterstützung durch den Editor
- Textformatierung
- Syntax
- Unterstützung durch den Editor
- Listen
- Numerierte Listen
- Ungeordnete Listen
- Definitionslisten
- Verschachtelte Listen
- Unterstützung durch den Editor
- Tabellen
- Unterstützung durch den Editor
- Absatz und Zeilenumbruch
- Zitate
- Sonderzeichen, Indizes und Potenzen
- Sonderzeichen
- Indizes und Potenzen
Einführung
Im ersten Teil werden die elementaren Textauszeichnungen Überschriften, Textformatierung (fett und kursiv), Listen und Tabellen behandelt. Weiter wird gezeigt, wie man Zeilenumbrüche und Absätze im Fließtext erzeugt und wie man Zitate einfügen kann, die abgesetzt dargestellt werden.
Überschriften
Syntax
Um Texte zu gliedern, können eigentlich sechs verschieden Ordnungen von Überschriften eingesetzt werden. Da aber für den Titel des Artikels die Überschrift erster Ordnung vorbehalten ist, verbleiben nur noch die Ordnungen 2 bis 6:
Wiki-Text:
== Heading 2 == === Heading 3 === ==== Heading 4 ==== ===== Heading 5 ===== ====== Heading 6 ======
Ergebnis:
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Achtung:
Nach dem abschliessenden =
darf kein Leerzeichen kommen, es muss ein Zeilenumbruch folgen.
Dagegen ist es unerheblich, ob zwischen den einschließenden =
und dem Text ein Leerzeichen steht oder nicht;
möglich sind also beide Varianten:
== Heading 2 == ==Heading 2==
Ergebnis:
Heading 2
Heading 2
Die Überschriften können innerhalb eines Artikels automatisch als Link angesprochen werden. Mehr dazu in Wiki-Syntax Teil 3; dort wird gezeigt, wie Links erzeugt werden.
Unterstützung durch den Editor
Für Überschriften 2. und 3. Ordnung sind im Editor Buttons vorgesehen. Dazu muss nur der Text der Überschrift mit der Maus markiert und der Button angeklickt werden.
Textformatierung
Syntax
Innerhalb von Fließtext können einzelne Passagen
- fett,
- kursiv oder
- fett und kursiv markiert werden.
Eingesetzt werden dazu die sogenannten Hochkommas.
Fetter Text (bold) wird mit
'''Fetter Text'''
erzeugt (jeweils drei Hochkommas).
Kursiver Text (italic) wird mit
''Kursiver Text''
erzeugt (jeweils zwei Hochkommas).
Der Text kann auch gleichzeitig fett und kursiv ausgegeben werden (jeweils fünf Hochkommas):
'''''fett und kursiv'''''
Unterstützung durch den Editor
Um Text-Passagen fett oder kursiv zu setzen, gibt es Buttons (die wieder nach Markierung des Textes geklickt werden). Um einen Text fett und kursiv zu setzten, müssen die beiden Buttons nacheinander geklickt werden.
Listen
Es gibt drei Arten von Listen:
- numerierte Listen (#)
- ungeordnete Listen (*)
- Definitionslisten (Kombination von ; für das zu definierende Wort und : für den definierenden Text)
Die Listen können dann auch ineinander verschachtelt werden.
Numerierte Listen
Die vorhergehende numerierte Liste wird mittels
# numerierte (oder geordnete) Listen (#) # ungeordnete Listen (*) # Definitionslisten (; und :)
erzeugt.
Untergeordnete Listen werden durch ##
(oder ###
in der nächsten Ordnung) dargestellt:
Wiki-Text:
# erste Ebene # immer noch erste Ebene ## erster Eintrag in der zweiten Ebene ## zweiter Eintrag in der zweiten Ebene ### dritte Ebene ### immer noch dritte Ebene # jetzt wieder erste Ebene.
Ergebnis:
- erste Ebene
- immer noch erste Ebene
- erster Eintrag in der zweiten Ebene
- zweiter Eintrag in der zweiten Ebene
- dritte Ebene
- immer noch dritte Ebene
- jetzt wieder erste Ebene.
Ungeordnete Listen
Alles, was oben über numerierte Listen gesagt wurde, gilt auch für ungeordnete Listen, nur mit *
statt #
:
Wiki-Text:
* erste Ebene * immer noch erste Ebene ** erster Eintrag in der zweiten Ebene ** zweiter Eintrag in der zweiten Ebene *** dritte Ebene *** immer noch dritte Ebene * jetzt wieder erste Ebene.
Ergebnis:
- erste Ebene
- immer noch erste Ebene
- erster Eintrag in der zweiten Ebene
- zweiter Eintrag in der zweiten Ebene
- dritte Ebene
- immer noch dritte Ebene
- jetzt wieder erste Ebene.
Achtung: Ein Zeilenumbruch markiert zugleich das Ende eines Listeneintrages - und kann zu unerwünschten Nebeneffekten führen (der zweite Eintrag der zweiten Ebene enthält einen Zeilenumbruch):
Wiki-Text:
* erste Ebene * immer noche erste Ebene ** erster Eintrag in der zweiten Ebene ** zweiter Eintrag in der zweiten Ebene *** dritte Ebene *** immer noch dritte Ebene * jetzt wieder erste Ebene.
Ergebnis:
- erste Ebene
- immer noche erste Ebene
- erster Eintrag in der zweiten Ebene
- zweiter Eintrag in der
zweiten Ebene
- dritte Ebene
- immer noch dritte Ebene
- jetzt wieder erste Ebene.
Definitionslisten
Definitionslisten bestehen aus dem zu definierenden Begriff, der automatisch fett gedruckt wird, und der Erläuterung des Begriffes:
Wiki-Text:
; Numerierte Liste : Die Listenelemente werden durchnumeriert ; Ungeordnete Liste : Die Listenelemente werden nicht numeriert ; Definitionsliste : besteht aus Begriff und Erläuterung
Ergebnis:
- Numerierte Liste
- Die Listenelemente werden durchnumeriert Ungeordnete Liste
- Die Listenelemente werden nicht numeriert Definitionsliste
- besteht aus Begriff und Erläuterung
Wichtig: Vor dem Doppelpunkt muss ein Leerzeichen stehen. Andernfalls wird der Doppelpunkt wie ein üblicher Doppelpunkt interpretiert.
Verschachtelte Listen
Listen - auch verschiedener Art - können ineinander verschachtelt werden. Das folgende Beispiel zeigt eine numerierte Liste, die ein ungeordnete Liste enthält; sie wird erzeugt mit:
# erster Eintrag # zweiter Eintrag #* erster untergeordneter, nicht numerierter Eintrag #* zweiter untergeordneter, nicht numerierter Eintrag # dritter Eintrag
Ergebnis:
- erster Eintrag
- zweiter Eintrag
- erster untergeordneter, nicht numerierter Eintrag
- zweiter untergeordneter, nicht numerierter Eintrag
- dritter Eintrag
Unterstützung durch den Editor
Bisher gibt es noch keine Unterstützung durch den Editor beim Erstellen von Listen.
Tabellen
Anfang und Ende einer Tabelle werden mit {|
und |}
markiert. Die Tabelle wird zeilenweise |-
eingegeben. Die Zelleninhalte werden mit |
gekennzeichnet:
Wiki-Text:
{| |- | erste Zeile, erste Spalte | erste Zeile, zweite Spalte |- | zweite Zeile, erste Spalte | zweite Zeile, zweite Spalte |}
Ergebnis:
erste Zeile, erste Spalte | erste Zeile, zweite Spalte |
zweite Zeile, erste Spalte | zweite Zeile, zweite Spalte |
Unterstützung durch den Editor
Bisher gibt es noch keine Unterstützung durch den Editor beim Erstellen von Tabellen.
Absatz und Zeilenumbruch
Im Fließtext gelten folgende Regeln:
- Eine Leerzeile im Wiki-Text erzeugt einen neuen Absatz.
- Mehrere aufeinanderfolgende Leerzeilen im Wiki-Text erzeugen wie eine einzelne Leerzeile einen neuen Absatz.
- Ein Zeilenumbruch im Wiki-Text bewirkt keinen Zeilenumbruch, sondern nur ein Leerzeichen; daher kann man (im Wiki-Text) im Absatz eines Fließtextes jeden Satz in einer neuen Zeile beginnen lassen.
Zitate
Zitate können erzeugt werden, indem der Text um ein (oder mehrere) Leerzeichen eingerückt wird.
Dieser letzte Absatz wird erzeugt durch:
'''Zitate''' können erzeugt werden, indem der Text um ein (oder mehrere) Leerzeichen eingerückt wird.
Zur leichteren Lesbarkeit des Wiki-Textes empfehlen sich etwa 4 Leerzeichen.
Dargestellt wid der als Zitat gekennzeichnete Text dann deutlich eingerückt.
Sonderzeichen, Indizes und Potenzen
Sonderzeichen
Manche HTML-Sonderzeichen können direkt eingegeben werden; sicherheitshalber sollten sie so eingegeben werden, wie es in der HTML-Zeichenreferenz vorgesehen ist. Zum Beispiel wird das kaufmännische UND (Ampersand-Zeichen) & durch
&
dargestellt; oder das Copyright-Zeichen © durch
©
Einen Sonderfall bilden die eckigen Klammern: [ . ].
Sie werden in der Wiki-Syntax verwendet, um Links zu bilden oder um Bilder einzubinden;
sie können daher nicht direkt eingegeben werden sondern nur über ihre Kodierung, die [
beziehungsweise ]
lautet.
Der folgende Satz:
Das Intervall [ 0; 2 π ] ist eine Periode der Sinusfunktion.
wird durch den folgenden Wiki-Text erzeugt:
Das Intervall [ 0; 2 π ] ist eine Periode der Sinusfunktion.
(hierbei wird auch die Kodierung π
für die Kreiszahl π verwendet).
Indizes und Potenzen
Indizes (tiefgestellte Zeichen) und Potenzen (hochgestellte Zeichen) können durch die Verwendung der HTML-Elemente
<sub>
und
<sup>
erzeugt werden.
So wird zum Beispiel
an = 2n
erzeugt durch den Wiki-Text:
a<sub>n</sub> = 2<sup>n</sup>