XWiki Syntaxes

Versiju izmaiņas

Sākot ar XWiki Enterprise versiju 1.7 ir ieviesta jauna viki sintakse. Līdz ar to, vecā viki sintakse tiek saukta par XWiki 1.0 sintaksi, bet jaunā par XWiki 2.0 sintaksi. Galvenie jaunās sintakses ieviešanas cēloņi bija:

• Novērst 1.0 versijas ierobežojumus un nenoteiktību (kuru cēlonis bija līdz tam izmantotais Radeox sintakses izpildes dzinējs un TWiki sintakse).
  • Neoptimāls kontroles simbolu pielietojums. Piemēram zvaigznītes simbols, kas tika izmantots trenknraksta apzīmēšanai. Bieži vien lietotāji ievietoja viki lapās gatavu tekstu ar zvaigznītēm un tāpēc vietām teksts tika parādīts treknrakstā, lai gan lietotāji to nevēlējās. Tāpēc, lai minimizētu ievietota teksta izskata salaušanu, jaunajā sintaksē visi kontroles simboli ir vismaz dubultā.
  • Nenoteiktība. Atkal kā piemēru var minēt zvaigznītes, kas apzīmē gan treknrakstu, gan aizzīmētu sarakstu. Nenoteiktības bija nepieciešams novērst, lai varētu izstrādāt noformējuma redaktoru, kas darbojas stingri determinēti.
• Nepieciešamība tuvināties Creole 1.0 sintaksei, kas iedibinās par standarta viki sistēmu sintaksi. Creole izstrādes komūna ir veikusi visu vadošo viki sistēmu sintaksi analīzi un salīdzināšanu, izvēloties ērtākos un izplatītākos apzīmējumus. Mūsu 1.0 versijā ieviestā sintakse ne visur bija tāda.

Papildus šīm divām XWiki sintaksēm mēs bijušā Radeox dzinēja vietā esam ieviesuši īpašu sintakses apstrādes infrastruktūru, kas apstrādā  Wikimodel, Doxia un nākotnē iespējams arī citus modeļus. Tas mums ļauj izmantot arī citas viki sintakses kā MediaWiki, Confluence, JSPWiki, Creole, TWiki un citas.

Vispārīgas piezīmes

XWiki 2.0 sintakse automātiski izlabo dažas aizmāršības kļūdas, ko nevarēja izdarīt izmantojot 1.0 sintaksi, piemēram:

Rindkopas

Rindkopas tiek atdalītas ar vienu vai vairāk tukšām rindām.

Virsraksti

= 1. līmenis =
== 2. līmenis ==
=== 3. līmenis ===
==== 4. līmenis ====
===== 5. līmenis =====
====== 6. līmenis ======

Teksta noformējums

Horizontāla līnija

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

Saraksti

* punkts 1
** punkts 2
*** punkts 3
* punkts 4

* punkts 1
** punkts 2
*** punkts 3
* punkts 4

1. punkts 1
11. punkts 2
111. punkts 3
1. punkts 4

1. punkts 1
11. punkts 2
111. punkts 3
1. punkts 4

1. punkts 1
1*. punkts 2
1*. punkts 3
1. punkts 4

1. punkts 1
1*. punkts 2
1*. punkts 3
1. punkts 4

- punkts 1
- punkts 2

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

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

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

a. punkts 1
a. punkts 2

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

A. punkts 1
A. punkts 2

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

i. punkts 1
i. punkts 2

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

I. punkts 1
I. punkts 2

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

g. punkts 1
g. punkts 2

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

Definīciju saraksts

<dl>
<dt>termins</dt>
<dd>definīcija</dd>
</dl>

; termins
: definīcija

<dl>
<dt>1. termins</dt>
<dd>1. definīcija
<dl>
<dt>2. termins</dt>
<dd>2. definīcija</dd>
</dl>
</dd>
</dl>

; 1. termins
: 1. definīcija
:; 2. termins
:: 2. definīcija

<dl style="color:blue">
<dt>termins</dt>
<dd>definīcija</dd>
</dl>

(% style="color:blue" %)
; termins
: definīcija

Pārnesumi jaunā rindā

Pārnesumu jaunā rindā veido ar jaunas rindas simbolu (Enter taustiņu), rindas aplaušanu ievada ar kontroles simboliem. 

Saites

