DokuWiki supporte un language de balises simple, qui essaie de rendre les fichiers de données aussi lisibles que possible. Cette page contient toute la syntaxe possible que vous pouvez utiliser en éditant les pages. Regardez simplement le code source de cette page en cliquant sur le bouton Edit this page en haut ou en bas de cette page. Si vous souhaitez essayer quelquechose, rendez-vous dans le bac à sable. Les balises les plus simples sont facilement accessible depuis les quickbuttons, aussi.
DokuWiki supporte les textes en gras, italique, souligné et à espace fixe
.
Bien sûr, vous pouvez tous les combiner
.
DokuWiki supporte les textes en **gras**, //italique//, __souligné__ et ''à espace fixe''. Bien sûr, vous pouvez tous les **__//''combiner''//__**.
Vous pouvez aussi utiliser indice et exposant.
Vous pouvez aussi utiliser <sub>indice</sub> et <sup>exposant</sup>.
De plus, vous pouvez marquer du contenu comme supprimé.
De plus, vous pouvez marquer du contenu comme <del>supprimé</del>.
Les paragraphes sont créés depuis les lignes vides. Si vous souhaitez forcer un saut de ligne sans paragraphe, vous pouvez utiliser deux antislashes suivis par un espace ou une fin de ligne.
Voilà du texte avec des sauts de ligne
remarquez que les
deux antislashes sont seulement reconnus en fin de ligne
ou suivis par
un espace ; \\cela arrive sinon.
Voilà du texte avec des sauts de ligne\\ remarquez que les deux antislashes sont seulement reconnus en fin de ligne\\ ou suivis par\\ un espace ; \\cela arrive sinon.
Vous devriez forcer des sauts de ligne uniquement si c'est réellement nécessaire.
DokuWiki propose plusieurs moyens de créer des liens.
Les liens externes sont reconnus automagiquement : http://www.google.fr ou simplement www.google.fr - Vous pouvez aussi donner des noms aux liens : Ce lien pointe vers google. Les adresses email telles que celle-ci : andi@splitbrain.org sont également reconnues.
Les liens externes sont reconnus automagiquement : http://www.google.fr ou simplement www.google.fr - Vous pouvez aussi donner des noms aux liens : [[http://www.google.fr|Ce lien pointe vers google]]. Les adresses email telles que celle-ci : <andi@splitbrain.org> sont également reconnues.
Les liens internes sont créés en utilisant les crochets. Vous pouvez soit juste donner un nom de page ou utiliser un texte pour le titre. Les noms de pages (pagenames) wiki sont converties automatiquement en minuscules, les caractères spéciaux ne sont pas autorisés.
Vous pouvez utiliser des [[wiki:fr:namespace|catégories]] (//namespaces//) ou espaces de noms en utilisant les //deux points// (:) dans le nom de page //pagename//.
Pour plus de détails sur les catégories (namespaces), voir l'espace de noms.
Les liens vers une section spécifique sont également possibles. Ajoutez simplement le nom de la section après un caractère dièse (#) comme en HTML.
Ce lien renvoie vers cette section.
Notes :
DokuWiki propose les liens Interwiki. Ce sont des liens rapides vers d'autres Wikis. Par exemple ceci est un lien vers la définition des Wikis dans la Wikipedia : Wiki.
DokuWiki propose les liens [[doku>wiki:interwiki|Interwiki]]. Ce sont des liens rapides vers d'autres Wikis. Par exemple ceci est un lien vers la définition des Wikis dans la Wikipedia : [[wp>Wiki]].
Les partages Windows tels que ceci sont également reconnus. Veuillez noter qu'ils n'ont un sens que dans une groupe d'utilisateurs homogène tels qu'un Intranet d'entreprise.
Les partages Windows tels que [[\\serveur\partage|ceci]] sont également reconnus.
Notes :
Dans les versions les plus récentes de ces navigateurs, l'option de configuration globale security.checkloaduri n'a plus d'effet. A la place, checkloaduri a été combiné avec l'interface CAPS pour permettre une configuration par site des règles de Sécurités.
Pour permettre le lien vers des fichiers sur le réseau d'un Intranet, il faut ajouter les lignes suivantes au fichier user.js situé dans votre Profile. Si ce fichier n'existe pas, il suffit de le créer.
user_pref("capability.policy.policynames", "localfilelinks"); user_pref("capability.policy.localfilelinks.sites", "http://www.monintranet.com"); user_pref("capability.policy.localfilelinks.checkloaduri.enabled", "allAccess");
La ligne avec capability.policy.localfilelinks.sites
peut avoir plusieurs site séparés par des espaces.
user_pref("capability.policy.localfilelinks.sites","http://www.monintranet.com http://www.monintranet.net");
(Evidemment, vous devriez remplacer http://www.monintranet.com
et http://www.monintranet.net
par les sites dont vous voulez permettre le partage.)
Les sites doivent être listés de la manière suivante: le protocol suivi du nom de domaine (www.monintranet.com) suivi, si nécessaire d'un numéro de port(:8080). Ils ne devraient pas contenir de / final ou tout autre partie de l'URL.
Les partages windows s'écrivent alors [[file:///C:\dossier\partage|ça]].
Vous pouvez aussi utiliser une image afin de créer un lien vers une autre page interne ou externe en combinant les syntaxes des liens et des images (voir ci-dessous) comme ceci :
[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
NB : la mise en forme image est la seule syntaxe de mise en forme acceptée comme nom du lien.
Vous pouvez ajouter des notes de pied de page 1) en utilisant 2 doubles parenthèses.
Vous pouvez ajouter des notes de pied de page ((Ceci est une note de pied de page)) en utilisant 2 doubles parenthèses.
Vous pouvez utiliser jusqu'à cinq différents niveaux de titres afin de structurer votre contenu. Si vous avez plus de trois titres, une table des matières est générée automatiquement – ceci peut être désactivé en incluant la chaîne
~~NOTOC~~
dans le document.
==== Titre niveau 3 ==== === Titre niveau 4 === == Titre niveau 5 ==
En utilisant quatre tirets ou plus, vous pouvez créer une ligne horizontale :
Vous pouvez inclure des images externes et internes avec des accolades. Vous pouvez spécifier leur taille (facultatif).
Redimension à une largeur donnée :
Redimension à une largeur et une hauteur données :
Image externe redimensionnée :
Taille réelle : {{wiki:dokuwiki-128.png}} Redimension à une largeur donnée : {{wiki:dokuwiki-128.png?50}} Redimension à une largeur et une hauteur données : {{wiki:dokuwiki-128.png?200x50}} Image externe redimensionnée : {{http://de3.php.net/images/php.gif?200x50}}
En utilisant des espaces à gauche ou à droite, vous pouvez choisir l'alignement
{{ wiki:dokuwiki-128.png}} {{wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }}
Bien sûr, vous pouvez aussi ajouter un titre (affiché comme une bulle d'info par la plupart des navigateurs).
{{ wiki:dokuwiki-128.png |Ceci est le titre}}
Si vous spécifiez un nom de fichier (externe ou interne) qui n'est pas une image (gif,jpeg,png
), alors il sera affiché comme un lien et non comme un image.
DokuWiki supporte les listes ordonnées et non ordonnées. Pour créer un élément de liste, indentez votre texte par deux espaces et utilisez une *
pour une liste non ordonnée ou un -
pour une liste ordonnée.
* Ceci est une liste * Le second élément * Vous pouvez avoir plusieurs niveaux * Un autre élément - La même liste mais ordonnée - Un autre élément - Utilisez simplement l'indentation pour des niveaux plus profonds - Et voilà
<doodle title="What do you like best?" auth="none|ip|user" adminUsers="user1|user2" adminGroups="group1|group2" voteType="single|multi" closed="true|false" > * Option 1 * Option 2 **some wikimarkup** \\ is __allowed__! * Option 3 </doodle>
title
is also used as “key” for the plugin's data file under /data/meta
adminUsers
and members of the adminGroups
can always edit any entryvoteType=“single”
shows round checkboxes where only one can be chosenvoteType=“multi”
lets users check any number of square boxesclosed=“true”
is set, then users cannot vote anymore. The result of the vote will still be shown.Only the title and at least one option are required. Do not change the options and their order, after the first vote has been casted! You may move the whole doodle to another page, whenever you want.
DokuWiki transforme les emoticones généralement utilisés en leurs équivalents graphiques. Plus d'émoticônes (smileys) peuvent être placés dans le répertoire smiley
et configurés dans le fichier conf/smileys.conf
. Voici une vue d'ensemble des émoticônes inclus dans DokuWiki.
DokuWiki peut convertir de simples caractères de texte brut en leurs entités typgraphiques correctes. Voici un exemple des caractères reconnus.
→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought 'It's a man's world'…”
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) "He thought 'It's a man's world'..."
NB : Ces conversions peuvent être interdites dans le fichier de configuration.
Parfois vous souhaitez marquer du texte afin de montrer que c'est une réponse ou un commentaire. Vous pouvez utiliser la syntaxe suivante :
Je pense que nous devrions le faire
> Non nous ne devrions pas
>> Eh bien, je pense que si
> Vraiment ?
>> Oui !
>>> Alors faisons-le !
Je pense que nous devrions le faire
Non nous ne devrions pas
Eh bien, je pense que si
Vraiment ?
Oui !
Alors faisons-le !
DokuWiki propose une syntaxe simple pour créer des tableaux.
Titre 1 | Titre 2 | Titre 3 |
---|---|---|
Ligne 1 Col 1 | Ligne 1 Col 2 | Ligne 1 Col 3 |
Ligne 2 Col 1 | colonnes fusionnées (notez la double barre verticale) | |
Ligne 3 Col 1 | Ligne 2 Col 2 | Ligne 2 Col 3 |
Les lignes de tableau doivent commencer et terminer avec un pipe |
pour des lignes normales ou avec un ^
pour les titres.
^ Titre 1 ^ Titre 2 ^ Titre 3 ^ | Ligne 1 Col 1 | Ligne 1 Col 2 | Ligne 1 Col 3 | | Ligne 2 Col 1 | colonnes fusionnées (notez la double barre verticale) || | Ligne 3 Col 1 | Ligne 2 Col 2 | Ligne 2 Col 3 |
Pour fusionner des cellules horizontalement (colspan), rendez simplement la cellule suivante complètement vide comme montré ci-dessus. Assurez-vous d'avoir toujours le même nombre de séparateurs de cellules !
Les titres de tableau verticaux sont également possibles.
Titre 1 | Titre 2 | |
---|---|---|
Titre 3 | Ligne 1 Col 2 | Ligne 1 Col 3 |
Titre 4 | pas de fusion cette fois | |
Titre 5 | Ligne 2 Col 2 | Ligne 2 Col 3 |
Comme vous pouvez le constater, c'est le séparateur ('|' ou '^') précédant une cellule qui détermine le format :
| ^ Titre 1 ^ Titre 2 ^ ^ Titre 3 | Ligne 1 Col 2 | Ligne 1 Col 3 | ^ Titre 4 | pas de fusion cette fois | | ^ Titre 5 | Ligne 2 Col 2 | Ligne 2 Col 3 |
Note : les fusions verticales (rowspan) ne sont pas possibles.
Vous pouvez également aligner le contenu du tableau. Ajoutez simplement au moins deux espaces blancs à l'extrémité opposée à votre texte : ajoutez deux espaces sur la gauche pour aligner à droite, deux espaces sur la droite pour aligner à gauche et deux espaces au moins à chaque extrémité pour centrer le texte.
Tableau avec alignement | ||
---|---|---|
droite | centré | gauche |
gauche | droite | centré |
xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Voici à quoi ça ressemble dans le code source :
^ Tableau avec alignement ^^^ | droite| centré |gauche | |gauche | droite| centré | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Vous pouvez inclure des blocs non analysés (non parsed) dans vos documents soit en les indentant avec au moins deux espaces (comme utilisé dans les exemples précédant) ou en utilisant les balises code
ou file
.
Ceci est du code préformaté, tous les espaces sont préservés : comme <-ceci
Ceci est pratiquement la même chose, mais vous pouvez l'utiliser pour montrer que vous avec cité un fichier.
Pour laisser l'analyseur ignorer complètement un bloc (ie. ne pas faire de mise en forme dedans), encadrez ce bloc soit avec des balises nowiki
ou encore plus simple, avec des doubles caractères pourcent %%
.
Voici du texte qui contient des adresses comme ceci : http://www.spiltbrain.org et de la **mise en forme**, mais rien ne se passe.
Consultez le code source de cette page pour voir comment utiliser ces blocs.
DokuWiki peut surligner du code source, ce qui facilite sa lecture. Il utilise le Generic Syntax Highlighter GeSHi – donc n'importe quel langage reconnu par GeSHi est supporté. La syntaxe est la même que dans le bloc de code dans la section précédent, mais cette fois le nom du langage utilisé est insérée dans le tag. Ex : <code java>
.
/** * La classe HelloWorldApp implemente une application qui * affiche simplement "Hello World!" dans la sortie standard. */ class HelloWorldApp { public static void main(String[] args) { System.out.println("Hello World!"); //Affiche la chaîne. } }
Les identificateurs de langage suivants sont actuellement reconnus : actionscript, ada, apache, asm, asp, bash, caddcl, cadlisp, c, c_mac, cpp, csharp, css, delphi, html4strict, java, javascript, lisp, lua, mpasm, nsis, objc, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, smarty, sql, vb, vbnet, visualfoxpro, xml
Vous pouvez inclure du code HTML ou PHP pur dans vos documents en utilisant les tags html
ou php
comme ceci :
<html> Ceci est du <font color="red" size="+1">HTML</font> </html>
Ceci est du HTML
<php> echo 'Un logo généré par PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="Logo PHP !" />'; </php>
echo 'Un logo généré par PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="Logo PHP !" />';
NB : L'inclusion de code HTML et PHP est impossible dans la configuration par défaut. Dans ce cas, le code est affiché au lieu d'être exécuté.
La syntaxe de DokuWiki peut être étendue par des extensions. La façon d'utiliser les extensions installées se trouvent sur les pages descriptives correspondantes. Les extensions suivantes sont disponibles sur cette installation de DokuWiki :
Les notes permettent de mettre en évidence des parties de votre texte.
<note>Ceci est une note, rappelez-vous en !</note>
Ceci est une note, rappelez-vous en !
<note importante>Attention au chien quand vous ouvrez la porte !</note>
Attention au chien quand vous ouvrez la porte !
<note tuyau>Pensez à refermer la porte pour que le chien ne sorte pas.</note>
Pensez à refermer la porte pour que le chien ne sorte pas.
<note bloquante>N'allez surtout pas par là!</note>
N'allez pas par là!
DokuWiki supports some simple markup language, which tries to make the datafiles to be as readable as possible. This page contains all possible syntax you may use when editing the pages. Simply have a look at the source of this page by pressing the Edit this page button at the top or bottom of the page. If you want to try something, just use the playground page. The simpler markup is easily accessible via quickbuttons, too.
DokuWiki supports bold, italic, underlined and monospaced
texts. Of course you can combine
all these.
DokuWiki supports **bold**, //italic//, __underlined__ and ''monospaced'' texts. Of course you can **__//''combine''//__** all these.
You can use subscript and superscript, too.
You can use <sub>subscript</sub> and <sup>superscript</sup>, too.
You can mark something as deleted as well.
You can mark something as <del>deleted</del> as well.
Paragraphs are created from blank lines. If you want to force a newline without a paragraph, you can use two backslashes followed by a whitespace or the end of line.
This is some text with some linebreaks
Note that the
two backslashes are only recognized at the end of a line
or followed by
a whitespace \\this happens without it.
This is some text with some linebreaks\\ Note that the two backslashes are only recognized at the end of a line\\ or followed by\\ a whitespace \\this happens without it.
You should use forced newlines only if really needed.
DokuWiki supports multiple ways of creating links.
External links are recognized automagically: http://www.google.com or simply www.google.com - You can set Linknames, too: This Link points to google. Email addresses like this one: andi@splitbrain.org are recognized, too.
DokuWiki supports multiple ways of creating links. External links are recognized automagically: http://www.google.com or simply www.google.com - You can set Linknames, too: [[http://www.google.com|This Link points to google]]. Email addresses like this one: <andi@splitbrain.org> are recognized, too.
Internal links are created by using square brackets. You can either just give a wiki:pagename or use an additional Title Text. Wiki pagenames are converted to lowercase automatically, special characters are not allowed.
Internal links are created by using square brackets. You can either just give a [[pagename]] or use an additional [[pagename|Title Text]]. Wiki pagenames are converted to lowercase automatically, special chars are not allowed.
You can use namespaces by using a colon in the pagename.
You can use [[wiki:namespaces]] by using a colon in the pagename.
For details about namespaces see wiki:namespaces.
Linking to a specific section is possible, too. Just add the section name behind a hash character as known from HTML. This links to this Section.
This links to [[syntax#internal|this Section]].
Notes:
DokuWiki supports Interwiki links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: Wiki.
DokuWiki supports [[doku>wiki:interwiki|Interwiki]] links. These are quick links to other Wikis. For example this is a link to Wikipedia's page about Wikis: [[wp>Wiki]].
Windows shares like this are recognized, too. Please note that these only make sense in a homogenous user group like a corporate Intranet.
Windows Shares like [[\\server\share|this]] are recognized, too.
Notes:
You can also use an image to link to another internal or external page by combining the syntax for links and images (see below) like this:
[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
Please note: The image formatting is the only formatting syntax accepted in link names.
The whole image and link syntax is supported (including image resizing, internal and external images and URLs and interwiki links).
You can add footnotes 2) by using double parentheses.
You can add footnotes ((This is a footnote)) by using double parentheses.
You can use up to five different levels of headlines to structure your content. If you have more than three headlines, a table of contents is generated automatically – this can be disabled by including the string ~~NOTOC~~
in the document.
==== Headline Level 3 ==== === Headline Level 4 === == Headline Level 5 ==
By using four or more dashes, you can make a horizontal line:
You can include external and internal wiki:images with curly brackets. Optionally you can specify the size of them.
Resize to given width and height:
Real size: {{wiki:dokuwiki-128.png}} Resize to given width: {{wiki:dokuwiki-128.png?50}} Resize to given width and height: {{wiki:dokuwiki-128.png?200x50}} Resized external image: {{http://de3.php.net/images/php.gif?200x50}}
By using left or right whitespaces you can choose the alignment.
{{ wiki:dokuwiki-128.png}} {{wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }}
Of course, you can add a title (displayed as a tooltip by most browsers), too.
{{ wiki:dokuwiki-128.png |This is the caption}}
If you specify a filename (external or internal) that is not an image (gif, jpeg, png
), then it will be displayed as a link instead.
For linking an image to another page see Image Links above.
Dokuwiki supports ordered and unordered lists. To create a list item, indent your text by two spaces and use a *
for unordered lists or a -
for ordered ones.
* This is a list * The second item * You may have different levels * Another item - The same list but ordered - Another item - Just use indention for deeper levels - That's it
DokuWiki converts commonly used emoticons to their graphical equivalents. More smileys can be placed in the smiley
directory and configured in the conf/smileys.conf
file. Here is an overview of Smileys included in DokuWiki.
DokuWiki can convert simple text characters to their typographically correct entities. Here is an example of recognized characters.
→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “He thought 'It's a man's world'…”
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) "He thought 'It's a man's world'..."
Please note: These conversions can be turned off through a config option and a pattern file.
Some times you want to mark some text to show it's a reply or comment. You can use the following syntax:
I think we should do it > No we shouldn't >> Well, I say we should > Really? >> Yes! >>> Then lets do it!
I think we should do it
No we shouldn't
Well, I say we should
Really?
Yes!
Then lets do it!
DokuWiki supports a simple syntax to create tables.
Heading 1 | Heading 2 | Heading 3 |
---|---|---|
Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 |
Row 2 Col 1 | some colspan (note the double pipe) | |
Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 |
Table rows have to start and end with a |
for normal rows or a ^
for headers.
^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | Row 1 Col 1 | Row 1 Col 2 | Row 1 Col 3 | | Row 2 Col 1 | some colspan (note the double pipe) || | Row 3 Col 1 | Row 2 Col 2 | Row 2 Col 3 |
To connect cells horizontally, just make the next cell completely empty as shown above. Be sure to have always the same amount of cell separators!
Vertical tableheaders are possible, too.
Heading 1 | Heading 2 | |
---|---|---|
Heading 3 | Row 1 Col 2 | Row 1 Col 3 |
Heading 4 | no colspan this time | |
Heading 5 | Row 2 Col 2 | Row 2 Col 3 |
As you can see, it's the cell separator before a cell which decides about the formatting:
| ^ Heading 1 ^ Heading 2 ^ ^ Heading 3 | Row 1 Col 2 | Row 1 Col 3 | ^ Heading 4 | no colspan this time | | ^ Heading 5 | Row 2 Col 2 | Row 2 Col 3 |
Note: Vertical spans (rowspan) are not possible.
You can align the table contents, too. Just add at least two whitespaces at the opposite end of your text: Add two spaces on the left to align right, two spaces on the right to align left and two spaces at least at both ends for centered text.
Table with alignment | ||
---|---|---|
right | center | left |
left | right | center |
xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
This is how it looks in the source:
^ Table with alignment ^^^ | right| center |left | |left | right| center | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
You can include non-parsed blocks into your documents by either indenting them by at least two spaces (like used for the previous examples) or by using the tags code
or file
.
This is preformatted code all spaces are preserved: like <-this
This is pretty much the same, but you could use it to show that you quoted a file.
To let the parser ignore an area completely (ie. do no formatting on it), enclose the area either with nowiki
tags or even simpler, with double percent signs %%
.
This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.
See the source of this page to see how to use these blocks.
DokuWiki can highlight sourcecode, which makes it easier to read. It uses the GeSHi Generic Syntax Highlighter – so any language supported by GeSHi is supported. The syntax is the same like in the code block in the previous section, but this time the name of the used language is inserted inside the tag. Eg. <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. } }
The following language strings are currently recognized: abap actionscript-french, actionscript, ada, apache, applescript, asm, asp, autoit, bash, basic4gl, blitzbasic, bnf, caddcl, cadlisp, cfdg, cfm, c_mac, c, cpp, cpp-qt, csharp, css, delphi, diff, div, dos, dot, d, eiffel, fortran, freebasic, genero, gml, groovy, haskell, html, idl, ini, inno, io, java5, java, javascript, latex, lisp, lua, m68k, matlab, mirc, mpasm, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, per, php-brief, php, plsql, python, qbasic, rails, reg, robots, ruby, sas, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, thinbasic, tsql, vbnet, vb, vhdl, visualfoxpro, winbatch, xml, xpp, z80
DokuWiki can integrate data from external XML feeds. For parsing the XML feeds, SimplePie is used. All formats understood by SimplePie can be used in DokuWiki as well. You can influence the rendering by multiple additional space separated parameters:
Parameter | Description |
---|---|
any number | will be used as maximum number items to show, defaults to 8 |
reverse | display the last items in the feed first |
author | show item authors names |
date | show item dates |
description | show the item description. If HTML is disabled all tags will be stripped |
n[dhm] | refresh period, where d=days, h=hours, m=minutes. (e.g. 12h = 12 hours). |
The refresh period defaults to 4 hours. Any value below 10 minutes will be treated as 10 minutes. DokuWiki will generally try to supply a cached version of a page, obviously this is inappropriate when the page contains dynamic external content. The parameter tells DokuWiki to re-render the page if it is more than refresh period since the page was last rendered.
Example:
{{rss>http://slashdot.org/index.rss 5 author date 1h }}
You can embed raw HTML or PHP code into your documents by using the html
or php
tags like this:
<html> This is some <span style="color:red;font-size:150%;">inline HTML</span> </html> <HTML> <p style="border:2px dashed red;">And this is some block HTML</p> </HTML>
This is some inline HTML
And this is some block HTML
<php> echo 'A logo generated by PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; echo '(generated inline HTML)'; </php> <PHP> echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>'; echo '</tr></table>'; </PHP>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
echo '(inline HTML)';
echo '<table class="inline"><tr><td>The same, but inside a block level element:</td>'; echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>'; echo '</tr></table>';
Please Note: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.
<doodle title="What do you like best?" auth="none|ip|user" adminUsers="user1|user2" adminGroups="group1|group2" voteType="single|multi" closed="true|false" > * Option 1 * Option 2 **some wikimarkup** \\ is __allowed__! * Option 3 </doodle>
title
is also used as “key” for the plugin's data file under /data/meta
adminUsers
and members of the adminGroups
can always edit any entryvoteType=“single”
shows round checkboxes where only one can be chosenvoteType=“multi”
lets users check any number of square boxesclosed=“true”
is set, then users cannot vote anymore. The result of the vote will still be shown.Only the title and at least one option are required. Do not change the options and their order, after the first vote has been casted! You may move the whole doodle to another page, whenever you want.
Some syntax influences how DokuWiki renders a page without creating any output it self. The following control macros are availble:
Macro | Description |
---|---|
~~NOTOC~~ | If this macro is found on the page, no table of contents will be created |
~~NOCACHE~~ | DokuWiki caches all output by default. Sometimes this might not be wanted (eg. when the <php> syntax above is used), adding this macro will force DokuWiki to rerender a page on every call |
DokuWiki's syntax can be extended by Plugins. How the installed plugins are used is described on their appropriate description pages. The following syntax plugins are available in this particular DokuWiki installation: