XWiki - XWiki sintakses ceļvedis 
Page of - pēdējo reizi mainījis superadmin laiks 2017/11/28 14:52 
XWiki sintakses ceļvedis 

superadmin

2017/11/28 14:52
Satura rādītājs
XWiki sintakse 2.1: Visas

  
XWiki sintakse 2.1
XWiki sintakse 2.1: Visas
�	General
�	Ievads
�	Vispārīgas piezīmes
�	Citas sintakses
�	Mainīt
�	Rindkopas
�	Virsraksti
�	Teksta noformējums
�	Horizontāla līnija
�	Saraksti
�	Definīciju saraksts
�	Pārnesumi jaunā rindā
�	Saites
�	Tabulas
�	Attēli
�	Paplašināts
�	Precīza teksta kopija
�	Citāti
�	Grupas
�	Rakstzīmju ekranēšana
�	Parametri
�	Programmēšana
�	Makrosi
�	HTML
�	Skripti

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 , bet jaunā par . 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  sintakses izpildes dzinējs un  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.  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šā  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:
Apraksts	Nepareizas 2.1 sintakses piemērs	Tiek izlabots uz sekojošu	
Neaizvērts treknraksts	**treknraksts	**treknraksts**	
Divi atsevišķi elementi, kas nav atdalīti ar tukšu rindu	| tabulas šūna
* aizzīmēts saraksts	| tabulas šūna

* aizzīmēts saraksts	
Divi atsevišķi elementi, kas nav atdalīti ar tukšu rindu	rindkopa
----
rindkopa	rindkopa

----

rindkopa	
Saturs sākas ar tukšu rindu	<tukša rinda dokumenta sākumā>
rindkopa	rindkopa	
Neaizvērts virsraksts	=== virsraksts	=== virsraksts ===	
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
Šīs sintakses pilnībā vēl netiek atbalstītas. Piemēram, pilnībā nestrādā hipersaites. Mums arī ir nepieciešams vienoties, vai mēs vēlamies šajās sintaksēs atbalstīt XWiki specifiskās lietas, piemēram, saiti uz citu subviki.
Mainīt
Rindkopas
2.0 Paragraphs
Rindkopas tiek atdalītas ar vienu vai vairāk tukšām rindām.
XWiki 2.1 sintaksē viens rindas pārnesums tiek ņemts vērā, bet XWiki 1.0 sintaksē tas netika ņemts vērā.
Piemērs	XWiki 2.1 sintakse	Rezultāts	
Vienkārša rindkopa	Šī ir rindkopa	Šī ir rindkopa	
Rindkopa vairākām rindām	Rindkopa ar
vairākām rindām	Rindkopa ar
vairākām rindām	
Divas rindkopas	1. rindkopa

2. rindkopa	1. rindkopa

