Generella operationer:
Logga in
Registrera
Wiki: Main wiki ▼: Dokumentindex
»
Rum: XWiki ▼: Dokumentindex
»
Sida: XWikiSyntax
Sök
default lv sv de it
Sidoperationer:
Exportera ▼: Exportera som PDF Exportera som RTF Exportera som HTML
Fler operationer ▼: Förhandsgranskning av utskrift Visa wikikod
Startsida » XWiki-rum » XWiki Syntaxes

# XWiki Syntaxes

Senast ändrad av Administrator den 2012/03/21 17:40
Kommentarer (0) · Notiser (0) · Bilagor (1) · Historik · Information
Innehåll

- Anmärkningar
- Stycken
- Rubriker
- Textformatering
- Horisontell linje
- Listor
- Definitionslistor
- Radbrytning
- Länkar
- Tabeller
- Bilder
- Ej formaterad text
- Citering
- Gruppering
- Kontrollsekvenser för wikisymboler
- Makron
- HTML
- Velocity/Groovy-skript
- Parametrar
- Andra syntaxer

Med början på XWiki enterprise version 1.7 och senare har en ny wikisyntax, kallad XWiki syntax v2.0, introducerats som efterföljare till XWiki syntax v1.0. De huvudsakliga anledningarna för den nya syntaxen är:

- Fixa begränsningarna och tvetydigheterna som finns i XWiki 1.0 syntaxen (som byggde både på Radeox - den underliggande renderingsmotorn - och TWiki).
  - Symbolvalen var inte bra. Exempelvis användes en asterisk för att ange fetstil. Detta orsakade problem då användare matade in text som innehöll asterisker eftersom texten felaktigt antogs vara fetstil. Således används åtminstone dubbla symboler överallt i wikisyntaxen.
  - Tvetydigheter fanns exempelvis då en rad inleddes med en asterisk. Var det då fetstil eller en punktlista? Detta var nödvändigt att lösa för att möjliggöra en deterministisk WYSIWYG-editor.
- För att närma sig Creole 1.0 syntaxen vilken håller på att bli standard för wikisyntax. Sammanslutningen bakom Creole har dessutom noggrant analyserat alla existerande wikisyntaxer innan de valt symboler. Symbolvalen är därför väldigt bra.

Sedan introduktionen av XWiki syntax 2.0 har några begränsningar upptäckts. För att åtgärda dessa har den experimentella syntaxen XWiki syntax 2.1 introducerats i XWiki Enterprise version 3.0. Anledningarna att denna nya syntax utvecklats är:

- Harmonisera länk- och bild-syntaxerna för tydlighetens och konsekvensens skull och för att förbättra påbyggnadsmöjligheterna.
- Möjligheten att visa ikoner, att länka till filer med UNC-notation och att länka till relativa URL:er.

Eftersom XWiki syntax 2.1 bygger på XWiki syntax 2.0 gäller all syntax från XWiki syntax 2.0 om inte annat anges i specifikationen för 2.1.

Utöver syntaxändringarna har vi också bytt ut den underliggande renderingsmotorn (vilken tidigare var Radeox) till förmån för vår egen motor som bygger på Wikimodel och Doxia (och möjligen andra i framtiden). Detta låter oss tillhandahålla andra syntaxer i wikin: MediaWiki, Confluence, JSPWiki, Creole, TWiki m.fl.

# Anmärkningar

XWiki syntax v2.0 rättar bl.a. de fel och tvetydigheter som exemplifieras i tabellen nedan.

Beskrivning | Exempel på ogiltig eller tvetydig syntax | Fixad XWiki syntax 2.0
--- | --- | ---
Ej avslutad stil | `**fetstil` | `**fetstil**`
Två fristående element som ej särskiljs av två nyradstecken | `| tabellcell` `* listelement` | `| tabellcell` `* listelement`
Två fristående element ej separerade av två nyradstecken | `stycke` `----` `stycke` | `stycke` `----` `stycke`
Nyradstecken i början av dokumentet | <nyradstecken i början av dokumentet> stycke | stycke
Ej avslutad rubriksyntax | `=== rubrik` | `=== rubrik ===`

# Stycken

Stycken är textelement som separeras av två eller flera nyradstecken.

I XWiki syntax 2.0 är nyradstecken signifikanta, vilket inte är fallet i XWiki syntax 1.0 och i Creole.

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat XWiki syntax 1.0 | Resultat XWiki syntax 2.0
--- | --- | --- | --- | ---
Stycke | This is a paragraph | Detta är ett stycke | Detta är ett stycke | Detta är ett stycke
Flerradigt stycke | Stycke med`\\` flera rader | Stycke med flera rader | Stycke med flera rader | Stycke med flera rader
Två stycken | Stycke ett Stycke två | Stycke ett Stycke två | Stycke ett Stycke två | Stycke ett Stycke två
Parametriserade stycken | <p style="text-align:center;color:blue">Centrerat stycke med blå text</p> | `(% style="text-align:center;color:blue" %)` Centrerat stycke med blå text | Centrerat stycke med blå text | Centrerat stycke med blå text

# Rubriker

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat
--- | --- | --- | ---
Standardrubriker | 1 nivå 1 1.1 nivå 2 1.1.1 nivå 3 1.1.1.1 nivå 4 1.1.1.1.1 nivå 5 1.1.1.1.1.1 nivå 6 |
    = nivå 1 =
    == nivå 2 ==
    === nivå 3 ===
    ==== nivå 4 ====
    ===== nivå 5 =====
    ====== nivå 6 ======
