XWiki Syntax 2.1

Allgemeines

Einführung

2.1 Introduction

Die XWiki Syntax 2.1 ist die aktuell empfohlene Wiki Syntax. Gegenüber der XWiki Syntax 2.0 wurden einige Verbesserungen eingeführt. Einige Gründe für die Entwicklung dieser neuen Syntax sind:

• Die Link- und Bildsyntax wurde für bessere Klarheit, Konsistenz und Erweiterbarkeit vereinheitlicht.
• Möglichkeit zum Anzeigen von Piktogrammen, zum Einbetten von Bildern mittels 'data:'-URLs sowie zum Verlinken von Dateien mittels der UNC Notation und dem Verlinken zu relativen URLs wurden hinzugefügt.

Zusätzlich zu den XWiki-spezifischen Syntaxen haben wir auch unsere zugrunde liegende Rendering-Engine (war vormals Radeox) durch unsere eigene Engine ausgetauscht, welche eine Obermengenhülle um Wikimodel und Doxia (und möglicherweise weiteren in der Zukunft) bildet. Dies hat es uns erlaubt weitere Syntaxen im Wiki anzubieten: MediaWiki, Confluence, JSPWiki, Creole, TWiki und mehr.

Bemerkungen

2.0 General Remarks

XWiki Syntax 2.0 korrigiert einige Fehler oder mehrdeutige Syntax, die vom Nutzer eingegeben wird, wie in den Beispielen in der Tabelle unterhalb gezeigt.

Weitere Syntaxen

1.0 Other Syntaxes

Die folgenden weiteren Syntaxen sind in XWiki Enterprise 1.6 und später implementiert:

• JSPWiki
• MediaWiki
• Confluence
• TWiki
• Creole 1.0
• XHTML 1.0

Bearbeiten

Absatz

2.0 Paragraphs

Absätze sind Textelemente, die durch zwei oder mehr neue Zeilen getrennt sind.

Überschriften

2.0 Headings

= Ebene 1 = 
== Ebene 2 ==
=== Ebene 3 ===
==== Ebene 4 ====
===== Ebene 5 =====
====== Ebene 6 ======

Textformatierung

2.0 Text Formatting

Horizontale Linie

2.0 Horizontal Line

(% style="color:blue" %)
----

Listen

2.0 Lists

* Element 1
** Element 2
*** Element 3
* Element 4

1. Element 1
11. Element 2
111. Element 3
1. Element 4

1. Element 1
1*. Element 2
1*. Element 3
1. Element 4

(% style="list-style-type: square" %)
* Element 1
* Element 2

(% style="list-style-type: disc" %)
* Element 1
* Element 2

(% style="list-style-type: lower-alpha" %)
* Element 1
* Element 2

(% style="list-style-type: upper-alpha" %)
* Element 1
* Element 2

(% style="list-style-type: lower-roman" %)
* Element 1
* Element 2

(% style="list-style-type: upper-roman" %)
* Element 1
* Element 2

(% style="list-style-type: lower-greek" %)
* Element 1
* Element 2

(% style="list-style-type: upper-greek" %)
* Element 1
* Element 2

(% style="list-style-type: hiragana" %)
* Element 1
* Element 2

(% style="list-style-type: hiragana-iroha" %)
* Element 1
* Element 2

(% style="list-style-type: katakana" %)
* Element 1
* Element 2

(% style="list-style-type: katakana-iroha" %)
* Element 1
* Element 2

(% style="list-style-type: armenian" %)
* Element 1
* Element 2

(% style="list-style-type: hebrew" %)
* Element 1
* Element 2

(% style="list-style-type: georgian" %)
* Element 1
* Element 2

(% style="list-style-type: cjk-ideographic" %)
* Element 1
* Element 2

Definitionslisten

2.0 Definition Lists

; Begriff
: Definition

; Begriff 1
: Definition 1
:; Begriff 2
:: Definition 2

(% style="color:blue" %)
; Begriff
: Definition

Neue Zeile/Zeilenumbruch

2.0 New Line Line Breaks

