wiki:syntax

Opmaakregels (syntax)

DokuWiki ondersteunt eenvoudige opmaakregels om gegevensbestanden zo leesbaar mogelijk te maken. Deze pagina bevat alle mogelijke regels die u kunt gebruiken om uw teksten vorm te geven. Kijk naar de broncode van deze pagina door op de knop Pagina aanpassen bovenaan- of onderaan deze pagina te klikken. Als u iets wilt uitproberen, gebruik dan de playgroundplugin-autotooltip__default plugin-autotooltip_bigZandbak

Hier kunt u experimenteren met de syntax-pagina. In de editor zijn opmaakregels ook makkelijk te verkrijgen via sneltoetsen.

Basis tekstopmaak

DokuWiki ondersteunt vet, cursief, onderstreept en monospaced teksten. Uiteraard kunt u al deze mogelijkheden combineren. 

DokuWiki ondersteunt **vetgedrukt**,
//cursief//, __onderstreept__ en ''monospaced''  teksten. 
Uiteraard kunt u al deze mogelijkheden **__//''combineren''//__**.

U kunt ook subscript en superscript gebruiken. 

U kunt ook <sub>subscript</sub> en <sup>superscript</sup> gebruiken.

U kunt ook iets als verwijderd aangeven. 

U kunt ook iets als <del>verwijderd</del> aangeven.

Paragrafen worden gemaakt door witregels (de return toets gebruiken). Als u een nieuwe regel wilt beginnen maar geen nieuwe paragraaf gebruikt u twee backslashes aan het eind van de regel.

Dit is een stukje tekst met wat afbrekingen.
Let er op dat de backslashes alleen aan het eind van een zin herkend worden of als zij gevolgd worden
door een spatie. \\Dit gebeurt er zonder spatie. 

Dit is een stukje tekst met wat afbrekingen.\\
Let er op dat de backslashes alleen\\ aan het eind van een zin herkend 
worden of als zij gevolgd worden door een spatie. \\Dit gebeurt er zonder
spatie.

Gebruik geforceerde nieuwe regels alleen bij uitzondering.

Links

DokuWiki ondersteunt meerdere manieren om een link te maken.

Externe

Externe links worden ‘automagisch’ herkend: http://www.google.com of simpelweg www.google.com.

U kunt een link ook een naam geven: Deze link wijst naar Google. E-mailadressen zoals deze: andi@splitbrain.org worden ook herkend. 