| # nivå 1 ## nivå 2 ### nivå 3 #### nivå 4 ##### nivå 5 ###### nivå 6
Parametriserade rubriker | <h1><span style="color:blue">rubrik</span></h1> | `(% style="color:blue" %)` = rubrik = | # rubrik
Rubriker med wikisyntax | 1.1.1 Rubrik med *fetstil* | `=== Rubrik med **fetstil** ===` | ### Rubrik med fetstil

# Textformatering

Nytt i XWiki syntax 2.0 jämfört med XWiki syntax 1.0:

- Blanktecken är tillåtna omedelbart efter syntaxsymbolerna (i XWiki syntax 1.0 var exempelvis * detta inte fetstil *).
- Användning av symboldubblering där det var enkla symboler i XWiki syntax 1.0 för att minska risken att användarna av misstag lägger in textformatering.
- Möjlighet att låta formatering sträcka sig över flera rader.

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat
--- | --- | --- | ---
Fetstil | `*fetstil*` | `**fetstil**` | fetstil
Understruken | `__understruken___` | `__understruken__` | understruken
Kursiv | `~~kursiv~~` | `//kursiv//` | kursiv
Genomstruken | `--genomstruken--` | `--genomstruken--` | genomstruken
Fastbredd | <tt>fastbredd</tt> | `##fastbredd##` | `fastbredd`
Upphöjd | lite <sup>upphöjd text</sup> | `lite ^^upphöjd text^^` | lite upphöjd text
Nedsänkt | lite <sub>nedsänkt text</sub> | `lite ,,nedsänkt text,,` | lite nedsänkt text

# Horisontell linje

En linje består av minst fyra bindestreck.
Notera skillnaden mot Creole där exakt fyra bindestreck krävs.

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat
--- | --- | --- | ---
Horisontell linje | `----` | `----` |
Parametriserad horisontell linje | <hr style="color:blue"/> |
    (% style="color:blue" %)
    ----

# Listor

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat
--- | --- | --- | ---
Punktlista |
    * element 1
    ** element 2
    *** element 3
    * element 4
    * element 1
    ** element 2
    *** element 3
    * element 4
| element 1 element 2 element 3 element 4
Numrerad lista |
    1. element 1
    11. element 2
    111. element 3
    1. element 4
    1. element 1
    11. element 2
    111. element 3
    1. element 4
| element 1 element 2 element 3 element 4
Blandad lista |
    1. element 1
    1*. element 2
    1*. element 3
    1. element 4
    1. element 1
    1*. element 2
    1*. element 3
    1. element 4
| element 1 element 2 element 3 element 4
Kvadratmarkerad lista |
    - element 1
    - element 2
    (% style="list-style-type: square" %)
    * element 1
    * element 2
| element 1 element 2
Diskmarkerad lista | <ul style="list-style-type: disc"> <li>element1</li> <li>element2</li> </ul> |
    (% style="list-style-type: disc" %)
    * element 1
    * element 2
| element 1 element 2
Alfabetisk lista av gemener |
    a. element 1
    a. element 2
    (% style="list-style-type: lower-alpha" %)
    * element1
    * element2
| element1 element2
Alfabetisk lista av versaler |
    A. element 1
    A. element 2
    (% style="list-style-type: upper-alpha" %)
    * element1
    * element2
| element1 element2
Romerska siffror av gemener |
    i. element 1
    i. element 2
    (% style="list-style-type: lower-roman" %)
    * element1
    * element2
| element1 element2
Romerska siffror av versaler |
    I. element 1
    I. element 2
    (% style="list-style-type: upper-roman" %)
    * element1
    * element2
| element1 element2
Grekiska gemener |
    g. element 1
    g. element 2
    (% style="list-style-type: lower-greek" %)
    * element1
    * element2
| element1 element2
Grekiska versaler |
    G. element 1
    G. element 2
    (% style="list-style-type: upper-greek" %)
    * element1
    * element2
| element1 element2
Hiragana |
    h. element 1
    h. element 2
    (% style="list-style-type: hiragana" %)
    * element1
    * element2
| element1 element2
Hiragana iroha |
    H. element 1
    H. element 2
    (% style="list-style-type: hiragana-iroha" %)
    * element1
    * element2
| element1 element2
Katakana |
    k. element 1
    k. element 2
    (% style="list-style-type: katakana" %)
    * element1
    * element2
| element1 element2
Katakana iroha |
    K. element 1
    K. element 2
    (% style="list-style-type: katakana-iroha" %)
    * element1
    * element2
| element1 element2
Armenisk lista |
    <ul style="list-style-type: armenian">
      <li>element1</li>
      <li>element2</li>
    </ul>
    (% style="list-style-type: armenian" %)
    * element1
    * element2
| element1 element2
Hebreisk lista |
    j. element1
    j. element2
    (% style="list-style-type: hebrew" %)
    * element1
    * element2
| element1 element2
Georgisk lista |
    <ul style="list-style-type: georgian">
      <li>element1</li>
      <li>element2</li>
    </ul>
    (% style="list-style-type: georgian" %)
    * element1
    * element2
