XWiki Syntaxes

Zuletzt geändert von Admin am 2009/09/16 13:32

Beginnend mit XWiki Enterprise Version 1.7 und darüber haben wir eine neue Wiki Syntax eingeführt. Daher haben wir die alte Syntax die XWiki Syntax 1.0 benannt und die neue Syntax wird sinnigerweise XWiki Syntax 2.0 genannt. Die Hauptgründe für die Einführung der neuen Syntax waren:

  • Die Einschränkungen und Mehrdeutigkeiten der XWiki 1.0 Syntax (welche sowohl durch Radeox - der zugrunde liegenden Rendering-Engine - und TWiki inspiriert wurde) beheben.
    • Nicht optimale Symbole. Zum Beispiel, das Symbol für fett war ein einzelner Stern. Dies hat Probleme verursacht, wenn der Nutzer Texte eingab, die Sterne beinhalteten, da dieser Text fälschlicherweise als fett angenommen wurde, auch wenn er das nicht war. Daher haben wir die Syntax rationalisiert, indem überall mindestens doppelte Zeichen verwendet werden.
    • Mehrdeutigkeiten. Zum Beispiel, gab es eine Mehrdeutigkeit wischen einem fetten Element, dass die Zeile begann, und einer Aufzählungsliste. Diese Mehrdeutigkeiten mussten beseitigt werden um den WYSIWYG Editor umschreiben zu können, so dass dieser deterministisch sein konnte.
  • Um näher an der Creole 1.0 Syntax zu sein, welche ein Standard für Wiki Syntax wird. Zusätzlich hat die Creole Gemeinde sich die Zeit genommen, um alle existierenden Wiki Syntaxen zu analysieren, bevor sie sich für Symbole entschieden haben. Diese Entscheidungen sind daher sehr gut.

Seit der Einführung der XWiki Syntax 2.0 wurden einige Mängel dieser Syntax gefunden. Um diese zu beheben wurde eine neue, zum jetzigen Zeitpunkt experimentelle, XWiki Syntax 2.1 in XWiki Enterprise Version 3.0 eingeführt. Einige Gründe für die Entwicklung dieser neuen Syntax sind:

  • Die Link- und Bildsyntax für bessere Klarheit, Konsistenz und Erweiterbarkeit homogenisiert.
  • Möglichkeit zum Anzeigen von Icons, zum verlinken von Dateien mittels der UNC Notation und dem Verlinken zu relativen URLs hinzugefügt.
IconInformation

Da die XWiki Syntax 2.1 auf der XWiki Syntax 2.0 basiert ist die gesamte XWiki Syntax 2.0 gültig, solange die 2.1 Spezifikationen nichts anderes andeuten.

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

Grundlegende Bemerkungen

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

BeschreibungBeispiel für ungültige oder mehrdeutige SyntaxKorrigierte Syntax 2.0
Nicht geschlossener Textstil**fett**fett**
Zwei unabhängige Elemente sind nicht durch 2 neue Zeilen getrennt| Tabellenzelle
* Listenelement
| Tabellenzelle

* Listenelement
Zwei unabhängige Elemente sind nicht durch 2 neue Zeilen getrenntAbsatz
----
Absatz
Absatz

----

Absatz
Ignorierte neue Zeilen am Anfang von Dokument<neue Zeile am Anfang des Dokuments>
Absatz
Absatz
Nicht geschlossene Überschriftensyntax=== Überschrift=== Überschrift ===

Absatz

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

IconInformation

In XWiki Syntax 2.0 werden neue Zeilen beachtet, was in XWiki Syntax 1.0 und Creole Syntax nicht der Fall ist.

FunktionXWiki Syntax 1.0XWiki Syntax 2.0Ergebnis XWiki Syntax 1.0Ergebnis XWiki Syntax 2.0
Einfacher AbsatzDies ist ein AbsatzDies ist ein AbsatzDies ist ein AbsatzDies ist ein Absatz
Absatz mit mehreren ZeilenAbsatz auf\\
mehreren Zeilen
Absatz auf
mehreren Zeilen
Absatz auf
mehreren Zeilen
Absatz auf
mehreren Zeilen
Zwei AbsätzeAbsatz eins

