XWiki Syntax Hilfe

Zuletzt geändert von Thomas Mortagne am 2016/12/26 12:13

XWiki Syntax 2.1 » Bearbeiten

XWiki Syntax 2.1: Bearbeiten

Absatz

2.0 Paragraphs

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

Information

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

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

Absatz zwei
Absatz eins

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

Zentrierter und blauer Absatz

Überschriften

2.0 Headings

FunktionXWiki Syntax 2.1Ergebnis
Standardüberschriften
= 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(% style="color:blue" %)
= Überschrift =

Überschrift

Überschrift mit XWiki Syntax=== Überschrift mit **fett** ===

Überschrift mit fett

Textformatierung

2.0 Text Formatting

Information

Neu in XWiki Syntax 2.1 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 2.1Ergebnis
Fett**fett**fett
Unterstrichen__unterstrichen__unterstrichen
Kursiv//kursiv//kursiv
Durchgestrichen--durchgestrichen--durchgestrichen
Nichtproportional##nichtproportional##nichtproportional
Hochgestelltetwas ^^hochgestellt^^etwas hochgestellt
Tiefgestelltetwas ,,tiefgestellt,,etwas tiefgestellt

Horizontale Linie

2.0 Horizontal Line

Information

Es müssen vier oder mehr Striche sein.

Information

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

FunktionXWiki Syntax 2.0Ergebnis
Einfache horizontale Linie----

Parametrisierte horizontale Linie
(% style="color:blue" %)
----

Listen

2.0 Lists

Information

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

FunktionXWiki Syntax 2.1Ergebnis
Aufzählung
* 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
    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
    • Element 2
    • Element 3
  2. Element 4
Aufzählung (Quadrat)
(% style="list-style-type: square" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Aufzählung (Kreis)
(% style="list-style-type: disc" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (Kleinbuchstaben)
(% style="list-style-type: lower-alpha" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (Großbuchstaben)
(% style="list-style-type: upper-alpha" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (kleine römische Zahlen)
(% style="list-style-type: lower-roman" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (große römische Zahlen)
(% style="list-style-type: upper-roman" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (griechische Kleinbuchstaben)
(% style="list-style-type: lower-greek" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (griechische Großbuchstaben)
(% style="list-style-type: upper-greek" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Hiragana Liste
(% style="list-style-type: hiragana" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Hiragana Iroah Liste
(% style="list-style-type: hiragana-iroha" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Katakana Liste
(% style="list-style-type: katakana" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Katakana Iroha Liste
(% style="list-style-type: katakana-iroha" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (armenisch)
(% style="list-style-type: armenian" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (hebräisch)
(% style="list-style-type: hebrew" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (georgisch)
(% style="list-style-type: georgian" %)
* Element 1
* Element 2
  • Element 1
  • Element 2
Nummerierung (CJK Ideogramme)
(% style="list-style-type: cjk-ideographic" %)
* Element 1
* Element 2
  • Element 1
  • Element 2

Definitionslisten

2.0 Definition Lists

FunktionXWiki Syntax  2.1Ergebnis
Standarddefinition
; Begriff
: Definition
Begriff
Definition
Verschachtelte Definitionen
; Begriff 1
: Definition 1
:; Begriff 2
:: Definition 2
Begriff 1
Definition 1
Begriff 2
Definition 2
Parametrisierte Definition
(% style="color:blue" %)
; Begriff
: Definition
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.

Information

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

FunktionXWiki Syntax 2.0Ergebnis
ZeilenumbruchZeile\\Neue ZeileZeile
Neue Zeile
Neue ZeileZeile
Neue Zeile
Zeile
Neue Zeile
FunktionXWiki Syntax 2.1Ergebnis
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 TextDies ist eine URL: http://xwiki.orgDies 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]]img.png
Bild-Link mit Bildparametern[[[[image:Bereich2.Seite2@Bild.png||width="26" height="26"]]>>Bereich1.Seite1]]img.png
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
Information

Wenn Sie eine Überschrift in einem Dokument hinzufügen, wird daraus automatisch ein Anker generiert, der aus einem vorangestellem "H", gefolgt von den Buchstaben in der Überschrift gebildet wird. Beispiel: eine Überschrift "Neuer Abschnitt" erzeugt einen Anker "HNeuerAbschnitt".

XWiki Syntax 2.1 Linkspezifikation

Information

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:] 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.

FunktionXWiki Syntax 2.1Ergebnis
Standardtabelle
|=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
(% 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
{{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
Information

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

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

Bilder

2.1 Images

FunktionXWiki Syntax 2.1Ergebnis
Bild von Anhang auf aktueller Seiteimage:img.pngimg.png
Bild von Anhang auf anderer Seiteimage:Bereich.Seite@img.pngimg.png
Bild mit Parametern[[image:img.png||width="25" height="25"]]img.png
Bild befindlich an URLimage:http://eine/url/img.pngimg.png
Vordefiniertes Piktogrammimage:icon:acceptaccept

XWiki Syntax 2.1 Bild-Spezifikation

Information

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

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)