| element1 element2
CJK ideografisk lista |
    <ul style="list-style-type: cjk-ideographic">
      <li>element1</li>
      <li>element2</li>
    </ul>
    (% style="list-style-type: cjk-ideographic" %)
    * element1
    * element2
| element1 element2

# Definitionslistor

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat
--- | --- | --- | ---
Vanlig definition |
    <dl>
      <dt>term</dt>
      <dd>definition</dd>
    </dl>
    ; term
    : definition
| term definition
Nästlade definitioner |
    <dl>
      <dt>term1</dt>
      <dd>definition1
        <dl>
          <dt>term2</dt>
          <dd>definition2</dd>
        </dl>
      </dd>
    </dl>
    ; term1
    : definition1
    :; term2
    :: definition2
| term1 definition1 term2 definition2
Parametriserade definitioner |
    <dl style="color:blue">
      <dt>term</dt>
      <dd>definition</dd>
    </dl>
    (% style="color:blue" %)
    ; term
    : definition
| term definition

# Radbrytning

En radbrytning tvingar fram ny rad och kan stå var som helst i en text.

I XWiki syntax 2.0 är nyradstecken signifikanta, vilket inte är fallet i XWiki syntax 1.0 och i Creole-syntax.

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat med XWiki syntax 1.0 | Resultat med XWiki syntax 2.0
--- | --- | --- | --- | ---
Radbrytning | `Rad\\Ny rad` | `Rad\\Ny rad` | Rad Ny rad | Rad Ny rad
Ny rad | Rad Ny rad | Rad Ny rad | Rad Ny rad | Rad Ny rad

# Länkar

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat med XWiki syntax 1.0 | Resultat med XWiki syntax 2.0
--- | --- | --- | --- | ---
Länk till sida i aktuellt rum | `[WebHome]` | `[[WebHome]]` | Web Home | WebHome
Länk med etikett | `[etikett>WebHome]` | `[[etikett>>WebHome]]` | etikett | etikett
Länk med wikisyntax i etikett | `<a href="$xwiki.getURL("WebHome")"><strong>fetstilad etikett</strong></a>` | `[[**fetstilad etikett**>>WebHome]]` | fetstilad etikett | fetstilad etikett
Länk till en sida i specificerat rum | `[Main.WebHome]` | `[[Main.WebHome]]` | Web Home | WebHome
Länk till underwiki | `[underwiki:Main.WebHome]` | `[[underwiki:Main.WebHome]]` | Web Home | WebHome
Länk som öppnas i nytt fönster | `[etikett>WebHome>_blank]` | `[[etikett>>WebHome||rel="__blank"]]` | etikett | etikett
Länk till URL direkt i text | `Detta är en URL: http://xwiki.org` | `Detta är en URL: http://xwiki.org` | Detta är en URL: http://xwiki.org | Detta är en URL: http://xwiki.org
Länk till en URL | `[http://xwiki.org]` | `[[http://xwiki.org]]` | http://xwiki.org | http://xwiki.org
Etiketterad länk till URL | `[XWiki>http://xwiki.org]` | `[[XWiki>>http://xwiki.org]]` | XWiki | XWiki
Länk till e-postadress | `[sven@svensson.se>mailto:sven@svensson.se]` | `[[sven@svensson.se>>mailto:sven@svensson.se]]` | sven@svensson.se | sven@svensson.se
Bildlänk | `<a href="$xwiki.getURL("Rum1.Sida1")">{image:img.png|document=Rum2.Sida2}</a>` | `[[image:Rum2.Sida2@img.png>>Rum1.Sida1]]` |  |
Bildlänk med bildparametrar | `<a href="$xwiki.getURL("Rum1.Sida1")">{image:img.png|document=Rum2.Sida2|width=26|height=26}</a>` | `[[[[image:Rum2.Sida2@img.png||width="26" height="26"]]>>Rum1.Sida1]]` |  |
Länk till bilaga på aktuell sida | Se Bilagemakrot för detaljer `{attach:text|file=img.png`} | `[[text>>attach:img.png]]` | text | text
Länk till bilaga på annan sida | Se Bilagemakrot för detaljer `{attach:text|document=Rum.Sida|file=img.png`} | `[[text>>attach:Rum.Sida@img.png]]` | text | text

## XWiki syntax 1.0 Länkspecifikation

Delarna angivna inom `( )` är obligatoriska, delarna angivna inom `[ ]` får utelämnas en av de två angivna tecknen angivna inom `{ }` måste anges om motsvarande valfria del angivits.

Det fullständiga formatet för en länk är `[etikett {| eller >}]+(resurs)(@interWikiAlias)+({| eller >} mål)+`