Absatz zwei
Absatz eins

Absatz zwei
Absatz eins

Absatz zwei
Absatz eins

Absatz zwei
Parametrisierter Absatz<p style="text-align:center;color:blue">Zentrierter und blauer Absatz</p>(% style="text-align:center;color:blue" %)
Zentrierter und blauer Absatz

Zentrierter und blauer Absatz

Zentrierter und blauer Absatz

Überschriften

FunktionXWiki Syntax 1.0XWiki Syntax 2.0Ergebnis
Standardüberschriften

1 Ebene 1
1.1 Ebene 2
1.1.1 Ebene 3
1.1.1.1 Ebene 4
1.1.1.1.1 Ebene 5
1.1.1.1.1.1 Ebene 6

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

Ebene 1

 

Ebene 2

Ebene 3

Ebene 4

Ebene 5
Ebene 6
Parametrisierte Überschrift<h1><span style="color:blue">Überschrift</span></h1>(% style="color:blue" %)
= Überschrift =

Überschrift

Überschrift mit XWiki Syntax1.1.1 Überschrift mit *fett*=== Überschrift mit **fett** ===

Überschrift mit fett

Textformatierung

IconInformation

Neu in XWiki Syntax 2.0 im Vergleich zu XWiki Syntax 1.0:

  • Leerzeichen sind direkt nach einem Syntaxsymbol erlaubt (zum Beispiel war dies in XWiki Syntax 1.0 nicht möglich: * fett *).
  • Doppelsymbole werden verwendet, wo einzelne Symbole in XWiki Syntax 1.0 verwendet wurden, damit es unwahrscheinlicher wird, dass Benutzer sie versehentlich im Text verwenden.
  • Fähigkeit mehrere Zeilen zu überspannen (war in XWiki Syntax 1.0 nicht möglich).
FunktionXWiki Syntax 1.0XWiki Syntax 2.0Ergebnis
Fett*fett***fett**fett
Unterstrichen__unterstrichen____unterstrichen__unterstrichen
Kursiv~~kursiv~~//kursiv//kursiv
Durchgestrichen--durchgestrichen----durchgestrichen--durchgestrichen
Nichtproportional<tt>nichtproportional</tt>##nichtproportional##nichtproportional
Hochgestelltetwas <sup>hochgestellt</sup>etwas ^^hochgestellt^^etwas hochgestellt
Tiefgestelltetwas <sub>tiefgestellt</sub>etwas ,,tiefgestellt,,etwas tiefgestellt

Horizontale Linie

IconInformation

Es müssen vier oder mehr Striche sein.

IconInformation

Es ist zu beachten, dass dies anders als bei Creole ist, wo es genau vier Striche gefordert sind.

FunktionXWiki Syntax 1.0XWiki Syntax 2.0Ergebnis
Einfache horizontale Linie--------

Parametrisierte horizontale linie<hr style="color:blue"/>
(% style="color:blue" %)
----

Listen

IconInformation

Einige der genannten Stile funktionieren nicht in allen Browsern. Für eine ausführliche Liste folgen Sie diesem Link (Englisch).

FunktionXWiki Syntax 1.0XWiki Syntax 2.0Ergebnis
Aufzählung
* Element 1
** Element 2
*** Element 3
* Element 4
* Element 1
** Element 2
*** Element 3
* Element 4
  • Element 1
    • Element 2
      • Element 3
  • Element 4
Nummerierung
1. Element 1
11. Element 2
111. Element 3
1. Element 4
1. Element 1
11. Element 2
111. Element 3
1. Element 4
  1. Element 1
    1. Element 2
      1. Element 3
  2. Element 4
Gemischte Liste
1. Element 1
1*. Element 2
1*. Element 3
1. Element 4
1. Element 1
1*. Element 2
1*. Element 3
1. Element 4
  1. Element 1
    • Element 2
    • Element 3
  2. Element 4
