XWiki sintakse 2.1

General

Ievads

2.1 Introduction

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

2.0 General Remarks

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

Citas sintakses

1.0 Other Syntaxes

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

Mainīt

Rindkopas

2.0 Paragraphs

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

Virsraksti

2.0 Headings

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

Teksta noformējums

2.0 Text Formatting

Horizontāla līnija

2.0 Horizontal Line

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

Saraksti

2.0 Lists

* punkts 1
** punkts 2
*** punkts 3
* 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

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

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

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

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

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

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

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

Definīciju saraksts

2.0 Definition Lists

; termins
: definīcija

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

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

Pārnesumi jaunā rindā

2.0 New Line Line Breaks

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

Saites

2.1 Links

Piemērs	XWiki 2.1 sintakse	Rezultāts
Saite uz lapu tekošajā vietā	[[WebHome]]	XWiki
Saite ar nosaukumu	[[nosaukums>>WebHome]]	nosaukums
Saite uz lapu norādītā vietā	[[Main.WebHome]]	Main
Saite uz subviki	[[subwiki:Main.WebHome]]	Main
Saite, kas atveras jaunā lapā	[[nosaukums>>WebHome||rel="__blank"]]	nosaukums
Saite uz URL atklātā tekstā	Šis ir URL: http://xwiki.org	Šis ir URL: http://xwiki.org
Saite uz URL	[[http://xwiki.org]]	http://xwiki.org
Saite uz URL ar nosaukumu	[[XWiki>>http://xwiki.org]]	XWiki
Saite uz e-pastu	[[janis@test.lv>>mailto:janis@test.lv]]	janis@test.lv
Saite ar attēlu	[[image:Vieta2.Lapa2@attels.png>>Vieta1.Lapa1]] Saišu nosaukumos ir atļauta viki sintakse
Saite uz pielikumu	[[pielikums>>attach:attels.png]]	pielikums

XWiki 2.1 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: queryString="parametrs_1=5&parametrs_2=Sveiki" anchor="HTableOfContents" rel="__blank".

Tabulas

2.0 Tables

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

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

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

{{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

2.1 Images

Piemērs	XWiki 2.0 sintakse	Rezultāts
Attēls no pielikuma tekošajā lapā	image:attels.png
Attēls no pielikuma citā lapā	image:Vieta.Lapa@attels.png
Attēls ar parametriem	[[image:attels.png||width="25" height="25"]]
Attēls ar URL atrašanās vietuImages located at URL	image:http://some/url/attels.png
Icône	image:icon:accept

Paplašināts

Precīza teksta kopija

2.0 Verbatim

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).

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

Daudzu rindu
*precīzi*
attēlots teksts

Citāti

2.0 Quotations

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

2.0 Groups

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

2.0 Escapes

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~]~]

Parametri

2.0 Parameters

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

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

Programmēšana

Makrosi

2.0 Macros

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

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

{{code language="java"}}
System.out.println("Hello World!");
{{/code}}

HTML

2.0 HTML

Skripti

2.0 Scripts

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

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