- `etikett`: En sträng som visas som länknamn. Kan utelämnas. Exempel: `Min sida`.
- `resurs`: Den fullständiga länkadressen på följande syntax: `(referens) [?querySträng] [#ankare]`
  - `referens`: Länkreferensen som kan vara en av
    - En URI på formen `protokoll:sökväg` (exempel: `http://xwiki.org`, `mailto:sven@svensson.se`), eller
    - Referens till en wikisida på formen `[[wikiNamn:] rum.] (sida)`. Exempel: `WebHome`, `Main.WebHome`, `minwiki:Main.WebHome`
      - `wikiNamn`: En sträng som anger namnet på en virtuell wiki. Länken pekar på en sida inuti motsvarade virtuella wiki. Kan utelämnas. Exempel: `minwiki`.
      - `rum`: Ett rumsnamn. Om inget rum anges används aktuellt rum. Exempel: `Main`.
      - `sidae`: En obligatorisk sträng som anger namnet på den länkade wikisidan. Exempel: `WebHome`
  - `querySträng`: En query-sträng, vilken kan utelämnas. Används för att ange parametrar till URLen. Exempel: `"mindata1=5&amp;mindata2=Hej"`.
  - `ankare`: Ett ankarnamn (vilket får utelämnas) som pekar på en ankardefinition på sidan som refereras av länken. I XWiki skapas ankare automatiskt för varje rubrik bestående av bokstaven H (som i engelskans heading) följt av rubriknamnet. De svenska bokstäverna å, ä och ö utelämnas alltid ur ankarnamnet. Detta gäller även för alla tecken som ej är bokstäver eller siffror, exempelvis blanktecken, punk och komma. En länk till sektionen XWiki syntax 1.0 Länkspecifikation kan alltså skapas via ankaret `HXWikisyntax10Lnkspecifikation`.
- `interWikiAlias`: Ett Inter-wiki-alias (vilket får utelämnas) som är definierat i interwikikartan (se Administrationsguiden). Exempel: `wikipedia`
- `mål`: En fakultativ sträng som motstvarar `target`-attributet för ett `A`-element i HTML. Om denna utelämnas öppnas länken i aktuellt fönster eller tabb. Exempel: `_self`, `_blank`.

## XWiki syntax 2.0 Länkspecification

Delarna inom `( )` är obligatoriska och delarna inom `[ ]` får utelämnas.

Det fullständiga formatet för en länk är `[etikett>>] (resurs) [@interWikiAlias] [||parametrar]`

- `etikett`: En utelämningsbar sträng som visas som länktext då sidan renderas. Etiketten får inehålla wikiformattering. Om ingen etikett anges kommer en länktext att automatgenereras. Mönstret för den automatgenererade texten kan ställas in. Se Administrationsguiden. Exempel: `Min Sida`
- `resurs`: Den fullständiga länkreferensen på följande syntax: `(referens) [?querySträng] [#ankare]`
  - `referens`: Länkreferensen på en av följande format:
    - URL: En URL på formatet `protokoll://sökväg`. Exempel: `http://xwiki.org`, `https://svn.xwiki.org/`
    - Wikisida på formen `[[wikiNamn:] rum.] (sida)`. Exempel: `WebHome`, `Main.WebHome`, `mywiki:Main.WebHome`
      - `wikiNamn`: En sträng (vilken kan utelämnas) som anger namnet på den virtuella wikin. Länken kommer att peka på en sida inuti den namngivna wikin. Exempel: `minwiki`
      - `rum`: Ett rum i wikin. Om inget anges används det aktuella rummet, dvs samma rum som sidan som innehåller länken. Exempel: `Main`
      - `sida`: Namnet på den länkade sidan. Exempel: `WebHome`
    - Bilaga på formatet `attach: [wikisidnamn@] (bilagenamn)`. Exempel: `attach:img.png`, `attach:minwiki:Main.WebHome@img.png`
      - `attach:`: Den sträng som identifierar resursen som en bilaga. (Från engelskans "attachment" vilket betyder "bilaga".)
      - `wikisidnamn`: En sträng vilken kan utelämnas som refererar till det dokument bilagan tillhör. Se punkten "wikisida" ovan.
      - `bilagenamn`: Namnet på själva bilagan. (Notera att XWiki ibland ändrar filnamnet på filer som laddas upp som bilaga.)
    - E-postadress på formatet `mailto: (e-postadress)` (`#ankare` får ej användas här). Exempel: `mailto:sven@svensson.se`
      - `mailto:`: Den sträng som identifierar resursen som en e-postadress. (Från engelskans "mail to" vilket betyder "e-brev till".)
      - `epostadress`: Den e-postadress som skall vara mål för länken. Exempel: "`sven@svensson.se`"
  - `querySträng`: En query-sträng (vilken får utelämnas) som anger parametrar som skall vara med i den renderade URL:en. Exempel: `mindata1=5&mindata2=Hej`
  - `ankare`: Ett ankarnamn (vilket får utelämnas) som pekar på en ankardefinition på sidan som refereras av länken. I XWiki skapas ankare automatiskt för varje rubrik bestående av bokstaven H (som i engelskans heading) följt av rubriknamnet. De svenska bokstäverna å, ä och ö utelämnas alltid ur ankarnamnet. Detta gäller även för alla tecken som ej är bokstäver eller siffror, exempelvis blanktecken, punk och komma. En länk till sektionen XWiki syntax 2.0 Länkspecifikation kan alltså skapas via ankaret `HXWikisyntax20Lnkspecifikation`.
- `interWikiAlias`: Ett Inter-wiki-alias (vilket får utelämnas) som är definierat i interwikikartan (se Administrationsguiden). Exempel: `wikipedia`
- `parameters`: En utelämningsbar lista med parametrar till länken. Exempel: `rel="__blank"` (öppna i nytt fönster)

## XWiki syntax 2.1 länkspecifikation

Delarna inom `( )` är obligatoriska och delarna inom `[ ]` får utelämnas.

Det fullständiga formatet för en länk är `[etikett>>] (resurs) [||parametrar]`