Externe links worden ‘automagisch’ herkend: http://www.google.com 
of simpelweg www.google.com. U kunt een link ook een naam geven: 
[[http://www.google.com|Deze link wijst naar Google]]. 
E-mailadressen zoals deze: <andi@splitbrain.org> worden ook herkend.

Interne

Interne links worden gemaakt door vierkante haken [[ ]] te gebruiken. U kunt een pagename gebruiken of een linktekst toevoegen. 

Interne links worden gemaakt door vierkante haken ''%%[[ ]]%%'' 
te gebruiken. U kunt een [[pagename]] gebruiken 
of een [[pagename|linktekst]] toevoegen.

Wiki-paginanamen worden automatisch geconverteerd naar kleine letters; bijzondere tekens zijn niet toegestaan.

Je kunt namespaces gebruiken door een dubbelepunt in de paginanaam. 

Je kunt [[enige:namespaces]] gebruiken door een dubbelepunt in de 
paginanaam.

Voor details over namespaces zie namespaces

Linken naar een specifieke sectie is ook mogelijk. Voeg gewoon de alineanaam toe achter een hekje (hashtag) zoals bekend uit HTML. Dit linkt naar deze sectie. 

Dit linkt naar [[nl:wiki:syntax#interne|deze sectie]].

Opmerkingen:

  • Links naar een bestaande pagina hebben een andere stijl dan niet bestaande links.
  • DokuWiki gebruikt standaard geen CamelCase om automatisch links te maken, maar dit gedrag kan aangezet worden door in de config-instellingen. Tip: Als DokuWiki een link is, dan staat het aan.
  • Als een sectietitel wordt gewijzigd, wijzigt de link naar de sectie ook. Dus vertrouw niet teveel op alinealinks.

Interwiki

DokuWiki ondersteunt Interwiki-links. Dat zijn snelle links naar andere Wiki's. Dit is bijvoorbeeld een link naar Wikipedia's pagina over Wiki's: Wiki. 

DokuWiki ondersteunt [[doku>interwiki|Interwiki]]-links. Dat zijn snelle 
links naar andere Wiki's. Dit is bijvoorbeeld een link naar Wikipedia's 
pagina over Wiki's: [[wpnl>Wiki]].

Windows shares

Windows shares als deze worden ook herkend. Let er op dat deze alleen zin hebben in een homogene gebruikersgroep zoals een bedrijfsIntranet. 

Windows shares als [[\\server\share|deze]] worden ook herkend.

Opmerkingen:

  • Om veiligheidsredenen functioneert direct browsen op bijvoorbeeld een intranet als standaard uitsluitend in Microsoft Internet Explorer (en enkel in de 'locale zone').
  • Voor Mozilla en Firefox kan het geactiveerd worden door een suggestie uit de Mozilla Knowledge Base. Echter, er zal nog steeds een JavaScript-waarschuwing gegeven worden bij het openen van een Windows Share. Om deze waarschuwing te verwijderen (voor alle gebruikers), moet je de volgende regel in conf/userscript.js plaatsen:
LANG.nosmblinks = '';

Afbeeldingslinks

U kunt ook een afbeelding gebruiken om naar een interne of externe pagina te linken door de syntax voor links en afbeeldingen (zie hieronder) te combineren. 

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

Let op: linken naar een afbeelding is de enige opmaak toegestaan in linknamen.

De gehele afbeelding en link syntax wordt ondersteund (inclusief vergroten/verkleinen, interne of externe afbeeldingen, URL's en interwiki links).

Voetnoten

U kunt voetnoten1) toevoegen door dubbele haakjes te gebruiken. 

U kunt voetnoten((Dit is een voetnoot)) toevoegen door dubbele haakjes te gebruiken.

In secties verdelen

U kunt uw materiaal tot in vijf verschillende niveaus verdelen om deze te structureren. Als u meer dan drie koppen gebruikt (Headlines 5, 4 en 3) wordt automatisch een inhoudsopgave aangemaakt - dit kan uitgeschakeld worden door het commando ~~NOTOC~~ in het document in te voegen.

Headline Level 3

Headline Level 4

Headline Level 5
==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==

Plaatsen van lijnen

Door tenminste vier koppeltekens ( - ) achter elkaar te plaatsen ontstaat automatisch een lijn. 

----

Afbeeldingen en andere bestanden

U kunt interne en externe afbeeldingen, audio of videobestanden invoegen door accolades ({{}})te gebruiken. Optioneel kunt u de grootte van de afbeelding bepalen.

Werkelijke breedte: 

{{wiki:dokuwiki-128.png}}

Een bepaalde breedte aangegeven: 

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

Een bepaalde breedte en hoogte aangegeven: 

{{wiki:dokuwiki-128.png?200x50}}

Een externe afbeelding waarvan de afmetingen zijn veranderd: 

{{http://de3.php.net/images/php.gif?200x50}}

Een bepaalde breedte en hoogte aangegeven: 

{{wiki:dokuwiki-128.png?200x50}}

Door links of rechts spaties toe te voegen kunt u links of rechts uitlijnen of centreren. 

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

U kunt ook een titel toevoegen die als een tooltip in de meeste browsers getoond wordt.

Dit is de titel 

{{ wiki:dokuwiki-128.png |Dit is de titel}}

Ondersteunde mediaformaten

DokuWiki kan de volgende mediaformaten in de tekst weergeven:

Image gif, jpg, png
Video webm, ogv, mp4
Audio ogg, mp3, wav
Flash swf

Als u de naam van een bestand opgeeft die geen ondersteund mediaformaat is, dan wordt deze in plaats daarvan als link weergegeven.

Door ?linkonly aan de afbeelding toe te voegen kan je de afbeelding als een link tonen in plaats van in de tekst. 

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

dokuwiki-128.png Dit is gewoon een link naar de afbeelding.

Formaten om op terug te vallen

Jammer genoeg begrijpen niet alle browsers alle video- en audioformaten. Om dit probleem te omzeilen en compatibel te zijn met zoveel mogelijk browsers kan je jouw bestand in verschillende formaten uploaden.

Neem nu bijvoorbeeld deze mp4 video in de tekst: 

{{video.mp4|A funny video}}

Als je behalve de video.mp4 waarnaar wordt verwezen ook een video.webm en video.ogv uploadt, zal Dokuwiki ze automatisch toevoegen als alternatieven zodat een van de drie bestanden wordt begrepen door je browser.

Bovendien ondersteunt DokuWiki ook een “poster”-beeld dat wordt getoond voor de video start. Dat beeld moet wel dezelfde bestandsnaam hebben als de video en is ofwel een jpg of png-bestand. In het voorbeeld bovenaan zou het bestand video.jpg werken.

Lijsten

Dokuwiki ondersteunt opsommingslijsten en genummerde lijsten. Begin een regel met twee spaties om een lijst te maken. Gebruik een * (asterisk) voor een opsomming of een - (koppelteken) voor een genummerde lijst.

  • Dit is een opsommingslijst
  • Dit is de tweede regel
    • U kunt verschillende niveaus gebruiken
  • Nog een regel
  1. Dit is een genummerde lijst
  2. Dit is de tweede regel
    1. U kunt verschillende niveaus gebruiken
  3. Nog een regel
  * Dit is een opsommingslijst
  * Dit is de tweede regel
    * U kunt verschillende niveaus gebruiken
  * Nog een regel

  - Dit is een genummerde lijst
  - Dit is de tweede regel
    - U kunt verschillende niveaus gebruiken
  - Nog een regel

Kijk ook op FAQ over lijsten.

Tekstomzettingen

DokuWiki can bepaalde voorgedefineerde tekens of strings omzetten in afbeeldingen of andere tekst of HTML.

De tekst-naar-afbeelding conversie wordt vooral gedaan voor smileys. En de tekst-naar-HTML conversie is vooral voor typografische vervangingen, maar kan ook worden ingesteld om andere HTML te gebruiken.

Tekst naar afbeeldingen conversie

Dokuwiki converteert algemeen gebruikte emoticons naar hun grafische afbeeldingen. Er kunnen Smileys in de 'smiley'-directory bijgeplaatst worden die dan met de conf/smileys.conf geconfigureerd kunnen worden.

  • 8-) 8-)
  • 8-O 8-O
  • :-( :-(
  • :-) :-)
  • =) =)
  • :-/ :-/
  • :-\ :-\
  • :-? :-?
  • :-D :-D
  • :-P :-P
  • :-O :-O
  • :-X :-X
  • :-| :-|
  • ;-) ;-)
  • ^_^ ^_^
  • :?: :?:
  • :!: :!:
  • LOL LOL
  • FIXME FIXME
  • DELETEME DELETEME

