Tartalomjegyzék

Formázási szintaxis

A DokuWiki egyszerű jelölőnyelvet támogat, amely igyekszik az adatfájlokat a lehető legolvashatóbb formában tartani. Ez az oldal az összes használható szintaxist bemutatja, amelyet az oldalak szerkesztésekor alkalmazhatsz. Nézd meg ennek az oldalnak a forrását az „Oldal szerkesztése” gombbal. Ha ki szeretnél próbálni valamit, használd a homokozó oldalt. Az egyszerűbb jelölések a gyorsgombokkal is könnyen elérhetők.

Alapvető szövegformázás

A DokuWiki támogatja a félkövér, dőlt, aláhúzott és fix szélességű szöveget. Természetesen ezeket kombinálhatod is. 

A DokuWiki támogatja a **félkövér**, //dőlt//, __aláhúzott__ és ''fix szélességű'' szöveget.
Természetesen ezeket **__//''kombinálhatod''//__** is.

Használhatsz alsó indexet és felső indexet is. 

Használhatsz <sub>alsó indexet</sub> és <sup>felső indexet</sup> is.

Megjelölhetsz valamit töröltként is. 

Megjelölhetsz valamit <del>töröltként</del> is.

Bekezdések üres sorokból jönnek létre. Ha sortörést szeretnél kikényszeríteni új bekezdés nélkül, használj két fordított perjelet, amelyet szóköz vagy sorvég követ.

Ez egy szöveg néhány sortöréssel
Figyeld meg, hogy a két fordított perjel csak a sor végén
vagy szóköz előtt
működik \\enélkül nem. 

Ez egy szöveg néhány sortöréssel\\ Figyeld meg, hogy a
két fordított perjel csak a sor végén\\
vagy szóköz előtt\\ működik \\enélkül nem.

Kényszerített sortörést csak akkor használj, ha valóban szükséges.

Hivatkozások

A DokuWiki többféle módot támogat hivatkozások létrehozására.

Külső hivatkozások

A külső hivatkozásokat a rendszer automatikusan felismeri: http://www.google.com vagy egyszerűen www.google.com - A hivatkozás szövegét is megadhatod: Ez a hivatkozás a Google-ra mutat. Az ilyen e-mail-címeket is felismeri: andi@splitbrain.org. 