Piemērs	XWiki 1.0 sintakse	XWiki 2.0 sintakse	Rezultāts XWiki 1.0 sintaksē	Rezultāts XWiki 2.0 sintaksē
Saite uz lapu tekošajā vietā	[WebHome]	[[WebHome]]	Web Home	WebHome
Saite ar nosaukumu	[nosaukums>WebHome]	[[nosaukums>>WebHome]]	nosaukums	nosaukums
Saite uz lapu norādītā vietā	[Main.WebHome]	[[Main.WebHome]]	Web Home	WebHome
Saite uz subviki	[subwiki:Main.WebHome]	[[subwiki:Main.WebHome]]	Web Home	WebHome
Saite, kas atveras jaunā lapā	[nosaukums>WebHome>_blank]	[[nosaukums>>WebHome||rel="__blank"]]	nosaukums	nosaukums
Saite uz URL atklātā tekstā	Šis ir URL: http://xwiki.org	Šis ir URL: http://xwiki.org	Šis ir URL: http://xwiki.org	Šis ir URL: http://xwiki.org
Saite uz URL	[http://xwiki.org]	[[http://xwiki.org]]	http://xwiki.org	http://xwiki.org
Saite uz URL ar nosaukumu	[XWiki>http://xwiki.org]	[[XWiki>>http://xwiki.org]]	XWiki	XWiki
Saite uz e-pastu	[janis@test.lv>mailto:janis@test.lv]	[[janis@test.lv>>mailto:janis@test.lv]]	janis@test.lv	janis@test.lv
Saite ar attēlu	<a href="$xwiki.getURL("Vieta1.Lapa1")">{image:attels.png|document=Vieta2.Lapa2}</a>	[[image:Vieta2.Lapa2@attels.png>>Vieta1.Lapa1]] Saišu nosaukumos ir atļauta viki sintakse
Saite uz pielikumu	Skatīt papildu informāciju par Attach makrosu. {attach:pielikums|file=attels.png}	[[pielikums>>attach:attels.png]]	pielikums	pielikums

XWiki 1.0 saišu sintakse

Pilnais saites formāts ir: (nosaukums[|>])+(saite)(@citaVikiAliase)+([|>]mērķis)+

• nosaukums: neobligāts saites nosaukums, kas tiek parādīts lietotājam gala tekstā, piemēram, "Mana lapa".
• saite: Saite, kas tiek norādīta sekojošā veidā: (virtuālāVikiAliase+(vieta.)+(reference)(?pieprasījums)+(#enkurs)+
• Ņemiet vērā, ka saite vai nosaukums ir jānorāda obligāti.
  • virtuālāVikiAliase: neobligāts virtuālā viki nosaukums (ja tiek izmantoti virtuālie viki). Saite norādīs uz norādīto virtuālo viki, piemēram, "mansviki".
  • vieta: Neobligāts viki vietas nosaukums. Ja vietu nenorāda, tiek izmantota tekošā vieta. Piemērs: "Main".
  • reference: Saites reference. Tā var būt URI formā protokols:ceļš (piemēram: "http://xwiki.org", "mailto:john@smith.com") vai arī viki lapas nosaukums(piemēram: "WebHome").
  • pieprasījums: Neobligāts vietrāža (URL) pieprasījums aiz jautājuma zīmes. Piemēram: "?parametrs_1=5&parametrs_2=Sveiki".
  • enkurs: Neobligāts vietas nosaukums mērķa lapā (enkurs). Ņemiet vērā, ka XWiki automatiski izveido enkurus priekš virsrakstiem. Piemēram: "TableOfContentAnchor".
• citaVikiAliase: Neobligāta cita viki aliase, kas definēta InterWiki sarakstā (skatiet Administratora rokasgrāmatu). Piemēram: "vikipēdija"
• mērķis: Neobligāts HTML mērķa atribūts ko izmanto HTML saites a elementā. Šo parametru izmanto, apstrādājot saiti. Pēc noklusēšanas to atver tekošajā logā. Piemēri: "_self", "_blank"

XWiki 2.0 saišu sintakse

Pilnais saites formāts ir: (nosaukums>>)?(saite)(||parametri)*

• nosaukums: saites nosaukums. Var saturēt viki sintaksi
• saite: saites mērķis, t.i. vieta, kas tiks atvērta, kad uz saites uzklikšķina. Tās sintakse ir līdzīga XWiki 1.0 sintaksei, un tā var būt arī norāde uz mailto: un attach:, lai attiecīgi norādītu uz e-pasta adresi vai lapas pielikumu.
• parametri: Neobligāts vietrāža (URL) pieprasījums aiz jautājuma zīmes. Piemēram: "parametrs_1=5&parametrs_2=Sveiki".

Tabulas

Viki tabulas ļauj vienkāršā veidā attēlot saturu tabulas formā. Tiek atbalstīti arī tabulu parametri, row or cell in XWiki 2.0 sintakse.

|=1. Virsraksts|=2. Virsraksts
|1. vārds|2. vārds

<table style="background-color:red;align:center">
<tbody>
<tr>
<td>1. Virsraksts</td>
<td style="background-color:yellow">2. Virsraksts</td>
</tr>
<tr>
<td>1. vārds</td>
<td>2. vārds</td>
</tr>
</tbody>
</table>

(% style="background-color:red;align=center" %)
|=1. Virsraksts|=(% style="background-color:yellow" %)2. Virsraksts
|1. vārds|2. vārds

$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>1. virsraksts</th>
<th>2. virsraksts</th>
</tr>
<tr>
<td>Šūna 11</td>
<td>Šūna 12</td>
</tr>
<tr>
<td>Šūna 21</td>
<td>Šūna 22</td>
</tr>
</table>

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

{{html}}
<table id="tableid" class="grid sortable filterable doOddEven">
<tr class="sortHeader">
<th>1. virsraksts</th>
<th>2. virsraksts</th>
</tr>
<tr>
<td>Šūna 11</td>
<td>Šūna 12</td>
</tr>
<tr>
<td>Šūna 21</td>
<td>Šūna 22</td>
</tr>
</table>
{{/html}}

Attēli

Piemērs	XWiki 1.0 sintakse	XWiki 2.0 sintakse	Rezultāts
Attēls no pielikuma tekošajā lapā	Papildu informācijai skatīt Image makrosa aprakstu. {image:attels.png}	image:attels.png
Attēls no pielikuma citā lapā	{image:attels.png|document=Vieta.Lapa}	image:Vieta.Lapa@attels.png
Attēls ar parametriem	{image:attels.png|width=25|height=25}	[[image:attels.png||width="25" height="25"]]
Attēls ar URL atrašanās vietuImages located at URL	http://some/url/attels.png	image:http://some/url/attels.png

Precīza teksta kopija

Precīza teksta kopijas iezīme ļauj attēlot tekstu tieši tādu, kāds tas ir ievadīts (citiem vārdiem sakot, šim tekstam netiek izpildīta viki sintakse).

{pre}
Daudzu rindu
*precīzi*
attēlots teksts
{/pre}

{{{
Daudzu rindu
*precīzi*
attēlots teksts
}}}

Daudzu rindu
*precīzi*
attēlots teksts

Daudzu rindu
*precīzi*
attēlots teksts

Citāti

Citāti ļauj ievietot īpaši noformētus citātus (teksta kopijas, uz ko atsaukties).

> Līzbete teica "pats sevi zārkā neredzēs"
Paulīne teica "tu saki?"

> Līzbete teica "pats sevi zārkā neredzēs"
>> Paulīne teica "tu saki?"
tā lūk

Grupas

Grupas var izmantot, lai ievietotu citu dokumentu iekļautu tekošajā dokumentā. Piemēram, grupas ļauj iekļaut sarežģītus teksta elementus tabulas šūnā vai aizzīmēta saraksta ierakstā. Grupas atdala ar sekojošiem atdalītājiem: (((...))). Vienā grupā var ievietot citu grupu un grupu iekļaušanas dziļums nav limitēts.

|=1. Virsraksts|=2. Virsraksts|=3. Virsraksts
|1. šūna|(((
= Iegults dokuments

Iegulta teksta rindkopa.

* saraksta 1. punkts
* saraksta 2. punkts
** saraksta 1. apakšpunkts
** saraksta 2. apakšpunkts
))) | 3. šūna

Nākošā rindkopa augšējā līmeņa dokumentā

Rakstzīmju ekranēšana

Viki tekstā iespējams atcelt (ekranēt) atsevišķas rakstzīmes, kuras normālā gadījumā tiek uzskatītas par kontroles simboliem, kas pārveido teksta stilu, izveido saiti u.tml.

Sekojošā nav ~[~[saite~]~]

Makrosi

XWiki 1.0 sintaksē var iekļaut divu veidu makrosus (izpildāmas komandas):

• Velocity makrosus (izsauc ar komandu #makrosa_nosaukums(parametrs1 … parametrsN))
• Radeox makrosus (izsauc ar komandu {makrosa_nosaukums:parametrs1=vērtība1|...|parametrsN=vērtībaN})

Arī XWiki 2.0 sintaksē var iekļaut divu veidu makrosus:

• Velocity makrosus (izsauc ar komandu #makrosa_nosaukums(parametrs1 … parametrsN))
• XWiki macros (called using the {{makrosa_nosaukums parametrs1="vērtība1" … parametrsN="vērtībaN"}})

#info("Kāds teksts")

{{velocity}}{{html}}
#info("Kāds teksts")
{{/html}}{{/velocity}}

{code:java}
java kods
{code}

{{code language="java"}}
java kods
{{/code}}

HTML

Velocity/Groovy skripti

#set ($mainigais = "vērtība")

{{velocity}}
#set ($mainigais = "vērtība")
{{/velocity}}

<%
def mainigais = "vērtība"
%>

{{groovy}}
def mainigais = "vērtība"
{{/groovy}}

Parametri

XWiki 2.0 sintaksē iespējams norādīt parametrus, dažādiem sintakses elementiem un teksta daļām. Piemēram, ar parametriem var mainīt teksta stilu (noformējumu). Iespējams norādīt jebkuru parametru nosaukuma un vērtības pāri. Šie parametri un to vērtības tiek nodoti XHTML dzinējam, kas no tiem izveidos atbilstošus XHTML atribūtus, kas, ievērojot norādīto stilu, tiks ņemti vērā pārlūkprogrammā. XWiki 1.0 sintaksē īpaša parametru norādīšanas veida nebija, un priekš tam bija jāizmanto tieši norādīts HTML saturs.

<h1 class="manaKlase" style="mansStils" id="mansId">header</h1>

(% class="manaKlase" style="mansStils" id="mansId" %)
= header =

<h1 class="manaKlase" style="mansStils" id="mansId">header</h1>

Citas sintakses

Sākot ar XWiki Enterprise 1.6 ir atbalstītas arī sekojošas sintakses:

• JSPWiki
• Media Wiki
• Confluence
• TWiki
• Creole 1.0
• XHTML 1.0