Tekst naar HTML conversie

Dokuwiki converteert lettercodes naar hun overeenkomstige typografische afbeelding. Hier een paar voorbeelden.

→ ← → ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought 'It's a man's world'…” 

-> <- -> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"He thought 'It's a man's world'..."

N.B.: Deze voorziening kan uitgeschakeld worden in config option en pattern file.

Citeren

Soms is het nodig om in een tekst aan te geven of iets een opmerking of een reactie is. U kunt dan de volgende syntax gebruiken: 

Ik geloof dat we het moeten doen

> Nee, ik vind van niet

>> Nou, ik zeg van wel

> Echt?

>> Ja!

>>> Laten we het dan maar doen!

Ik geloof dat we het moeten doen

Nee, ik vind van niet
Nou, ik zeg van wel
Echt?
Ja!
Laten we het dan maar doen!

Tabellen

DokuWiki ondersteunt een eenvoudige syntax om tabellen te maken.

Kopje 1 Kopje 2 Kopje 3
Regel 1 kol 1 Regel 1 kol 2 Regel 1 kol 3
Regel 2 kol 1 op twee kolommen (let op de twee stokken)
Regel 3 kol 1 Regel 3 kol 2 Regel 3 kol 3

Regels in tabellen moeten beginnen met een | voor gewone regels of een ^ voor een kopje boven de tabel. 