A DokuWiki többféle módot támogat hivatkozások létrehozására. A külső
hivatkozásokat automatikusan felismeri: http://www.google.com vagy egyszerűen
www.google.com - A hivatkozás szövegét is megadhatod:
[[http://www.google.com|Ez a hivatkozás a Google-ra mutat]]. Az ilyen
e-mail-címeket is felismeri: <andi@splitbrain.org>.

Belső hivatkozások

A belső hivatkozások szögletes zárójelekkel készülnek. Megadhatsz egyszerűen egy oldalnev értéket, vagy használhatsz külön hivatkozásszöveget is. 

A belső hivatkozások szögletes zárójelekkel készülnek. Megadhatsz egyszerűen
egy [[oldalnev]] értéket, vagy használhatsz külön
[[oldalnev|hivatkozásszöveget]] is.

A wikioldalak nevei automatikusan kisbetűssé alakulnak, speciális karakterek nem engedélyezettek.

Használhatsz nevtereket is, ha kettőspontot írsz az oldalnévbe. 

Használhatsz [[valamilyen:nevtereket]] is, ha kettőspontot írsz az oldalnévbe.

A névterek részleteiről lásd: namespaces.

Konkrét szakaszra is lehet hivatkozni. Add a szakasz nevét egy kettőskereszt után, ahogy HTML-ben is szokás. Ez a hivatkozás erre a szakaszra mutat. 

Ez a hivatkozás [[syntax#internal|erre a szakaszra]] mutat.

Megjegyzések:

Interwiki

A DokuWiki támogatja az Interwiki hivatkozásokat. Ezek gyors hivatkozások más wikikre. Például ez egy hivatkozás a Wikipédia Wikikről szóló oldalára: Wiki. 

A DokuWiki támogatja az [[doku>Interwiki]] hivatkozásokat. Ezek gyors
hivatkozások más wikikre. Például ez egy hivatkozás a Wikipédia Wikikről szóló
oldalára: [[wp>Wiki]].

Windows-megosztások

A Windows-megosztásokat, például ezt, szintén felismeri. Fontos, hogy ezeknek csak homogén felhasználói csoportban, például vállalati intraneten van értelmük. 

A Windows-megosztásokat, például [[\\server\share|ezt]], szintén felismeri.

Megjegyzések:

Képhivatkozások

Képet is használhatsz másik belső vagy külső oldalra mutató hivatkozásként, ha a hivatkozások és a képek szintaxisát kombinálod az alábbi módon: 

[[http://php.net|{{wiki:dokuwiki-128.png}}]]

Fontos: a hivatkozás nevében csak a képformázási szintaxis elfogadott.

A teljes kép- és hivatkozásszintaxis támogatott, beleértve a képméretezést, a belső és külső képeket, URL-eket és interwiki hivatkozásokat.

Lábjegyzetek

Dupla zárójelek használatával lábjegyzeteket 1) adhatsz hozzá. 

Dupla zárójelek használatával lábjegyzeteket ((Ez egy lábjegyzet)) adhatsz hozzá.

Szakaszolás

Legfeljebb öt különböző címszintet használhatsz a tartalom tagolására. Ha háromnál több címsorod van, automatikusan tartalomjegyzék készül – ezt letilthatod, ha elhelyezed a dokumentumban a ~~NOTOC~~ szöveget.

3. szintű címsor

4. szintű címsor

5. szintű címsor
==== 3. szintű címsor ====
=== 4. szintű címsor ===
== 5. szintű címsor ==

Négy vagy több kötőjellel vízszintes vonalat készíthetsz:

Képek és egyéb fájlok

Külső és belső képeket, videókat és hangfájlokat kapcsos zárójelekkel illeszthetsz be. Opcionálisan a méretüket is megadhatod.

Valódi méret:

Átméretezés adott szélességre:

Átméretezés adott szélességre és magasságra2):

Átméretezett külső kép: 

Valódi méret:                      {{wiki:dokuwiki-128.png}}
Átméretezés adott szélességre:      {{wiki:dokuwiki-128.png?50}}
Átméretezés adott szélességre és magasságra: {{wiki:dokuwiki-128.png?200x50}}
Átméretezett külső kép:             {{https://www.php.net/images/php.gif?200x50}}

Bal vagy jobb oldali szóközökkel kiválaszthatod az igazítást. 

{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}

Természetesen címet is adhatsz hozzá, amelyet a legtöbb böngésző eszköztippként jelenít meg.

Ez a képaláírás 

{{ wiki:dokuwiki-128.png |Ez a képaláírás}}

Kép másik oldalra hivatkozásáról lásd fent: kephivatkozasok.

Támogatott médiaformátumok

A DokuWiki közvetlenül be tudja ágyazni a következő médiaformátumokat.

Kép gif, jpg, png
Videó webm, ogv, mp4
Hang ogg, mp3, wav
Flash swf

Ha olyan fájlnevet adsz meg, amely nem támogatott médiaformátum, akkor hivatkozásként jelenik meg.

A ?linkonly hozzáadásával úgy adsz hivatkozást a médiára, hogy az ne jelenjen meg beágyazva. 

{{wiki:dokuwiki-128.png?linkonly}}

dokuwiki-128.png Ez csak egy hivatkozás a képre.

Tartalék formátumok

Sajnos nem minden böngésző ért minden videó- és hangformátumot. A probléma enyhítésére ugyanazt a fájlt több formátumban is feltöltheted a lehető legjobb böngészőkompatibilitás érdekében.

Például tekintsük ezt a beágyazott mp4 videót: 

{{video.mp4|Egy vicces videó}}

Ha a hivatkozott video.mp4 mellé feltöltesz egy video.webm és egy video.ogv fájlt is, a DokuWiki automatikusan alternatívaként hozzáadja őket, így a böngésződ a három fájl valamelyikét le tudja játszani.

A DokuWiki ezen felül támogat egy „poszter” képet is, amely a videó elindítása előtt jelenik meg. Ennek a képnek ugyanazt a fájlnevet kell kapnia, mint a videónak, és jpg vagy png fájlnak kell lennie. A fenti példában egy video.jpg fájl működne.

Listák

A DokuWiki támogatja a rendezett és rendezetlen listákat. Listaelem létrehozásához húzd be a szöveget két szóközzel, és használj * jelet rendezetlen listához vagy - jelet rendezett listához.

  1. Ugyanez a lista, de rendezve
  2. Egy másik elem
    1. Mélyebb szintekhez csak használj behúzást
  3. Ennyi
  * Ez egy lista
  * A második elem
    * Több szintet is használhatsz
  * Egy másik elem

  - Ugyanez a lista, de rendezve
  - Egy másik elem
    - Mélyebb szintekhez csak használj behúzást
  - Ennyi

Nézd meg a listaelemekről szóló GYIK-et is.

Szövegátalakítások

A DokuWiki bizonyos előre definiált karaktereket vagy szövegeket képekké, más szöveggé vagy HTML-lé tud alakítani.

A szövegből képpé alakítás főként hangulatjelekhez használatos. A szövegből HTML-lé alakítás tipográfiai cserékre szolgál, de más HTML használatára is beállítható.

Szövegből kép

A DokuWiki a gyakran használt hangulatjeleket grafikus megfelelőikre alakítja. Ezek a smiley-k és más képek konfigurálhatók és bővíthetők. Itt látható a DokuWikiben szereplő smiley-k áttekintése:

Szövegből HTML

Tipográfia: a DokuWiki egyszerű szöveges karaktereket tipográfiailag helyes entitásokká tud alakítani. Itt egy példa a felismert karakterekre.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® „Azt gondolta: 'Ez egy férfivilág'…” 

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"Azt gondolta: 'Ez egy férfivilág'..."

Ugyanez bármilyen HTML előállítására is használható, csak hozzá kell adni a mintafájlhoz.

Három kivétel van, amely nem ebből a mintafájlból származik: a szorzás entitás (640×480), az 'egyszeres' és a „dupla idézőjelek”. Ezek egy konfigurációs beállítással kikapcsolhatók.

Idézés

Néha meg szeretnél jelölni egy szöveget, hogy válaszként vagy megjegyzésként jelenjen meg. Ehhez a következő szintaxist használhatod: 

Szerintem meg kellene csinálnunk

> Nem, nem kellene

>> Nos, szerintem igenis meg kellene

> Tényleg?

>> Igen!

>>> Akkor csináljuk meg!

Szerintem meg kellene csinálnunk

Nem, nem kellene
Nos, szerintem igenis meg kellene
Tényleg?
Igen!
Akkor csináljuk meg!

Táblázatok

A DokuWiki egyszerű szintaxist támogat táblázatok létrehozására.

Fejléc 1 Fejléc 2 Fejléc 3
1. sor 1. oszlop 1. sor 2. oszlop 1. sor 3. oszlop
2. sor 1. oszlop többoszlopos cella (figyeld a dupla függőleges vonalat)
3. sor 1. oszlop 3. sor 2. oszlop 3. sor 3. oszlop

A táblázatsoroknak | jellel kell kezdődniük és végződniük normál soroknál, illetve ^ jellel fejlécsoroknál. 

^ Fejléc 1       ^ Fejléc 2        ^ Fejléc 3           ^
| 1. sor 1. oszlop | 1. sor 2. oszlop | 1. sor 3. oszlop |
| 2. sor 1. oszlop | többoszlopos cella (figyeld a dupla függőleges vonalat) ||
| 3. sor 1. oszlop | 3. sor 2. oszlop | 3. sor 3. oszlop |

Cellák vízszintes összekapcsolásához hagyd teljesen üresen a következő cellát, ahogy fent látható. Ügyelj arra, hogy mindig ugyanannyi cellaelválasztó legyen!

Függőleges táblázatfejlécek is lehetségesek.

Fejléc 1 Fejléc 2
Fejléc 3 1. sor 2. oszlop 1. sor 3. oszlop
Fejléc 4 most nincs colspan
Fejléc 5 2. sor 2. oszlop 2. sor 3. oszlop

Ahogy láthatod, a cella előtti elválasztó dönti el a formázást: 

|              ^ Fejléc 1             ^ Fejléc 2          ^
^ Fejléc 3     | 1. sor 2. oszlop      | 1. sor 3. oszlop  |
^ Fejléc 4     | most nincs colspan    |                    |
^ Fejléc 5     | 2. sor 2. oszlop      | 2. sor 3. oszlop  |

Függőlegesen összekapcsolt cellákat, azaz rowspaneket, úgy készíthetsz, hogy ::: értéket írsz az alatta lévő cellákba, amelyeknek a fenti cellához kell kapcsolódniuk.

Fejléc 1 Fejléc 2 Fejléc 3
1. sor 1. oszlop ez a cella függőlegesen átnyúlik 1. sor 3. oszlop
2. sor 1. oszlop 2. sor 3. oszlop
3. sor 1. oszlop 2. sor 3. oszlop

A rowspan szintaxison kívül ezek a cellák ne tartalmazzanak semmi mást. 

^ Fejléc 1       ^ Fejléc 2                         ^ Fejléc 3          ^
| 1. sor 1. oszlop | ez a cella függőlegesen átnyúlik | 1. sor 3. oszlop |
| 2. sor 1. oszlop | :::                             | 2. sor 3. oszlop |
| 3. sor 1. oszlop | :::                             | 2. sor 3. oszlop |

A táblázat tartalmát igazíthatod is. Adj legalább két szóközt a szöveg ellentétes végéhez: két szóközt balra a jobbra igazításhoz, két szóközt jobbra a balra igazításhoz, és legalább két szóközt mindkét oldalra a középre igazításhoz.

Igazított táblázat
jobbra középre balra
balra jobbra középre
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Így néz ki a forrásban: 

^           Igazított táblázat           ^^^
|         jobbra|    középre    |balra          |
|balra          |         jobbra|    középre    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Megjegyzés: a függőleges igazítás nem támogatott.

Formázás kikapcsolása

Ha pontosan úgy kell megjelenítened a szöveget, ahogy beírtad, formázás nélkül, zárd a területet <nowiki> tagek közé, vagy még egyszerűbben dupla százalékjelek közé: %%.

Ez egy szöveg, amely ilyen címeket tartalmaz: http://www.splitbrain.org és **formázást**, de semmi nem történik vele. Ugyanez igaz erre is: //__ez__ a szöveg// egy smiley-val ;-). 

<nowiki>
Ez egy szöveg, amely ilyen címeket tartalmaz: http://www.splitbrain.org és **formázást**, de semmi nem történik vele.
</nowiki>
Ugyanez igaz erre is: %%//__ez__ a szöveg// egy smiley-val ;-)%%.

Kódblokkok

Kódblokkokat úgy illeszthetsz a dokumentumokba, hogy legalább két szóközzel behúzod őket, ahogy az előző példáknál is látható, vagy a <code> illetve <file> tageket használod. 

Ez a szöveg két szóközzel be van húzva.
Ez előformázott kód, minden szóköz megmarad: például              <-így
Ez nagyjából ugyanaz, de használhatod annak jelzésére, hogy egy fájlt idéztél.

Ezek a blokkok ebből a forrásból jöttek létre: 

  Ez a szöveg két szóközzel be van húzva.
<code>
Ez előformázott kód, minden szóköz megmarad: például              <-így
</code>
<file>
Ez nagyjából ugyanaz, de használhatod annak jelzésére, hogy egy fájlt idéztél.
</file>

Szintaxiskiemelés

A DokuWiki ki tudja emelni a forráskódot, így az könnyebben olvasható. Ehhez a GeSHi általános szintaxiskiemelőt használja, ezért bármely GeSHi által támogatott nyelv támogatott. A szintaxis az előző szakaszban bemutatott code és file blokkokat használja, de ezúttal a kiemelendő nyelv neve is bekerül a tagbe, például <code java> vagy <file java>. 

/**
 * A HelloWorldApp osztály egy olyan alkalmazást valósít meg,
 * amely egyszerűen kiírja a "Hello World!" szöveget a szabványos kimenetre.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); // Kiírja a szöveget.
    }
}

A következő nyelvi azonosítók jelenleg felismertek: 4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots roff rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql sshconfig standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch wolfram xbasic xml xojo xorg_conf xpp yaml z80 zxbasic

A szintaxiskiemeléshez további haladó beállítások is elérhetők, például sorok kiemelése vagy sorszámok hozzáadása.

Letölthető kódblokkok

Ha a fenti <code> vagy <file> szintaxist használod, előfordulhat, hogy a megjelenített kódot letölthetővé is szeretnéd tenni. Ezt úgy teheted meg, hogy a nyelvkód után fájlnevet adsz meg: 

<file php myexample.php>
<?php echo "hello world!"; ?>
</file>
myexample.php
<?php echo "hello world!"; ?>

Ha nem szeretnél kiemelést, de letölthető fájlt igen, adj meg kötőjelet (-) nyelvkódként: <code - myfile.foo>.

RSS/ATOM feedek összesítése

DokuWiki külső XML feedekből származó adatokat is be tud építeni. Az XML feedek feldolgozásához a SimplePie használatos. Minden SimplePie által értett formátum használható a DokuWikiben is. A megjelenítést több további, szóközzel elválasztott paraméterrel befolyásolhatod:

Paraméter Leírás
bármilyen szám a megjelenítendő elemek maximális száma, alapértelmezés szerint 8
reverse először a feed utolsó elemeit jeleníti meg
author megjeleníti az elemek szerzőinek nevét
date megjeleníti az elemek dátumát
description megjeleníti az elem leírását. Minden HTML tag eltávolításra kerül
nosort nem rendezi a feed elemeit
n[dhm] frissítési időköz, ahol d=nap, h=óra, m=perc. Például 12h = 12 óra.

A frissítési időköz alapértelmezés szerint 4 óra. A 10 percnél kisebb értékeket 10 percként kezeli. A DokuWiki általában megpróbálja egy oldal gyorsítótárazott változatát kiszolgálni, de ez nyilván nem megfelelő, ha az oldal dinamikus külső tartalmat tartalmaz. A paraméter azt mondja meg a DokuWiki számára, hogy renderelje újra az oldalt, ha az utolsó renderelés óta több idő telt el, mint a frissítési időköz.

Alapértelmezés szerint a feed dátum szerint rendeződik, a legújabb elemekkel elöl. A reverse paraméterrel a legrégebbieket teheted előre, a nosort paraméterrel pedig a feedet változatlan sorrendben jelenítheted meg.

Példa: 

{{rss>http://slashdot.org/index.rss 5 author date 1h }}

Vezérlő makrók

Bizonyos szintaxisok úgy befolyásolják a DokuWiki oldalgenerálását, hogy önmagukban nem hoznak létre kimenetet. A következő vezérlő makrók érhetők el:

Makró Leírás
~~NOTOC~~ Ha ez a makró megtalálható az oldalon, nem készül tartalomjegyzék
~~NOCACHE~~ A DokuWiki alapértelmezés szerint minden kimenetet gyorsítótáraz. Néha ez nem kívánatos, például amikor a fenti <php> szintaxis használatos; ennek a makrónak a hozzáadása minden megnyitáskor újrarenderelésre kényszeríti az oldalt

Szintaxis bővítmények

A DokuWiki szintaxisa bővítményekkel bővíthető. A telepített bővítmények használatát a hozzájuk tartozó leíróoldalak ismertetik. Ebben a konkrét DokuWiki telepítésben a következő szintaxisbővítmények érhetők el:

1)
Ez egy lábjegyzet
2)
ha a megadott szélesség és magasság képaránya nem egyezik a képével, akkor a képet az új arányra vágja, mielőtt átméretezné