2. rindkopa	
Rindkopa ar parametriem  	(% style="text-align:center;color:blue" %)
Centrēta rindkopa ar zilu tekstu	
Centrēta rindkopa ar zilu tekstu	
Virsraksti
2.0 Headings
Piemērs	XWiki 2.1 sintakse	Rezultāts	
Parasti virsraksti	= 1. līmenis =
== 2. līmenis ==
=== 3. līmenis ===
==== 4. līmenis ====
===== 5. līmenis =====
====== 6. līmenis ======	1. līmenis
2. līmenis
3. līmenis
4. līmenis
5. līmenis
6. līmenis	
Virsraksts ar parametriem  	(% style="color:blue" %)
= virsraksts =	virsraksts	
Virsraksts ar viki sintaksi	=== Virsraksts ar **treknrakstu** ===	Virsraksts ar 	
Teksta noformējums
2.0 Text Formatting
XWiki 2.1 sintakses izmaiņas attiecībā pret XWiki 1.0 sintaksi:
�	Pēc noformējuma simboliem ir atļauti tukšumi (piemēram, XWiki 1.0 sintaksē, šis teksts nebija * treknrakstā *).
�	Noformējumam tiek izmantoti dubulti simboli, līdz ar to ir samazināta iespēja, ka tie tiek izmantoti kļūdaini.
�	Iespēja turpināt sākto noformējumu vairākās rindās, kas nebija iespējams 1.0 sintaksē.
Piemērs	XWiki 2.1 sintakse	Rezultāts	
Treknraksts	**treknraksts**		
Pasvītrojums	__pasvītrojums__	pasvītrojums	
Slīpraksts	//slīpraksts//	~slīpraksts~	
Nosvītrojums	--nosvītrojums--	nosvītrojums	
Vienādplatuma	##vienādplatuma##	vienādplatuma	
Augšraksts	teksts un ^^augšraksts^^	teksts un   augšraksts	
Apakšraksts	teksts un ,,apakšraksts,,	teksts un   apakšraksts	
Horizontāla līnija
2.0 Horizontal Line
2.1 sintaksē 4 vai vairāk mīnusa zīmes.
Piemērs	XWiki 2.1 sintakse	Rezultāts	
Vienkārša horizontāla līnija	----		
Horizontāla līnija ar parametriem	(% style="color:blue" %)
----		
Saraksti
2.0 Lists
Piemērs	XWiki 2.1 sintakse	Rezultāts	
Aizzīmēts saraksts	* punkts 1
** punkts 2
*** punkts 3
* punkts 4	�	punkts 1
�	punkts 2
�	punkts 3
�	punkts 4	
Numurēts saraksts	1. punkts 1
11. punkts 2
111. punkts 3
1. punkts 4	 1.	punkts 1
 1.	punkts 2
 1.	punkts 3
 2.	punkts 4	
Jaukti saraksti	1. punkts 1
1*. punkts 2
1*. punkts 3
1. punkts 4	 1.	punkts 1
�	punkts 2
�	punkts 3
 2.	punkts 4	
Saraksts ar kvadrātiem	(% style="list-style-type: square" %)
* punkts 1
* punkts 2	�	punkts 1
�	punkts 2	
Saraksts ar aplīšiem	(% style="list-style-type: disc" %)
* punkts 1
* punkts 2	�	punkts 1
�	punkts 2	
Saraksts ar mazajiem burtiem	(% style="list-style-type: lower-alpha" %)
* punkts 1
* punkts 2	�	punkts 1
�	punkts 2	
Saraksts ar lielajiem burtiem	(% style="list-style-type: upper-alpha" %)
* punkts 1
* punkts 2	�	punkts 1
�	punkts 2	
Saraksts ar maziem romiešu cipariem	(% style="list-style-type: lower-roman" %)
* punkts 1
* punkts 2	�	punkts 1
�	punkts 2	
Saraksts ar lieliem romiešu cipariem	(% style="list-style-type: upper-roman" %)
* punkts 1
* punkts 2	�	punkts 1
�	punkts 2	
Saraksts ar maziem grieķu burtiem	(% style="list-style-type: lower-greek" %)
* punkts 1
* punkts 2	�	punkts 1
�	punkts 2	
Definīciju saraksts
2.0 Definition Lists
Piemērs	XWiki 2.1 sintakse	Rezultāts	
Parasta definīcija	; termins
: definīcija	termins
definīcija	
Iegultas definīcijas	; 1. termins
: 1. definīcija
:; 2. termins
:: 2. definīcija	1. termins
1. definīcija
2. termins
2. definīcija	
Definīcija ar parametriem	(% style="color:blue" %)
; termins
: definīcija	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.  
XWiki 2.1 sintaksē pārnesumi jaunā rindā tiek ņemti vērā, bet XWiki 1.0 sintaksē tie netiek ņemti vērā.
Piemērs	XWiki 2.1 sintakse	Rezultāts	
Rindas aplaušana	Rinda\\Jauna rinda	Rinda
Jauna rinda	
Rindas pārnesums	Rinda
Jauna rinda	Rinda
Jauna rinda	
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: 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.
Piemērs	XWiki 2.1 sintakse	Rezultāts	
Parasta tabula	|=1. Virsraksts|=2. Virsraksts
|1. vārds|2. vārds	1. Virsraksts	2. Virsraksts	
1. vārds	2. vārds	
Tabula ar parametriem	
	(% style="background-color:red;align=center" %)