Aufzählung (Quadrat)
- Element 1
- Element 2
(% style="list-style-type: square" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Aufzählung (Kreis)

<ul style="list-style-type: disc">
  <li>Element 1</li>
  <li>Element 2</li>
</ul>

(% style="list-style-type: disc" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (Kleinbuchstaben)
a. Element 1
a. Element 2
(% style="list-style-type: lower-alpha" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (Großbuchstaben)
A. Element 1
A. Element 2
(% style="list-style-type: upper-alpha" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (kleine römische Zahlen)
i. Element 1
i. Element 2
(% style="list-style-type: lower-roman" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (große römische Zahlen)
I. Element 1
I. Element 2
(% style="list-style-type: upper-roman" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (griechische Kleinbuchstaben)
g. Element 1
g. Element 2
(% style="list-style-type: lower-greek" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (griechische Großbuchstaben)
G. Element 1
G. Element 2
(% style="list-style-type: upper-greek" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Hiragana Liste
h. Element 1
h. Element 2
(% style="list-style-type: hiragana" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Hiragana Iroah Liste
H. Element 1
H. Element 2
(% style="list-style-type: hiragana-iroha" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Katakana Liste
k. Element 1
k. Element 2
(% style="list-style-type: katakana" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Katakana Iroha Liste
K. Element 1
K. Element 2
(% style="list-style-type: katakana-iroha" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (armenisch)
<ul style="list-style-type: armenian">
  <li>Element 1</li>
  <li>Element 2</li>
</ul>
(% style="list-style-type: armenian" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (hebräisch)
j. Element 1
j. Element 2
(% style="list-style-type: hebrew" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (georgisch)
<ul style="list-style-type: georgian">
  <li>Element 1</li>
  <li>Element 2</li>
</ul>
(% style="list-style-type: georgian" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (CJK Ideogramme)
<ul style="list-style-type: cjk-ideographic">
  <li>Element 1</li>
  <li>Element 2</li>
</ul>
(% style="list-style-type: cjk-ideographic" %)
* Element 1
* Element 2
  • Element 1
  • Element 2

Definitionslisten

FunktionXWiki Syntax 1.0XWiki Syntax 2.0Ergebnis
Standarddefinition
<dl>
  <dt>Begriff</dt>
  <dd>Definition</dd>
</dl>
; Begriff
: Definition
Begriff
Definition
Verschachtelte Definitionen
<dl>
  <dt>Begriff 1</dt>
  <dd>Definition 1
    <dl>
      <dt>Begriff 2</dt>
      <dd>Definition 2</dd>
    </dl>
  </dd>
</dl>
; Begriff 1
: Definition 1
:; Begriff 2
:: Definition 2
Begriff 1
Definition 1
Begriff 2
Definition 2
Parametrisierte Definition
<dl style="color:blue">
  <dt>Begriff</dt>
  <dd>Definition</dd>
</dl>
(% style="color:blue" %)
; Begriff
: Definition
Begriff
Definition

Neue Zeile/Zeilenumbruch

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

IconInformation

In XWiki Syntax 2.0 werden neue Zeilen beachtet, was in XWiki Syntax 1.0 und Creole Syntax nicht der Fall ist.

FunktionXWiki Syntax 1.0XWiki Syntax 2.0Ergebnis XWiki Syntax 1.0Ergebnis XWiki Syntax 2.0
ZeilenumbruchZeile\\Neue ZeileZeile\\Neue ZeileZeile
Neue Zeile
Zeile
Neue Zeile
Neue ZeileZeile
Neue Zeile
Zeile
Neue Zeile
Zeile Neue ZeileZeile
Neue Zeile

Links

FunktionXWiki Syntax 1.0XWiki Syntax 2.0Ergebnis XWiki Syntax 1.0Ergebnis XWiki Syntax 2.0
Link zu Seite im aktuellen Space[WebHome][[WebHome]]Web HomeXWiki
Link mit Linktext[Linktext>WebHome]

[[Linktext>>WebHome]]
IconInformationXWiki Syntax innerhalb des Linktextes wird unterstützt.

LinktextLinktext
Link mit XWiki Syntax im Linktext<a href="$xwiki.getURL("WebHome")"><strong>fetter Linktext</strong></a>[[**fetter Linktext**>>WebHome]]fetter Linktextfetter Linktext
Link zu Seite im angegebenen Space[Main.WebHome][[Main.WebHome]]Web HomeMain
Link zu einem Unterwiki[subwiki:Main.WebHome][[subwiki:Main.WebHome]]Web HomeMain
Link der in neuem Fenster öffnet[label>WebHome>_blank][[label>>WebHome||rel="__blank"]]labellabel
Link zu einer URL direkt im TextDies ist eine URL: http://xwiki.orgDies ist eine URL: http://xwiki.orgDies ist eine URL: http://xwiki.orgDies ist eine URL: http://xwiki.org
Link zu einer URL[http://xwiki.org][[http://xwiki.org]]http://xwiki.orghttp://xwiki.org
Link zu einer URL mit Linktext[XWiki>http://xwiki.org][[XWiki>>http://xwiki.org]]XWikiXWiki
Link zu einer E-Mail-Adresse[john@smith.net>mailto:john@smith.net][[john@smith.net>>mailto:john@smith.net]]john@smith.netjohn@smith.net
Bild-Link<a href="$xwiki.getURL("Space1.Seite1")">{image:Bild.png|document=Space2.Seite2}</a>[[image:Space2.Seite2@Bild.png>>Space1.Seite1]]img.pngimg.png
Bild-Link mit Bildparametern<a href="$xwiki.getURL("Space1.Seite1")">{image:Bild.png|document=Space2.Seite2|width=26|height=26}</a>[[[[image:Space2.Seite2@Bild.png||width="26" height="26"]]>>Space1.Seite1]]img.pngimg.png
Link zu einem Anhang auf der aktuellen Seite

IconInformationSiehe Anhangsmakro für Details
{attach:Text|file=img.png}

[[Text>>attach:img.png]]TextText
Link zu einem Anhang auf einer anderen Seite

IconInformationSee Anhangsmakro für Details
{attach:Text|document=Space.Seite|file=img.png}

[[Text>>attach:Space.Seite@img.png]]TextText

XWiki Syntax 1.0 Linkspezifikation

IconInformation

Teil in ( ) ist erforderlich, Teile in [ ] sind optional und eines der zwei Zeichen in { } muss eingefügt werden, wenn optionale Teile verwendet werden.

Das vollständige Format eines Links ist [Linktext {> oder |}] (Ressource) [@interWikiAlias] [{> oder|} Ziel]

  • Linktext: Eine optionale Zeichenkette, welche dem Nutzer beim Rendern als Linkname gezeigt wird. Beispiel: Meine Seite
  • Ressource: Die vollständige Linkreferenz in folgender Syntax: (Referenz) [?queryString] [#Anker]
    • Referenz: Die Linkreferenz. Diese kann entweder
      • Ein URI in der Form Protokoll:Pfad (Beispiel: http://xwiki.org, mailto:john@smith.com), oder
      • Eine Wikiseitenreferenz in der Form [[wikiName:] Space.] (Seite). Beispiel: WebHome, Main.WebHome, mywiki:Main.WebHome sein.
        • 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
        • Space: Ein optionaler Wiki-Space-Name. Wenn kein Space spezifiziert wird, wird der aktuelle Space verwendet. Beispie: Main
        • Seite: Eine erforderliche Zeichenkette, die den Namen der verknüpften Wikiseite enthält. Beispiel: WebHome
    • queryString: Eine optionale Abfragezeichentkette, die Parameter spezifiziert, die in der gerenderten URL verwendet werden. Beispiel: mydata1=5&mydata2=Hallo
    • Anker: 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: HInhaltsverzeichnis
  • interWikiAlias: Ein optionales Inter Wiki Alias, entsprechend der Definition in der InterWiki Map (siehe Admin Guide). Dies ist nur für Wikiseitennamen zulässig. Beispiel: wikipedia
  • Ziel: Eine optionale Zeichenkette entsprechend dem HTML target Attribut für ein HTML A Linkelement. Dieses Element wird beim Rendern des Links verwendet. Standardmäßig wird der Link im aktuellen Fenster geöffnet. Beispiele: _self, _blank

XWiki Syntax 2.0 Linkspezifikation

IconInformation

Der Teil in ( ) ist erforderlich, während die Teile in [ ] optional sind.

Das vollständige Format eines Links ist [Linktext>>] (Ressource) [@interWikiAlias] [||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: Die vollständige Linkreferenz in folgender Syntax: (Referenz) [?queryString] [#Anker]
    • Referenz: Die Linkreferenz in einer der folgenden Formen:
      • URL: Eine URL in der Form Protokoll://Pfad. Beispiele: http://xwiki.org, https://svn.xwiki.org/
      • Wikiseitenname Referenz in der Form [[wikiName:] Space.] (Seite). Beispiele: WebHome, Main.WebHome, mywiki:Main.WebHome
        • 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
        • Space: Ein optionaler Wiki-Space-Name. Wenn kein Space spezifiziert wird, wird der aktuelle Space verwendet. Beispiel: Main
        • Seite: Eine erforderliche Zeichenkette, die den Namen der verknüpften Wikiseite enthält. Beispiel: WebHome
      • Anhang Referenz in der Form attach: [wikiSeitenName @] (anhangsName) (#Anker ist nicht zulässig). 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
    • queryString: Eine optionale Abfragezeichentkette, die Parameter spezifiziert, die in der gerenderten URL verwendet werden. Beispiel: mydata1=5&mydata2=Hallo
    • Anker: 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: HInhaltsverzeichnis
  • interWikiAlias: Ein optionales Inter Wiki Alias, entsprechend der Definition in der InterWiki Map (siehe Admin Guide). Dies ist nur für Wikiseitennamen zulässig. Beispiel: wikipedia
  • Parameter: Eine optionale Liste mit Parametern, die an den Link weitergegeben werden. Beispiel: rel="__blank" (in neuem Fenster öffnen)

XWiki Syntax 2.1 Link Specification

IconInformation

Der Teil in ( ) ist erforderlich, während die Teile in [ ] optional sind.

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:] Space.] (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
        • Space: Ein optionaler Wiki-Space-Name. Wenn kein Space spezifiziert wird, wird der aktuelle Space 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&amp;mydata2=Hallo" anchor="HInhaltsverzeichnis" rel="__blank"
    • queryString: Eine optionale Abfragezeichentkette, 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&amp;mydata2=Hello" erzeugt Zieladresse http://domain.com/pfad?mydata1=5&amp;mydata2=Hello
    • Anker: 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: An optional parameter that allows to open link target in new window. Example: rel="__blank"
    • rel: Ein optionaler Parameter, der es ermöglicht das Linkziel in einem neuen Fenster zu öffnen. Beispiel: rel="__blank"

Tabellen

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.

FunktionXWiki Syntax 1.0XWiki Syntax 2.0Ergebnis
Standardtabelle
{table}
Titel 1 | Titel 2
Wort 1 | Wort 2
{table}
|=Titel 1|=Titel 2
|Wort 1|Wort 2
oder
!=Titel 1!=Titel 2
!!Wort 1!!Wort 2
Titel 1Titel 2
Wort 1Wort 2
Parametrisierte Tabelle

<table style="background-color:red;align:center">
  <tbody>
    <tr>
      <td>Titel 1</td>
      <td style="background-color:yellow">Titel 2</td>
    </tr>
    <tr>
      <td>Wort 1</td>
      <td>Wort 2</td>
    </tr>
  </tbody>
</table>

(% style="background-color:red;align=center" %)
|=Titel 1|=(% style="background-color:yellow" %)Titel 2
|Wort 1|Wort 2
Titel 1Titel 2
Wort 1Wort 2
Filterbare, sortierbare Tabelle
$xwiki.ssfx.use("js/xwiki/table/table.css")
$xwiki.jsfx.use("js/xwiki/table/tablefilterNsort.js", true)
<table id="tableid" class="grid sortable filterable doOddEven">
  <tr class="sortHeader">
    <th>Titel 1</th>
    <th>Titel 2</th>
  </tr>
  <tr>
   <td>Zelle 11</td>
   <td>Zelle 12</td>
  </tr>
  <tr>
   <td>Zelle 21</td>
   <td>Zelle 22</td>
  </tr>
</table>
IconInformation

Für verbesserte Funktionen siehe das Live-Table Makro.

{{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" %)|=Titel 1|=Titel 2
|Zelle 11|Zelle 12
|Zelle 21|Zelle 22
IconInformation

Für verbesserte Funktionen siehe das Live-Table Macro.

Titel 1Titel 2
Zelle 11Zelle 12
Zelle 21Zelle 22

Bilder

FunktionXWiki Syntax 1.0XWiki Syntax 2.0Ergebnis
Bild von Anhang auf aktueller Seite

IconInformationSiehe Bildmakro fü Details
{image:img.png}

image:img.pngimg.png
Bild von Anhang auf anderer Seite{image:img.png|document=Space.Seite}image:Space.Seite@img.pngimg.png
Bild mit Parametern{image:img.png|width=25|height=25}[[image:img.png||width="25" height="25"]]img.png
Bild befindlich an URLhttp://eine/url/img.pngimage:http://eine/url/img.pngimg.png

Wortgetreu

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

IconInformation

In XWiki Syntax 1.0 schützt das Pre Makro nur XWiki Syntax und Radeox Makros. HTML Code und Groovy/Velocity Skripte, hingegen, werden weiterhin ausgeführt.

FunktionXWiki Syntax 1.0XWiki Syntax 2.0Ergebnis XWiki Syntax 1.0Ergebnis XWiki Syntax 2.0
Wortgetreu in ZeileEtwas wortgetreuer {pre}*[nicht gerenderter]*{/pre} InhaltEtwas wortgetreuer {{{**[[nicht gerenderter]]**}}} InhaltEtwas wortgetreuer *[nicht gerenderter]* InhaltEtwas wortgetreuer **[[nicht gerenderter]]** Inhalt
Wortgetreuer Block

{pre} vielzeiliger *wortgetreuer* Inhalt {/pre}
IconInformationEs ist ebenfalls möglich das Code Makro zu verwenden, jedoch dieses Zeigt den Inhalt standardmäßig in einer Box.

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

Zitate

Erlaubt es einen Text zu zitieren.

FunktionXWiki Syntax 1.0XWiki Syntax 2.0Ergebnis
Einfaches Zitat

<blockquote><p>Max hat das gesagt</p></blockquote>
Ich habe OK gesagt

> Max hat das gesagt
Ich habe OK gesagt

 Max hat das gesagt

Ich habe OK gesagt

Nested quotes

<blockquote><p>Max hat das gesagt</p>
  <blockquote><p>Marie hat das geantwortet</p></blockquote>
</blockquote>
Ich hab OK gesagt

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

 Max hat das gesagt

 Marie hat das geantwortet

Ich hab OK gesagt

Gruppen

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.

XWiki Syntax 1.0XWiki Syntax 2.0Ergebnis
IconInformationDiese Funktion existiert nicht in XWiki Syntax 1.0. Es müsste reines HTML verwendet werden um das Ergebnis zu erhalten.
|=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
Kopfzeile 1Kopfzeile 2Kopfzeile 3
Zelle Eins

Eingebettetes Dokument

Ein eingebetteter Absatz.

  • Listenelement eins
  • Listenelement zwei
    • Unterelement 1
    • Unterelement 2
 Zelle Drei

Nächster Absatz im Dokument der obersten Ebene

Entziehungszeichen

Erlaubt es XWiki Syntax zu entgehen.

FunktionXWiki Syntax 1.0XWiki Syntax 2.0Ergebnis XWiki Syntax 1.0Ergebnis XWiki Syntax 2.0
Entziehungszeichen für ein ZeichenDies ist kein \[Link\]

Dies ist kein ~[~[Link~]~]
IconInformationUm ein ~ Zeichen einzufügen ist dieses doppelt einzugeben: ~~

Dies ist kein [Link]Dies ist kein [[Link]]

Makros

Es gibt zwei Arten von Makros in XWiki Syntax 1.0:

  • Velocity Makros (aufgerufen mittels der #macroname(param1 ... paramN) Syntax)
  • Radeox Makros (aufgerufen mittels der {macroname:param1=value1|...|paramN=valueN} Syntax)

Es gibt ebenfalls zwei Arten von Makros in XWiki Syntax 2.0:

  • Velocity Makros (aufgerufen mittels der #macroname(param1 ... paramN) Syntax im Velocity Makro)
  • XWiki Makros (aufgerufen mittels der {{macroname param1="value1" ... paramN="valueN"}} Syntax)
IconInformation

Die Radeox Makros können in der XWiki Syntax 2.0 nicht verwendet werden. Daher müssen diese als XWiki Makros neu geschrieben werden.

IconInformation

Für die vollständige Liste der verfügbaren Makros ist das Erweiterungswiki zu besuchen.

FunktionXWiki Syntax 1.0XWiki Syntax 2.0
Velocity Makro
#info("Ein Text")
{{info}}
Ein Text
{{/info}}
Radeox Makro/XWiki Makro
{code:java}
Java Inhalt
{code}
{{code language="java"}}
Java Inhalt
{{/code}}

HTML

IconInformation

In XWiki Syntax 2.0 muss HTML oder XHTML unter Verwendung des HTML Makros eingegeben werden, während es in XWiki Syntax 1.0 möglich ist HTML direkt in den Text einzugeben.

XWiki Syntax 1.0XWiki Syntax 2.0Ergebnis
<b>fett</b>{{html}}<b>fett</b>{{/html}}fett
IconInformation

In XWiki Syntax 2.0 versteht das HTML Makro standardmäßig keine XWiki Syntax (andere Makros eingeschlossen, da diese ebenfalls XWiki Syntax sind). Um dies einzuschalten ist {{html wiki="true"}} zu verwenden.

Velocity/Groovy Scripte

IconInformation

In XWiki Syntax 1.0 war es möglich Velocity Skripte überall direkt in der Seite einzugeben. Dies hat zu Problemen geführt, beispielsweise wenn ein Nutzer unfreiwillig Velocity Inhalte eingegeben hat. Es war zudem leistungshungrig für Seiten, die keinen Velocity Inhalt benötigten. Es gab zudem etliche weitere technische Einschränkungen. Daher müssen in XWiki Syntax 2.0 Velocity Skripte mittels des Velocity Makros eingegeben werden. Selbiges gilt für Groovy Skripte.

FunktionXWiki Syntax 1.0XWiki Syntax 2.0
Velocity Skript
#set ($var = "whatever")
{{velocity}}
#set ($var = "whatever")
{{/velocity}}
Groovy Skript
<%
def var = "whatever"
%>
{{groovy}}
def var = "whatever"
{{/groovy}}

Parameter

Mit der XWiki Syntax 2.0 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. In XWiki Syntax 1.0 gab es keine Syntax für das Übergeben von Parametern und die einzige Möglichkeit dies zu tun war es direkt XHTML in den Inhalt zu schreiben, wie in der nachstehenden Tabelle gezeigt.

XWiki Syntax 1.0XWiki Syntax 2.0Generiertes XHTML
<h1 class="meineKlasse" style="meinStil" id="meineID">Überschrift</h1>
(% class="meineKlasse" style="meinStil" id="meineID" %)
= Überschrift =
<h1 class="meineKlasse" style="meinStil" id="meineID">Überschrift</h1>

Weitere Syntaxen

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

IconWarning

Die Implementation einiger dieser Syntaxen ist noch nicht vollständig fertig. Beispielsweise funktioniert die Unterstützung für Links noch nicht perfekt. Wir müssen zu dem definieren, ob wir die originalen Syntaxen erweitern wollen um XWiki-spezifische Funktionen, wie die Möglichkeit zu einem anderen Unterwiki zu verlinken, zu unterstützen.