- `etikett`: En utelämningsbar sträng som visas som länktext då sidan renderas. Etiketten får inehålla wikiformattering. Om ingen etikett anges kommer en länktext att automatgenereras. Mönstret för den automatgenererade texten kan ställas in. Se Administrationsguiden. Exempel: `Min Sida`
- `resurs`: En obligatorisk sträng med länkreferensen på en av följande former:
  - URL: En URL på formatet `[url:] protokoll://sökväg`. Exempel: `http://xwiki.org`, `url:https://svn.xwiki.org/`
    - `url:` En sträng (vilken får utelämnas) som identifierar resursen som en URL.
    - Wikisida på formen `[doc:] [[wikiNamn:] rum.] (sida)`. Exempel: `WebHome`, `Main.WebHome`, `mywiki:Main.WebHome`
    - `doc:` En sträng (vilken får utelämnas) som identifierar resursen som en wikisida.
    - `wikiNamn`: En sträng (vilken kan utelämnas) som anger namnet på den virtuella wikin. Länken kommer att peka på en sida inuti den namngivna wikin. Exempel: `minwiki`
    - `rum`: Ett rum i wikin. Om inget anges används det aktuella rummet, dvs samma rum som sidan som innehåller länken. Exempel: `Main`
    - `sida`: Namnet på den länkade sidan. Exempel: `WebHome`
  - InterWiki-sidnamn på formen `interwiki: `(interWikiAlias:)` (sida)`. Exempel: `interwiki:wikipedia:XWiki`
    - `interwiki:` En obligatorisk sträng som identifierar resursen som en InterWiki-länk.
    - `interWikiAlias`: Ett Inter-wiki-alias (vilket får utelämnas) som är definierat i interwikikartan (se Administrationsguiden). Exempel: `wikipedia`
    - `sida`: En obligatorisk sträng som anger namnet på den länkade sidan. Example: `XWiki`
  - Bilaga på formatet `attach: [wikisidnamn@] (bilagenamn)`. Exempel: `attach:img.png`, `attach:minwiki:Main.WebHome@img.png`
    - `attach:`: Den sträng som identifierar resursen som en bilaga. (Från engelskans "attachment" vilket betyder "bilaga".)
    - `wikisidnamn`: En sträng vilken kan utelämnas som refererar till det dokument bilagan tillhör. Se punkten "wikisida" ovan.
    - `bilagenamn`: Namnet på själva bilagan. (Notera att XWiki ibland ändrar filnamnet på filer som laddas upp som bilaga.)
  - E-postadress på formatet `mailto: (e-postadress)` (`#ankare` får ej användas här). Exempel: `mailto:sven@svensson.se`
    - `mailto:`: Den sträng som identifierar resursen som en e-postadress. (Från engelskans "mail to" vilket betyder "e-brev till".)
    - `epostadress`: Den e-postadress som skall vara mål för länken. Exempel: "`sven@svensson.se`"
  - Relativ sökväg på servern på formatet `path: (sökväg)`. Exempel: `path:$doc.getURL('reset')` producerar måladressen `http://server.domän.se/xwiki/bin/reset/Rum/Sida` where `/xwiki/bin/reset/Rum/Sida` produceras av `$doc.getURL('reset')`.
    - `path:` En obligatorisk sträng som identifierar resursen som en relativ sökväg. (Från engelskans "path", vilket betyder "sökväg".)
    - `sökväg`: En obligatorisk sträng som anger den på servern relativa sökvägen till resursen som skall länkas.
  - UNC på formen `unc: (sökväg)`. Länken renderas som en `file://`-länk. Exempel: `unc:C:\Windows\`, `unc:\\minserver\path\img.png`, `unc:home/user/nånfil`
    - `sökväg`: En obligatorisk sträng som anger lokal resurs för användaren. Exempel: `C:\Windows\`, `\\minserver\sökväg\img.png`, `home/user/nånfil`
- `parameters`: En utelämningsbar lista separerad med blankstegstecken med parametrar till länken. Exempel: `queryString="mindata1=5&mindata2=Hej" anchor="HTableOfContents" rel="__blank"`
  - `queryString`: En query-sträng (vilken får utelämnas) som anger parametrar som skall vara med i den renderade URL:en. Exempel: `url:http://domän.com/sökväg||queryString="mindata1=5&mindata2=Hej"` producerar måladressen `http://domän.com/sökväg?mindata1=5&mindata2=Hej`
  - `anchor`: Ett ankarnamn (vilket får utelämnas) som pekar på en ankardefinition på sidan som refereras av länken. I XWiki skapas ankare automatiskt för varje rubrik bestående av bokstaven H (som i engelskans heading) följt av rubriknamnet. De svenska bokstäverna å, ä och ö utelämnas alltid ur ankarnamnet. Detta gäller även för alla tecken som ej är bokstäver eller siffror, exempelvis blanktecken, punk och komma. En länk till sektionen XWiki syntax 2.1 Länkspecifikation kan alltså skapas via ankaret `HXWikisyntax21Lnkspecifikation`. Exempel: `url:http://domän.com/sökväg||anchor="HTableOfContents"` producerar måladressen `http://domän.com/sökväg#HTableOfContents`
  - `rel`: En parameter (som får utelämnas) som anger hur länken skall öppnas. Exempel: `rel="__blank"` (öppnar länken i nytt fönster)

# Tabeller