|=1. Virsraksts|=(% style="background-color:yellow" %)2. Virsraksts
|1. vārds|2. vārds	1. Virsraksts	2. Virsraksts	
1. vārds	2. vārds	
Filtrējama un kārtojama tabula	
	{{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}}	
1. virsraksts	2. virsraksts	
Šūna 11	Šūna 12	
Šūna 21	Šūna 22	
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).
Piemērs	XWiki 2.1 sintakse	Rezultāts	
Precīzi attēlots teksts rindā	Teksts, kam {{{*[netiek izpildīta]*}}} sintakse	Teksts, kam *[netiek izpildīta]* sintakse	
Precīzi attēlots teksts rāmī	{{{
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).
Piemērs	XWiki 2.1 sintakse	Rezultāts	
Vienkāršs citāts	> 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?"	
Nested quotes	> Līzbete teica "pats sevi zārkā neredzēs"
>> Paulīne teica "tu saki?"
tā lūk	  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.
XWiki 2.0 sintakse	Rezultā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ā	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.
Piemērs	XWiki 2.1 sintakse	Rezultāts	
Atcelt sekojošās rakstzīmes darbību	Sekojošā nav ~[~[saite~]~]
Lai parādītu ~ rakstzīmi, to ievada 2 reizes kā ~~	Sekojošā nav [[saite]]	
Parametri
2.0 Parameters
XWiki 2.1 sintakse	Izveidotais XHTML	
(% 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:
�	 makrosus (izsauc ar komandu #makrosa_nosaukums(parametrs1 … parametrsN))
�	 makrosus (izsauc ar komandu {{makrosa_nosaukums parametrs1="vērtība1" … parametrsN="vērtībaN"}})
Piemērs	XWiki 2.1 sintakse	Rezultāts	
XWiki makross	{{code language="java"}}
System.out.println("Hello World!");
{{/code}}	System.out.println("Hello World!");	
XWiki 2.1 sintaksē nevar izmantot Radeox makrosus, tāpēc tie ir pārrakstīti kā XWiki makrosi.
Sākot ar XWiki 2.0 versiju, lai parāditu ziņojuma rāmi,   ieteicams izmantot message makrosu.
HTML
2.0 HTML
XWiki 2.1 sintaksē HTML vai XHTML elementi ir jāievada, iekļauti html makrosā, bet XWiki 1.0 sintaksē HTML elementus var iekļaut tieši viki dokumenta tekstā.
XWiki 2.1 sintakse	Rezultāts	
{{html}}<b>treknraksts</b>{{/html}}		
XWiki 2.1 sintakse pēc noklusēšanas html makrosā netiek izpildīta viki sintakse (un netiek pildīti arī citi makrosi, jo tie arī ir viki sintakses elementi). Lai to mainītu, html makrosam ir jānorāda papildu parametrs: {{html wiki="true"}}.
Skripti
2.0 Scripts
XWiki 1.0 sintaksē Velocity skriptus varēja izsaukt jebkurā viki dokumenta vietā. Tā rezultātā gadījās, ka lietotāji negribot ievadīja tekstu, kas tika izpildīts kā Velocity skripts. Tas arī palēnināja lapu parādīšanu pat tajos gadījumos, ja lapā nebija Velocity skriptu, un radīja arī citas tehniskas problēmas. Tāpēc XWiki 2.1 sintaksē Velocity skripti ir jāiekļauj, izmantojot tieši norādītu velocity makrosu. Tieši tas pats attiecas arī uz Groovy skriptiem.
Piemērs	XWiki 2.1 sintakse	
Velocity skripts	{{velocity}}
#set ($mainigais = "vērtība")
{{/velocity}}	
Groovy skripts	{{groovy}}
def mainigais = "vērtība"
{{/groovy}}