Eine neue Zeile ist ein Absatzende. Ein Zeilenumbruch ist eine erzwungene neue Zeile, welche an jeder Stelle im Text auftreten kann.

Links

2.1 Links

Funktion	XWiki Syntax 2.1	Ergebnis
Link zu Seite im aktuellen Bereich	[[WebHome]]	XWiki
Link mit Linktext	[[Linktext>>WebHome]] InformationXWiki Syntax innerhalb des Linktextes wird unterstützt.	Linktext
Link mit XWiki Syntax im Linktext	[[**fetter Linktext**>>WebHome]]	fetter Linktext
Link zu Seite im angegebenen Bereich	[[Main.WebHome]]	Main
Link zu einem Unterwiki	[[subwiki:Main.WebHome]]	Main
Link der in neuem Fenster öffnet	[[Linktext>>WebHome||rel="__blank"]]	Linktext
Link zu einer URL direkt im Text	Dies ist eine URL: http://xwiki.org	Dies ist eine URL: http://xwiki.org
Link zu einer URL	[[http://xwiki.org]]	http://xwiki.org
Link zu einer URL mit Linktext	[[XWiki>>http://xwiki.org]]	XWiki
Link zu einer E-Mail-Adresse	[[john@smith.net>>mailto:john@smith.net]]	john@smith.net
Bild-Link	[[image:Bereich2.Seite2@Bild.png>>Bereich1.Seite1]]
Bild-Link mit Bildparametern	[[[[image:Bereich2.Seite2@Bild.png||width="26" height="26"]]>>Bereich1.Seite1]]
Link zu einem Anhang auf der aktuellen Seite	[[Text>>attach:img.png]]	Text
Link zu einem Anhang auf einer anderen Seite	[[Text>>attach:Bereich.Seite@img.png]]	Text
Link zu einem Anker auf einer Seite	[[Text>>Bereich.Seite||anchor=anchor]]	Text
Link zu einer Überschrift auf einer Seite	[[Text>>Bereich.Seite||anchor=HMyheading]]	Text

XWiki Syntax 2.1 Linkspezifikation

Das vollständige Format eines Links ist [Linktext>>] (Ressource) [||Parameter]

• Linktext: Eine optionale Zeichenkette, welche dem Nutzer beim Rendern als Linkname gezeigt wird. Der Linktext kann XWiki Syntax enthalten. Wenn kein Linktext angegeben ist, wird ein Standartext generiert. Das Erstellungsmuster kann verändert werden, siehe Admin Guide. Beispiel: Meine Seite
• Ressource: Eine erforderliche Zeichenkette mit der Linkreferenz in einer der folgenden Formen
  • URL: Eine URL in der Form [url:] (Protokoll://Pfad). Beispiele: http://xwiki.org, url:https://svn.xwiki.org/
    • url: Eine optionale Zeichenkette, die die Ressource als URL identifiziert.
  • Wikiseitenname Referenz in der Form [doc:] [[wikiName:] Bereich.] (Seite). Beispiele: WebHome, Main.WebHome, mywiki:Main.WebHome
    • doc: Eine optionale Zeichenkette, die die Ressource als XWiki Dokument identifiziert.
      • wikiName: Eine optionale Zeichenkette, die den Namen des virtuellen Wikis enthält. Der Link wird auf eine Seite in diesem virtuellen Wiki zeigen. Beispiel: mywiki
      • Bereich: Ein optionaler Bereichsname. Wenn kein Bereich spezifiziert wird, wird der aktuelle Bereich verwendet. Beispiel: Main
      • Seite: Eine erforderliche Zeichenkette, die den Namen der verknüpften Wikiseite enthält. Beispiel: WebHome
  • InterWiki Seitenname Referenz in der Form interwiki: (interWikiAlias:) (Seite). Beispiel: interwiki:wikipedia:XWiki
    • interwiki: Eine erforderliche Zeichenkette, die die Ressource als einen InterWiki Link identifiziert.
    • interWikiAlias: Ein optionales Inter Wiki Alias, entsprechend der Definition in der InterWiki Map (siehe Admin Guide). Beispiel: wikipedia
    • Seite: Eine erforderliche Zeichenkette, die den Namen der verknüpften Wikiseite enthält. Beispiel: XWiki
  • Anhang Referenz in der Form attach: [wikiSeitenName @] (anhangsName). Beispiele: attach:img.png, attach:mywiki:Main.WebHome@img.png
    • attach:: Eine notwendige Zeichenkette, die die Ressource als Anhang identifiziert.
    • wikiSeitenName: Eine optionale Zeichenkette, die das Dokument, an das der Anhang angehängt ist, referenziert, siehe "Wikiseitenname" oben.
    • anhangsName: Name des Anhangs, wie er im Wiki gespeichert ist.
  • E-Mail-Adresse in der Form mailto: (emailAdresse) (#Anker ist nicht zulässig). Beispiel: mailto:john@smith.com
    • mailto:: Eine notwendige Zeichenkette, die die Ressource als E-Mail identifiziert.
    • emailAddress: Ziel-E-Mail-Adresse. Beispiel: john@smith.com
  • Relativer Pfad Referenz auf dem Server in der Form path: (relPfad). Beispiel: path:$doc.getURL('reset') erzeugt Zieladresse http://server.domain.com/xwiki/bin/reset/Space/Page wobei /xwiki/bin/reset/Space/Page durch $doc.getURL('reset') erzeugt wird.
    • path: Eine erforderliche Zeichenkette, die die Ressource als relativen Pfad identifiziert.
    • relPfad: Eine erforderliche Zeichenkette, die den relativen Pfad der Ressource auf dem Server enthält, die verknüpft werden soll.
  • UNC (Windows Explorer) Referenz in der Form unc: (Pfad). Der Link wird als file:// gerendet. Beispiele: unc:C:\Windows\, unc:\\myserver\path\img.png, unc:home/user/somefile
    • unc: Eine erforderliche Zeichenkette, die die Ressource als UNC (Windows Explorer) Pfad identifiziert.
    • Pfad: Eine erforderliche Zeichenkette, die den lokalen Pfad der Ressource, die dem Nutzer zugänglich ist, enthält. Beispiele: C:\Windows\, \\myserver\path\img.png, home/user/somefile
• Parameter: Eine optionale Liste von Leerzeichen-getrennten Parametern, die an den Link übergeben werden. Beispiel: queryString="mydata1=5&mydata2=Hallo" anchor="HInhaltsverzeichnis" rel="__blank"
  • queryString: Eine optionale Abfragezeichenkette, die Parameter spezifiziert, die an die Linkzieladresse angehängt werden und in der gerenderten URL verwendet werden. Beispiel: url:http://domain.com/pfad||queryString="mydata1=5&mydata2=Hello" erzeugt Zieladresse http://domain.com/pfad?mydata1=5&mydata2=Hello
  • anchor: Ein optionaler Ankername, der auf einen Anker im referenzierten Link zeigt. Es ist zu beachten, dass XWiki Anker automatisch für Überschriften erstellt werden. Beispiel: url:http://domain.com/pfad||anchor="HInhaltsverzeichnis" erzeugt Zieladresse http://domain.com/pfad#HInhaltsverzeichnis
  • rel: Ein optionaler Parameter, der es ermöglicht das Linkziel in einem neuen Fenster zu öffnen. Beispiel: rel="__blank"

Tabellen

2.0 Tables

Erlaubt es auf einfache Weise Inhalte im Tabellenformat zu erstellen. Parameter für Tabelle, Reihe oder Zelle sind ebenfalls in XWiki Syntax 2.0 unterstützt.

|=Titel 1|=Titel 2
|Wort 1|Wort 2

!=Titel 1!=Titel 2
!!Wort 1!!Wort 2

(% style="background-color:red;align=center" %)
|=Titel 1|=(% style="background-color:yellow" %)Titel 2
|Wort 1|Wort 2

{{velocity}}
$xwiki.ssfx.use("js/xwiki/table/table.css")
$xwiki.jsfx.use("js/xwiki/table/tablefilterNsort.js", true)
{{/velocity}}

(% class="grid sortable filterable doOddEven" id="tableid" %)
(% class="sortHeader" %)|=Title 1|=Title 2
|Cell 11|Cell 12
|Cell 21|Cell 22

Bilder

2.1 Images

Funktion	XWiki Syntax 2.1	Ergebnis
Bild von Anhang auf aktueller Seite	image:img.png
Bild von Anhang auf anderer Seite	image:Bereich.Seite@img.png
Bild mit Parametern	[[image:img.png||width="25" height="25"]]
Bild befindlich an URL	image:http://eine/url/img.png
Vordefiniertes Piktogramm	image:icon:accept

XWiki Syntax 2.1 Bild-Spezifikation

Das vollständige Format eines Bilder ist entweder image: (Verweis) oder [[image: (Verweis) {||Parameter}]]

• image: Ein erforderlicher Text, welches die folgenden Angaben als Bild kennzeichnet. 
• Verweis: Der Verweis auf das anzuzeigende Bild. Der Verweis kann in folgenden Formaten angegeben werden:
  • URL: Eine URL zu einem externen Bild in dem Format http://pfad/BildName. Beispiel: http://example.org/pfad/bild.png
  • Anhang: Ein Verweis auf einen Anhang im Wiki im Format {{{wikiName:} Bereich.} Seite@} (BildName)
    • wikiName: Ein optionaler Text, welcher den Namen eines Subwikis enthält. Das Bild wird dann in dem entsprechenden Subwiki nachgeschlagen. Beispiel: mywiki
    • Bereich: Der Name eines Bereiches, in dem das Bild nachgeschlagen wird (optional). Wenn kein Bereich angegeben, wird der aktuelle Bereich verwendet. Beispiel: Main
    • Seite: Der Namen einer Seite, an der das Bild angehangen ist (optional). Wird keine Seite angegeben, wird die aktuelle Seite verwendet. Beispiel: WebHome
    • BildName: Ein erforderlicher Text, welcher den Dateinamen des anzuzeigenden Bildes enthält, wie er im Wiki gespeichert ist.
  • Piktogramme Ein Verweis mittels des Textes (icon:) (iconName). Beispiel: icon:accept
    • icon:  Ein erforderlicher Text, welcher die folgende Angabe als Piktogramm kennzeichnet. Piktogramme können nur aus der vorinstallierten Liste der XWiki Icons ausgewählt werden.
    • iconName: Ein erforderlicher Text mit dem (englischen) Namen des anzuzeigenden Piktogramms. Beispiel: accept
  • Data URIs in der Form (data:) (bilddaten). Beispiel:  data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==
    • data: Ein erforderlicher Text, welcher die folgende Angabe als Binärdaten zu interpretieren erlaubt, enstprechend dem 'data' URI Schema.
    • bilddaten: Angabe zu Dateiformat und Codierung, etwa für PNG-Bilder in Base64-codierung image/png;base64, gefolgt von den Binärdaten des Bildes in der angegebenen textuellen Codierung
• Parameter: Eine optionale Liste von durch Leerzeichen getrennten Parametern, die an das Bild durchgereicht werden. Beispiel: width="800" height="600" alt="Ein beispielhaftes Bild" title="Dies ist ein schönes Bild"
  • HTML Attribute: Alle Attribute, welche im HTML Standard vorgesehen sind, werden zu dem erzeugten <img> Element hinzugefügt.
    • style: CSS-Stil Anweisungen, welche auf das Bild angewendet werden. Beispiele: style="float:right;height:50px" (d.h. das Bild wird rechtsbündig eingebettet mit einer Höhe von 50 Pixeln),
      style="style="display:block;margin-left:auto;margin-right:auto;width:80%" (Bild wird zentriert dargestellt in einer Breite von 80% des zur Verfügung stehenden Platzes),
      style="vertical-align:bottom" (Der folgende Text startet direkt an unteren Ende des Bildes).
    • height: Die vertikale Grösse des angezeigten Bildes. Der Parameterwert sollte entweder in Bildschirmpixeln angeben werden (Beispiel height="80") oder in prozentualen Anteilen des Anzeigebereichs (Beispiel height="40%")
    • width: Die horizontale Grösse des angezeigten Bildes. Der Parameterwert sollte entweder in Bildschirmpixeln angeben werden (Beispiel width="120") oder in prozentualen Anteilen des Anzeigebereichs (Beispiel width="80%")
    • title: Der Text, der beim Überfahren den Bildes mit dem Mauszeiger angezeigt wird. Beispiel: title="Dies ist ein schönes Bild"
    • alt: Der Text, welcher alternativ angezeigt wird, wenn der Browser das Bild nicht darstellen kann. Da dies im HTML eine Pflichtangabe ist, verwendet XWiki den Dateinamen, wenn kein Wert für alt angegeben wurde. Beispiel: alt="Ein beispielhaftes Bild"
    • ... und mehr: Die offizielle Liste aller unterstützten Attribute kann auf der offiziellen w3.org Seite  (in Englisch) eingesehen werden.
  • queryString: Ein optionaler Text, welcher als Abfrageparameter an die URL angehangen wird, unter der das Bild vom Server abgeholt wird. Beispiel: queryString="width=100&height=800&keepAspectRatio=true" (keepAspectRatio=true soll den Server veranlassen, die Seitenverhältnisse des Bildes beizubehalten, wird aber ignoriert, wenn sowohl width als auch height angegeben werden)

Forgeschritten

Wortgetreu

2.0 Verbatim

Erlaubt es Inhalte einzugeben, die nicht formatiert werden (in anderen Worten wird die XWiki Syntax nicht beachtet).

{{{
mehrzeiliger
**wortgetreuer**
Inhalt
}}}

mehrzeiliger
**wortgetreuer**
Inhalt

Zitate

2.0 Quotations

Erlaubt es einen Text zu zitieren.

> Max hat das gesagt
Ich habe OK gesagt

> Max hat das gesagt
>> Marie hat das geantwortet
Ich hab OK gesagt

Gruppen

2.0 Groups

Gruppen können benutzt werden um ein Dokument "inline" direkt in ein anderes Dokument einzufügen. Dies ermöglicht es beispielsweise komplexe Elemente in einem Listenelement oder in einer Tabellenzelle einzufügen. Gruppen sind durch die folgenden Syntaxelemente begrenzt: (((...))). Eine Gruppe kann eine andere Gruppe beinhalten und es gibt keine Grenzen bei der Verschachtelung.

|=Kopfzeile 1|=Kopfzeile 2|=Kopfzeile 3
|Zelle Eins|(((
= Eingebundenes Dokument =

Ein eingebetteter Absatz.

* Listenelement eins
* Listenelement zwei
  ** Unterelement 1
  ** Unterelement 2
))) | Zelle Drei

Nächster Absatz im Dokument der obersten Ebene

Entziehungszeichen

2.0 Escapes

Erlaubt es XWiki Syntax zu entgehen.

Parameter

2.0 Parameters

Mit der XWiki Syntax 2.1 ist es möglich Parameter an die verschiedenen Syntaxelemente und auch an Textblöcke weiterzugeben. Dies wird beispielsweise benutzt um diese zu gestalten. Sie können jegliche Parameterschlüssel/Wertepaare verwenden, die Sie möchten. Der XHTML Renderer wird diese Parameter als XHTML Attribute an die zugrundeliegende XHTML Representation der verschiedenen Syntaxelemente weitergeben. 

(% class="meineKlasse" style="meinStil" id="meineID" %)
= Überschrift =

<h1 class="meineKlasse" style="meinStil" id="meineID">Überschrift</h1>

Programmierung

Makros

2.0 Macros

In XWiki Syntax 2.1 gibt es genau eine Art von Makros, welche mittels der Syntax {{macroname param1="value1" ... paramN="valueN"}} angegeben werden, zum Beispiel für das {{code}} Makro:

{{code language="java"}}
System.out.println("Hello World!");
{{/code}

HTML

2.0 HTML

Skripte

2.0 Scripts

{{velocity}}
#set ($var = "whatever")
{{/velocity}}

{{groovy}}
def var = "whatever"
{{/groovy}}