^ Kopje 1      ^ Kopje 2       ^ Kopje 3          ^
| Regel 1 kol 1    | Regel 1 kol 2     | Regel 1 kol 3        |
| Regel 2 kol 1    | op twee kolommen (let op de twee stokken) ||
| Regel 3 kol 1    | Regel 3 kol 2     | Regel 3 kol 3        |

Om cellen horizontaal te verbinden maak dan de opvolgende cel helemaal leeg zoals in het voorbeeld hierboven. Let er op dat er wel altijd hetzelfde aantal scheidingstekens gebruikt wordt!

Verticale kopjes zijn ook mogelijk.

Kopje 1 Kopje 2
Kopje 3 Regel 1 kol 2 Regel 1 kol 3
Kopje 4 Regel 2 kol 2 Regel 2 kol 3
Kopje 5 Regel 3 kol 2 Regel 3 kol 3 
|       ^ Kopje 1       ^ Kopje 2          ^
^ Kopje 3    | Regel 1 kol 2     | Regel 1 kol 3        |
^ Kopje 4    | Regel 2 kol 2     | Regel 2 kol 3        |
^ Kopje 5    | Regel 3 kol 2     | Regel 3 kol 3        |

Je kan ook rowspans (verticaal samengevoegde cellen) krijgen door ::: in onderliggende cellen in te voeren.

Kop 1 Kop 2 Kop 3
Rij 1 Col 1 deze cellen zijn verticaal samengevoegd Rij 1 Col 3
Rij 2 Col 1 Rij 2 Col 3
Rij 3 Col 1 Rij 2 Col 3

Naast deze rowspan syntax mogen deze cellen niets anders dan spaties bevatten. 

^ Kop 1          ^ Kop 2                                   ^ Kop 3        ^
| Rij 1 Col 1    | deze cellen zijn verticaal samengevoegd | Rij 1 Col 3  |
| Rij 2 Col 1    | :::                                     | Rij 2 Col 3  |
| Rij 3 Col 1    | :::                                     | Rij 2 Col 3  |

De inhoud van een tabel kan gecentreerd, links of rechts uitgelijnd worden. Plaats twee spaties achter de tekst om links uit te lijnen, begin de tekst met twee spaties om rechts uit te lijnen en plaats tenminste twee spaties voor én na een tekst om te centreren.

Tabel met uitlijning
rechts gecentreerd links
links rechts gecentreerd
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

En zo ziet de code er uit: 

^           Tabel met uitlijning           ^^^
|         rechts|    gecentreerd    |links          |
|links          |         rechts|    gecentreerd    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Opmerking: Verticale uitlijning wordt niet ondersteund.

Geen opmaak

Als het nodig is dat de tekst precies zo wordt weergegeven als getypt(zonder opmaak), Sluit dit gedeelte dan in met <nowiki> tags of nog makkelijker, met dubbele procenttekens %%.

Dit is wat tekst die adressen bevat zoals dit: http://www.splitbrain.org en **opmaakcode**, maar niets doet het. Hetzelfde is waar voor //__deze__ tekst// met een smiley ;-). 