I XWiki syntax är det relativt enkelt att skapa tabeller. Det går också att ange parametrar för enskilda celler och rader i XWiki syntax 2.0

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat
--- | --- | --- | ---
Standardtabell | `((( {table} Titel 1 | Titel 2 Ord 1 | Ord 2 {table} )))` |
    |=Titel 1|=Titel 2
    |Ord 1 |Ord 2
eller
    !=Titel 1!=Titel 2
    !!Ord 1!!Ord 2
Titel 1 | Titel 2
--- | ---
Ord 1 | Ord 2
Parametriserad tabell | <table style="background-color:red;align:center"> <tbody> <tr> <td>Titel 1</td> <td style="background-color:yellow">Titel 2</td> </tr> <tr> <td>Ord 1</td> <td>Ord 2</td> </tr> </tbody> </table> |
    (% style="background-color:red;align=center" %)
    |=Titel 1|=(% style="background-color:yellow" %)Titel 2
    |Ord 1|Ord 2
Titel 1 | Titel 2
--- | ---
Ord 1 | Ord 2
Filtrerbar och sorterbar tabell |
    $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>Titel1</th>
        <th>Titel2</th>
      </tr>
      <tr>
       <td>Cell11</td>
       <td>Cell12</td>
      </tr>
      <tr>
       <td>Cell21</td>
       <td>Cell22</td>
      </tr>
    </table>
För mer avancerade funktionalitet, se Livetable-makrot. |
    {{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
    |Cell 11|Cell 12
    |Cell 21|Cell 22
För mer avancerade funktionalitet, se Livetable-makrot. |
Titel 1 | Titel 2
--- | ---
Cell 11 | Cell 12
Cell 21 | Cell 22

# Bilder

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat
--- | --- | --- | ---
Bild från bilaga till aktuell sida | Se bildmakrot för detaljer `{image:img.png`} | `image:img.png` |
Bild från bilaga i annat dokument | `{image:img.png|document=Rum.Sida`} | `image:Rum.Sida@img.png` |
Bild med parametrar | `{image:img.png|width=25|height=25`} | `[[image:img.png||width="25" height="25"]]` |
Bild från URL | `http://some/url/img.png` | `image:http://some/url/img.png` |

## XWiki Syntax 2.0 bildspecifikation

Delarna inom `( )` är obligatoriska och delarna inom `{ }` får utelämnas.

Det fullständiga formatet för bilder är antingen `image: (referens)` eller `[[image: (referens) {||parametrar}]]`

- `image:` En obligatorisk sträng som identifierar resursen som en bild.
- `referens`: Referensen till bilden som skall visas på ett av följande format:
  - URL: En URL till en bild på formatet `http://sökväg/bildnamn`. Exempel: `http://domän.org/sökväg/bild.png`
  - Bilaga referens på formatet `{{{wikinamn:} rum.} sida@} (bildnamn)`
    - `wikiNamn`: En sträng (vilken kan utelämnas) som anger namnet på den virtuella wikin. Bildreferensen kommer att peka på en bild inuti den namngivna wikin. Exempel: `minwiki`
    - `rum`: Ett rum i wikin. Om inget anges används det aktuella rummet, dvs samma rum som sidan som innehåller länken. Exempel: `Main`
    - `sida`: En sträng (vilken kan utelämnas) som anger namnet på sidan som bildbilagan tillhör. Exempel: `WebHome`
    - `bildnamn`: En obligatorisk sträng som anger namnet på bildbilagan. (Notera att XWiki ibland ändrar filnamnet på filer som laddas upp som bilaga.)
- `parametrar`: En utelämnings bar lista separerad av blankstegstecken med parametrar till bilden. Exempel: `width="800" height="600" alt="img.png" title="Min fina bild"`
  - HTML-attribut: Alla attribut definierade i HTML-standarden för taggen `<img>` kan användas.
    - `style`: CSS-stilinformation som skall appliceras på bilden. Exempel: `style="float:right;height:50"` (bilden till höger, höjd 50 pixlar), `style="style="display:block;margin-left:auto;margin-right:auto;width:80%"` (bilden centrerad, bredd 80% av blockbredden), `style="vertical-align:bottom"` (texten ställs i linje med bildens nederkant)
    - `height`: Parameter som anger höjden på bilden vid visning. Värdet kan anges antingen i pixlar (exempel: `height="80"`) eller relativt höjden på bildens omgivande block (exempel: `height="40%"`).
    - `width`: Parameter som anger bredden på bilden vid visning. Värdet kan anges antingen i pixlar (exempel: `height="80"`) eller relativt bredden på bildens omgivande block (exempel: `height="40%"`).
    - `title`: Parameter som anger texten som blir synlig då muspekaren hålls över bilden. Exempel: `title="Min fina bild"`
    - `alt`: Parameter som anger ersättningstext om webbläsaren ej kan visa bilder. Eftersom denna parameter är obligatorisk i HTML kommer XWiki att använda filnamnet istället om denna parameter utelämnas. Exempel: `alt="img.png"`
    - Mer: En mer omfattande beskrivning av HTML-taggen `<img>` inklusive fler attribut kan man läsa om på w3.org.

## XWiki Syntax 2.1 Image Specification

Delarna inom `( )` är obligatoriska och delarna inom `{ }` får utelämnas.

Det fullständiga formatet för bilder är antingen `image: (referens)` eller `[[image: (referens) {||parametrar}]]`

