XWiki Syntax Hilfe

Zuletzt geändert von superadmin am 2024/04/07 08:25

FunktionXWiki Syntax 2.1Ergebnis
Link zu Seite im aktuellen Bereich[[WebHome]]XWiki
Link mit Linktext

[[Linktext>>WebHome]]
XWiki 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: https://xwiki.orgDies ist eine URL: https://xwiki.org
Link zu einer URL[[https://xwiki.org]]https://xwiki.org
Link zu einer URL mit Linktext[[XWiki>>https://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

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

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:{{{(wikiName):}(spaceNameListe).}(seitenName)@}(anhangsName)
      • attach: Eine erforderliche Zeichenfolge, die die Referenz als XWiki-Dokumentanhang identifiziert.
      • wikiName: Eine optionale Zeichenfolge, die den Namen eines Wikis enthält. Die Bildreferenz zeigt auf ein Bild, das an eine Seite innerhalb dieses Wikis angehängt ist. Wenn kein Wiki angegeben ist, wird das aktuelle Wiki verwendet. Beispiel: mywiki.
      • spaceNameListe: Eine optionale, durch Punkte getrennte Liste von Wiki-Bereichs-Namen. Wenn kein Bereich angegeben ist, wird der aktuelle Bereich verwendet. Beispiele: Main, A.B, A.B.C
      • seitenName: Eine optionale Zeichenfolge, die den Namen der Wiki-Seite enthält, an die das referenzierte Bild angehängt ist. Beispiel: Welcome
      • 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:~myserverpathimg.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, ~myserverpathimg.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. In XWiki werden Anker automatisch für Überschriften und Bilder erstellt. 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"