<nowiki> 
Dit is wat tekst die adressen bevat zoals dit: http://www.splitbrain.org en 
**opmaakcode**, maar niets doet het.
</nowiki> 
Hetzelfde is waar voor %%//__deze__ tekst// met een smiley ;-)%%.

Codeblokken

U kunt codeblokken in uw documenten invoegen die niet door 'wiki' verwerkt worden door deze met tenminste twee spaties te laten beginnnen (zoals in eerdere voorbeelden getoond) of door de codes <code> of <file> te gebruiken. 

Deze tekst begint met twee spaties
De code is geformatteerd en alle spaties werden bewaard: zoals       <-dit
Deze is ongeveer hetzelfde en kunt u gebruiken door bijvoorbeeld een 
citaat aan te geven.

Deze blokken zijn gemaakt met deze code: 

  Deze tekst begint met twee spaties
<code>
De code is geformatteerd en alle spaties werden bewaard: zoals       <-dit
</code>
<file>
Deze is ongeveer hetzelfde en kunt u gebruiken door bijvoorbeeld een 
citaat aan te geven.
</file>

Syntax benadrukken

DokuWiki kan broncode benadrukken zodat deze beter leesbaar wordt. Het gebruikt daarvoor de GeSHi Generic Syntax Highlighter – zodat elke door GeSHi ondersteunde taal wordt ondersteund. De syntax is hetzelfde als in de codeparagraaf in het vorige onderdeel maar nu wordt de taal van de gewenste codestijl aan de tag toegevoegd. Bijvoorbeeld <code java>. 

/** 
 * The HelloWorldApp class implements an application that
 * simply displays "Hello World!" to the standard output.
 */
class HelloWorldApp {
    public static void main(String[] args) {
        System.out.println("Hello World!"); //Display the string.
    }
}

Momenteel worden de syntaxen van de volgende programmeertalen herkend: 4cs, 6502acme, 6502kickass, 6502tasm, 68000devpac, abap, actionscript-french, actionscript, actionscript3, ada, algol68, apache, applescript, asm, asp, autoconf, autohotkey, autoit, avisynth, awk, bascomavr, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_loadrunner, c_mac, caddcl, cadlisp, cfdg, cfm, chaiscript, cil, clojure, cmake, cobol, coffeescript, cpp, cpp-qt, csharp, css, cuesheet, d, dcs, delphi, diff, div, dos, dot, e, epc, ecmascript, eiffel, email, erlang, euphoria, f1, falcon, fo, fortran, freebasic, fsharp, gambas, genero, genie, gdb, glsl, gml, gnuplot, go, groovy, gettext, gwbasic, haskell, hicest, hq9plus, html, html5, icon, idl, ini, inno, intercal, io, j, java5, java, javascript, jquery, kixtart, klonec, klonecpp, latex, lb, lisp, llvm, locobasic, logtalk, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, magiksf, make, mapbasic, matlab, mirc, modula2, modula3, mmix, mpasm, mxml, mysql, newlisp, nsis, oberon2, objc, objeck, ocaml-brief, ocaml, oobas, oracle8, oracle11, oxygene, oz, pascal, pcre, perl, perl6, per, pf, php-brief, php, pike, pic16, pixelbender, pli, plsql, postgresql, povray, powerbuilder, powershell, proftpd, progress, prolog, properties, providex, purebasic, pycon, python, q, qbasic, rails, rebol, reg, robots, rpmspec, rsplus, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, systemverilog, tcl, teraterm, text, thinbasic, tsql, typoscript, unicon, uscript, vala, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xbasic, xml, xorg_conf, xpp, yaml, z80, zxbasic

Downloadbare Codeblokken

Wanneer je <code> of <file> syntax gebruikt, wil je misschien ook dat de weergegeven code beschikbaar is om te downloaden. Dit kan door een bestandsnaam na de taal code toe te voegen: 

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