- `image:` En obligatorisk sträng som identifierar resursen som en bild.
- `referens`: Referensen till bilden som skall visas på ett av följande format:
  - URL: En URL till en bild på formatet `http://sökväg/bildnamn`. Exempel: `http://domän.org/sökväg/bild.png`
  - Bilaga referens på formatet `{{{wikinamn:} rum.} sida@} (bildnamn)`
    - `wikiNamn`: En sträng (vilken kan utelämnas) som anger namnet på den virtuella wikin. Bildreferensen kommer att peka på en bild inuti den namngivna wikin. Exempel: `minwiki`
    - `rum`: Ett rum i wikin. Om inget anges används det aktuella rummet, dvs samma rum som sidan som innehåller länken. Exempel: `Main`
    - `sida`: En sträng (vilken kan utelämnas) som anger namnet på sidan som bildbilagan tillhör. Exempel: `WebHome`
    - `bildnamn`: En obligatorisk sträng som anger namnet på bildbilagan. (Notera att XWiki ibland ändrar filnamnet på filer som laddas upp som bilaga.)
  - Ikon referens på formatet ``(icon:)` (ikonnamn)`. Exempel: `icon:accept`
    - `icon:` En obligatorisk sträng som identifierar bildreferensen som en ikon från XWikis ikonsamling.
    - `ikonnamn`: En obligatorisk sträng som anger namnet på ikonen. Exempel: `accept`
- `parametrar`: En utelämnings bar lista separerad av blankstegstecken med parametrar till bilden. Exempel: `width="800" height="600" alt="img.png" title="Min fina bild"`
  - HTML-attribut: Alla attribut definierade i HTML-standarden för taggen `<img>` kan användas.
    - `style`: CSS-stilinformation som skall appliceras på bilden. Exempel: `style="float:right;height:50"` (bilden till höger, höjd 50 pixlar), `style="style="display:block;margin-left:auto;margin-right:auto;width:80%"` (bilden centrerad, bredd 80% av blockbredden), `style="vertical-align:bottom"` (texten ställs i linje med bildens nederkant)
    - `height`: Parameter som anger höjden på bilden vid visning. Värdet kan anges antingen i pixlar (exempel: `height="80"`) eller relativt höjden på bildens omgivande block (exempel: `height="40%"`).
    - `width`: Parameter som anger bredden på bilden vid visning. Värdet kan anges antingen i pixlar (exempel: `height="80"`) eller relativt bredden på bildens omgivande block (exempel: `height="40%"`).
    - `title`: Parameter som anger texten som blir synlig då muspekaren hålls över bilden. Exempel: `title="Min fina bild"`
    - `alt`: Parameter som anger ersättningstext om webbläsaren ej kan visa bilder. Eftersom denna parameter är obligatorisk i HTML kommer XWiki att använda filnamnet istället om denna parameter utelämnas. Exempel: `alt="img.png"`
    - Mer: En mer omfattande beskrivning av HTML-taggen `<img>` inklusive fler attribut kan man läsa om på w3.org.
  - `queryString`: Det går även att ange parametrar till nedladdningslänken för bilden. Exempel: `queryString="width=100&height=800&keepAspectRatio=true"` (`keepAspectRatio=true` kommer att misslyckas om både `width`- och `height`-parametrarna specificerats utöver `queryString`!)

# Ej formaterad text

Det går att ange att text ej skall formateras av wiki syntaxen, dvs, symbolerna för wikisyntax kommer att visas istället för att texten formateras.

I XWiki syntax 1.0 Pre-makrot bevarar endast wiki syntax och Radeox makron. HTML-kod och Groovy- och Velocity-skript exekveras fortfarande.

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat i XWiki syntax 1.0 | Resultat i XWiki syntax 2.0
--- | --- | --- | --- | ---
Ej formaterad text inuti formaterad text | `Lite {pre}*[ej renderat]*{/pre} innehåll` | `Lite {{{**[[ej renderat]]**}}} innehåll` | Lite `*[ej renderat]*` innehåll | Lite `**[[ej renderat]]**` innehåll
Block av ej formaterad text | `{pre} flerradigt *ej renderat* innehåll {/pre}` Man kan även använda kodmakrot, men det visar sitt inehåll i en box, om inget annat anges. |
    {{{
    flerradigt
    **ej renderat**
    innehåll
    }}}
    flerradigt
    *ej renderat*
    innehåll
    flerradigt
    **ej renderat**
    innehåll

# Citering

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat
--- | --- | --- | ---
Citat | <blockquote><p>Anna sade detta</p></blockquote> Jag sade ok |
    > Anna sade detta
    Jag sade ok
| Anna sade detta Jag sade ok
Nestlade citat | <blockquote><p>Anna sade detta</p> <blockquote><p>Lina svarade detta</p></blockquote> </blockquote> Jag sade ok |
    > Anna sade detta
    >> Lina svarade detta
    Jag sade ok
| Anna sade detta Lina svarade detta Jag sade ok

# Gruppering

Gruppering kan användas för att infoga kompexa element i löpande text. Exempelvis för att infoga ett dokument i löpande text, eller komplexa element inuti listor eller tabellceller. Gruppering markeras med följande syntaktiska symboler: ``(((...)))``. En gruppering kan innehålla en annan gruppering.

XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat
--- | --- | ---
XWiki syntax 1.0 saknar grupperingsmöjligheter. Man måste använda sig av HTML för att åstadkomma motsvarande resultat. |
    |=Titel 1|=Titel 2|=Titel 3
    |Cell ett|(((
    = Inbäddat dokument

    Ett inbäddat stycke

    * listelement ett
    * listelement två
      ** underelement 1
      ** underelement 2
    ))) | Cell tre

    Fortsättningen på toppnivådokumentet
Titel 1 | Titel 2 | Titel 3
--- | --- | ---
Cell ett | # Inbäddat dokument Ett inbäddat stycke listelement ett listelement två underelement 1 underelement 2 | Cell tre
Fortsättningen på toppnivådokumentet

# Kontrollsekvenser för wikisymboler

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat XWiki syntax 1.0 | Resultat XWiki syntax 2.0
--- | --- | --- | --- | ---
Kontrollsekvens för enstaka tecken | `Detta är inte en \[länk\]` | `Detta är inte en ~[~[länk~]~]` För att generera ett ~-tecken använd två ~-tecken: `~~` | `Detta är inte en [länk]` | `Detta är inte en [[länk]]`

# Makron

Det finns två typer av makron i XWiki syntax 1.0:

- Velocity-makron, vilka anropas med syntaxen `#makronamn(parameter1 ... parameterN)`.
- Radeox-makron, vilka anropas med syntaxen `{makronamn:parameter1=värde1|...|parameterN=värdeN}`.

Det finns även två typer av makron i XWiki syntax 2.0:

- Velocity-makron, vilka anropas med syntaxen `#makronamn(parameter1 ... parameterN)`# inuti XWiki-makrot "velocity".
- XWiki-makron, vilka anropas med syntaxen ``{{makronamn parameter1="värde1" ... parameterN="värdeN"`}}`.

Radeox-makron kan ej användas i XWiki syntax 2.0 och har därför skrivits om som XWiki-makron.
En fullständig lista över tillgängliga makron finns på makroreferenssidan.

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0
--- | --- | ---
Velocity-makro |
    #info("Lite text")
    {{info}}
    Lite text
    {{/info}}
Radeox-makron/XWiki-makron |
    {code:java}
    javakod
    {code}
    {{code language="java"}}
    javakod
    {{/code}}

# HTML

I XWiki syntax 2.0 HTML eller XHTML måste anges inuti HTML-makrot. I XWiki syntax 1.0 är det möjligt att ange HTML direkt i texten.

XWiki syntax 1.0 | XWiki syntax 2.0 | Resultat
--- | --- | ---
<b>fetstil</b> | `{{html}}<b>fetstil</b>{{/html`}} | fetstil

I XWiki syntax 2.0, tolkas ej wikisyntax (ej heller andra makron, eftersom makron är wikisyntax) inuti HTML-makrot om inget annat anges. Ange `{{html wiki="true"`}} för att slå på tolkning av wikisyntax.

# Velocity/Groovy-skript

In XWiki syntax 1.0 är det möjligt att ange Velocity-skript var som helst på en wikisida. Detta medför problem då en användar oavsiktligen matar in Velocity-kod. Dessutom renderas sidor som ej innehåller Velocity-kod långsammare än nödvändigt. Det medför även andra tekniska begränsningar. Således måste Velocity-skript avgränsas med hjälp av `velocity`-makrot i XWiki syntax 2.0. Detsamma gäller för Groovy-skript som måste anges med hjälp av `groovy`-makrot.

Formateringstyp | XWiki syntax 1.0 | XWiki syntax 2.0
--- | --- | ---
Velocity-skript |
    #set ($var = "något värde")
    {{velocity}}
    #set ($var = "något värde")
    {{/velocity}}
Groovy-skript |
    <%
    def var = "något värde"
    %>
    {{groovy}}
    def var = "något värde"
    {{/groovy}}

# Parametrar

Med XWiki syntax 2.0 är det möjligt att ange parametrar till syntaktiska element och textblock. Detta används exempelvis för att ändra stil på elementen. Det går att ange nyckel/värde-par så att XHTML-renderaren infogar motsvarande attribut i den underliggande XHTML-representationen av syntaxelementen. I XWiki syntax 1.0 finns det ingen syntax för att ange parametrar utan XHTML-koden måste matas in direkt såsom illustreras nedan.

XWiki syntax 1.0 | XWiki syntax 2.0 | Genererad XHTML
--- | --- | ---
    <h1 class="minKlass" style="minStil" id="mittId">rubrik</h1>
    (% class="minKlass" style="minStil" id="mittId" %)
    = rubrik =
    <h1 class="myClass" style="minStil" id="mittId">rubrik</h1>

# Andra syntaxer

Följande syntaxer finns implementerade i XWiki enterprise 1.6 och senare:

- JSPWiki
- MediaWiki
- Confluence
- TWiki
- Creole 1.0
- XHTML 1.0

Implementationen för dessa syntaxer är ej kompletta ännu. Länkar fungerar exempelvis inte alltid som förväntat. Vi måste även bestämma om syntaxerna skall utökas för att stödja XWiki-specifik funktionalitet såsom möjligheten att länka till en annan virtuell wiki.
Taggar:
Skapad av Administrator den 2008/02/20 11:36
Översatt till sv av Administrator den 2008/02/20 11:36

- Kommentarer (0)
- Notiser (0)
- Bilagor (1)
- Historik
- Information

Copyright 2004-2026 XWiki
4.0-milestone-1