If you don't want any highlighting but want a downloadable file, specify a dash (-) as the language code: <code - myfile.foo>.

Ingevoegde HTML en PHP code

Je kunt ruwe HTML of PHP code in je documenten invoegen door het gebruiken van <html> of <php> tags. (Gebruik alleen hoofdletter tags als er block level elementen nodig zijn.)

HTML voorbeeld: 

<html>
Dit is wat <span style="color:red;font-size:150%;">inline HTML</span>
</html>
<HTML>
<p style="border:2px dashed red;">En dit is wat block HTML</p>
</HTML>

Dit is wat inline HTML

En dit is wat block HTML

PHP voorbeeld: 

<php>
echo 'Een logo gegenereerd door PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
echo '(genereert inline HTML)';
</php>
<PHP>
echo '<table class="inline"><tr><td>Dit is hetzelfde, maar in een block level element:</td>';
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';
echo '</tr></table>';
</PHP>

echo 'Een logo gegenereerd door PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; echo '(genereert inline HTML)'; 

echo '<table class="inline"><tr><td>Dit is hetzelfde, maar in een block level element:</td>';
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';
echo '</tr></table>';

Let op deze opmerking: HTML en PHP invoegen is standaard uitgeschakeld in de instellingen. De code wordt weergegeven in plaats van uitgevoerd als deze functie is uitgeschakeld.

RSS/ATOM Feed Aggregation

DokuWiki kan data integreren uit externe XML feeds. Voor het aanmaken van XML feeds wordt SimplePie gebruikt. Alle formaten die door SimplePie worden begrepen kunnen ook worden gebruikt in DokuWiki. De weergave kan worden beïnvloed met de volgende parameters, gescheiden door spaties:

Parameter Beschrijving
een nummer wordt gebruikt als maximum aantal weer te geven items, standaard op 8
reverse laat de laatste items in de feed het eerste zien
author geeft de namen van item-auteurs
date geeft itemdatums
description geeft itembeschrijving. Als HTML uitgeschakeld is worden alle tags gestript
n[dhm] vernieuwingsinterval, waar d=dagen, h=uren, m=minuten. (bijv. 12h = 12 uur).

Het vernieuwingsinterval is standaard 4 uren. Een waarde onder de 10 minuten wordt behandeld als 10 minuten. Dokuwiki zal over het algemeen proberen om een gecachte versie van de pagina te bewaren, uiteraard is dit verkeerd als een pagina dynamische externe inhoud bevat. De parameter vertelt DokuWiki om de pagina te opnieuw te renderen en op te slaan in de cache als die ouder is dan de vernieuwingsinterval sinds de pagina de laatste keer was gerenderd.

Voorbeeld: 

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

Control Macros

Sommige syntax beïnvloedt hoe DokuWiki een pagina rendert zonder dat het zelf uitvoer creëert. De volgende control macro's zijn beschikbaar:

Macro Beschrijving
~~NOTOC~~ Als deze macro wordt gevonden op een pagina, dan wordt er geen inhoudsopgave gemaakt
~~NOCACHE~~ DokuWiki cachet standaard alle uitvoer. Soms is dit niet gewenst (bijv. wanneer de <php> syntax wordt gebruikt), het toevoegen van deze macro dwingt DokuWiki om bij elk verzoek de pagina opnieuw te renderen.

Syntax Plugins

Dokuwiki's syntax kan worden uitgebreid met Plugins. Hoe de geïnstalleerde plugins worden gebruikt is beschreven op hun eigen pagina's. De volgende syntax plugins zijn beschikbaar in deze DokuWiki installatie:

1)
Dit is een voetnoot
  • /home/zaanwiki/domains/zaanwiki.nl/private_html/encyclopedie/data/pages/wiki/syntax.txt
  • Laatst gewijzigd: 2023/02/10 13:43
  • door jan