Sintaxi del formatat

DokuWiki admet un llenguatge de marques força senzill, el qual pretén que els fitxers de dades siguin el màxim de legibles. Aquesta pàgina conté tota la sintaxi que podeu utilitzar quan editeu pàgines. Només cal que feu una ullada al codi font fent clic al botó Edita aquesta pàgina que podeu trobar tant a dalt com a baix de la pàgina. Si voleu fer provatures, useu la pàgina playground. Una manera més senzilla de posar marques de format és accessible, també, a través de quickbuttons.

Formatat bàsic de text

DokuWiki admet text en negreta, cursiva, subratllat i monoespaiat. Per descomptat podeu combinar tots aquests estils.

DokuWiki admet text en **negreta**, //cursiva//, __subratllat__ i ''monoespaiat''.
Per descomptat podeu **__//''combinar''//__** tots aquests estils.

També podeu usar subíndexs i índexs.

També podeu usar <sub>subíndexs</sub> i <sup>índexs</sup>.

Podeu marcar qualsevol cosa com a esborrada facilment.

Podeu marcar qualsevol cosa com a <del>esborrada</del> facilment.

Els paràgrafs es creen a partir de les línies en blanc. Si voleu forçar una línia nova sense separació de paràgraf, podeu utilitzar dues contrabarres seguides d'un espai en blanc o el final de línia.

Això és un text amb alguns salts de línia
Fixeu-vos que les dues contrabarres només són reconegudes al final de la línia
o si després hi ha un
espai en blanc \\si no hi ha l'espai es veu així.

Això és un text amb alguns salts de línia\\ Fixeu-vos que les
dues contrabarres només són reconegudes al final de la línia\\
o si després hi ha un\\ espai en blanc \\si no hi ha l'espai es veu així.

Només haurieu d'usar línies noves forçades si realment són necessàries.

Enllaços

DokuWiki permet diverses maneres de crear enllaços.

Externs

Els enllaços externs són reconeguts de manera automàgica: http://www.google.com o simplement www.google.com - Podeu posar un nom a l'enllaç, si ho voleu: Aquest enllaç apunta a Google. També es reconeixen les adreces de correu electrònic del tipus: andi@splitbrain.org.

Dokuwiki permet diverses maneres de crear enllaçoc. Els enllaços externs són reconeguts
de manera automàgica: http://www.google.com o simplement www.google.com - Podeu
posar un nom a l'enllaç, si ho voleu: [[http://www.google.com|Aquest enllaç apunta a Google]].
També es reconeixen les adreces de correu electrònic del tipus: <andi@splitbrain.org>.

Interns

Els enllaços interns es creen utilitzant claudàtors. Podeu posar només wiki:nom_de_la_pagina o bé afegir-hi un Text de títol. Els noms de pàgina del Wiki es converteixen a caixa baixa (tot minúscules) automàticament, no s'admeten els caràcters especials (accents, etc.).

Els enllaços interns es creen utilitzant claudàtors. Podeu posar només [[nom_de_la_pagina]]
o bé afegir-hi un [[nom_de_la_pagina|Text de títol]]. Els noms de pàgina del Wiki es converteixen
a caixa baixa (tot minúscules) automàticament, no s'admeten els caràcters especials (accents, etc.).
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.

Podeu usar espais posant dos punts (:) al nom de la pàgina.

Podeu usar [[wiki:espais]] posant dos punts (:) al nom de la pàgina.

Per més detalls sobre els espais, veieu wiki:namespaces.

També és possible enllaçar cap a auna secció concreta. Simplement poseu el nom de la secció després del caracter # com és fa en HTML. Això enllaça a aquesta secció.

Això enllaça a [[sintaxi#interns|aquesta secció]].

Notes:

  • Els enllaços a pàgines existents es mostren en un estil diferents a les que no_existeixen.
  • DokuWiki no utilitza CamelCase per crear enllaços automaticament per defecte, però es pot activar aquesta característica a l'arxiu wiki:config. Truquillo: Si DokuWiki és un enllaç, aleshores està activada.
  • Quan es canvia la capçalera d'una secció, també canvia el seu punt d'enllaç. Alerta doncs amb l'enllaç a seccions.

Interwiki

DokuWiki admet enllaços del tipus Interwiki (enllaços ràpids a altres Wikis). Per exemple, aquest és un enllaç a la pàgina de la Wiquipèdia que tracta sobre els Wikis: Wiki.

DokuWiki admet enllaços del tipus [[doku>wiki:interwiki|Interwiki]] (enllaços ràpids a altres Wikis).
Per exemple, aquest és un enllaç a la pàgina de la Wiquipèdia que tracta sobre els Wikis: [[wp>Wiki]].

Recursos compartits de Windows

També es reconeixen els recursos compartits de Windows, com ara aquest. Fixeu-vos, però, que això només té sentint en un grup de treball homogèni, com per exemple una Intranet corporativa.

També es reconeixen els recursos compartits de Windows, com ara [[\\server\share|aquest]].

Notes:

  • Per raons de seguretat, la navegació directa per recursos compartits de Windows només funciona per defecte si s'utilitza Internet Explorer de Microsoft (i només a la “zona local”).
  • Es pot activat també per a Mozilla i Firefox a través de l'opció de configuració security.checkloaduri, però no és recomnable.
  • Veieu 151 per obtenir més informació al respecte.

Enllaços amb imatges

Podeu utilitzar, també, una imatge per enllaçar cap a una pàgina interna o externa combinant la sintaxi dels enllaços i de les imatges (mireu a sota) d'aquesta manera:

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

Fixeu-vos: el formateig d'imatges és l'única sintaxi de format acceptada als noms dels enllaços.

S'accepta la sintaxi completa d'imatges i enllaços (incloent redimesionament, imatges internes i externes i enllços del tipus interwiki i URL).

Notes a peu de pàgina

Podeu afegir notes a peu de pàgina 1) usant parentesis dobles.

Podeu afegir notes a peu de pàgina ((Això és una nota a peu de pàgina)) usant parentesis dobles.

Seccions

Podeu utilitzar fins a cinc nivells de capçaleres per estructurar el contingut. Si heu posat més de tres capçaleres es genera automàticament una taula de continguts – aquesta funció pot ser desactivada incloent la següent cadena de text al document: ~~NOTOC~~.

3r. nivell de capçalera

4t. nivell de capçalera

5è. nivell de capçalera
==== 3r. nivell de capçalera ====
=== 4t. nivell de capçalera ===
== 5è. nivell de capçalera ==

Podeu fer una línia horitzontal posant quatre o més guionets:


Imatges i altres arxius

Podeu incloure imatges internes i externes usant claus dobles. Opcionalment, podeu indicar-ne la mida.

Mida natural:

Redimensionada a una amplada concreta:

Redimensionada a una amplada i una alçada concretes:

Imatge externa redimensionada:

Mida natural:                                         {{wiki:dokuwiki-128.png}}
Redimensionada a una amplada concreta:                {{wiki:dokuwiki-128.png?50}}
Redimensionada a una amplada i una alçada concretes:  {{wiki:dokuwiki-128.png?200x50}}
Imatge externa redimensionada:                        {{http://de3.php.net/images/php.gif?200x50}}

Els espais en blanc (abans, després o abans i després) permeten alinear la imatge.

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

Podeu afegir-hi també un títol, esclar (la majoria de navegadors el mostrarà com a indicador de funció).

Aquest és el títol

{{ wiki:dokuwiki-128.png |Aquest és el títol}}

Si especifiqueu un nom de fitxer (extern o intern) que no sigui una imatge (gif, jpeg, png), aleshores apareixerà com a enllaç.

Per enllaçar una imatge a una altra pàgina veieu Enllaços amb imatges, més amunt.

Llistes

Dokuwiki admet llistes numerades i sense numerar. Per creat un item d'una llista s'ha de sagnar el text amb dos espais inicials i posar un * per fer llistes sense numerar o un - per fer llistes numerades.

  • Això és una llista
  • El segon item
    • Poden haver-hi diversos nivells
  • Un altre item
  1. La mateixa llista però numerada
  2. Un altre item
    1. Useu més sagnat per fer nivells inferiors
  3. I ja està
  * Això és una llista
  * El segon item
    * Poden haver-hi diversos nivells
  * Un altre item

  - La mateixa llista però numerada
  - Un altre item
    - Useu més sagnat per fer nivells inferiors
  - I ja està

Emoticones

DokuWiki converteix les emoticones més usuals en els seus equivalents gràfics. Es poden posar més emoticones a la carpeta smiley i es poden configurar al fitxer conf/smileys.conf. Aquí teniu una mostra de les emoticones que inclou Dokuwiki.

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

Tipografia

DokuWiki pot fer la conversió de caràcters simples de text a les seves entitats tipogràfiques correctes. Aquí teniu un exemple dels caràcters reconeguts:

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

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

Fixeu-vos: Es poden desactivar aquestes convencions mitjançat una opció de configuració i un fitxer de patrons.

Citacions

Si voleu marcar algun text per que aparegui com a resposta o com a comentari, podeu usar la sintaxi següent:

Crec que hauríem de fer-ho

> No, jo opino que no

>> Bé, jo dic que sí

> De debò?

>> Sí!

>>> Doncs fem-ho!

Crec que hauríem de fer-ho

No, jo opino que no
Bé, jo dic que sí
De debò?
Sí!
Doncs fem-ho!

Taules

DokuWiki admet una sintaxi senzilla per crear taules.

Encapçalament 1 Encapçalament 2 Encapçalament 3
Fila 1 Columna 1 Fila 1 Columna 2 Fila 1 Columna 3
Fila 2 Columna 1 Columna doble (doble ratlleta)
Fila 3 Columna 1 Fila 2 Columna 2 Fila 2 Columna 3

Les files normals d'una taula han de començar i acabar amb una ratlleta vertical | i els encapçalaments amb circumflexos ^.

^ Encapçalament 1     ^ Encapçalament 2      ^ Encapçalament 3      ^
| Fila 1 Columna 1    | Fila 1 Columna 2     | Fila 1 Columna 3     |
| Fila 2 Columna 1    | Columna doble (doble ratlleta)             ||
| Fila 3 Columna 1    | Fila 2 Columna 2     | Fila 2 Columna 3     |

Per connectar cel·les horitzontalment simplement feu que la següent cel·la sigui buida (com a l'exemple anterior). Assegureu-vos de posar sempre el mateix número de separadors de cel·les a cada fila!

També es poden posar encapçalaments verticals.

Encapçalament 1 Encapçalament 2
Encapçalament 3 Fila 1 Columna 2 Fila 1 Columna 3
Encapçalament 4 ara no és doble
Encapçalament 5 Fila 2 Columna 2 Fila 2 Columna 3

Com podeu veure, el separador de cel·la de l'esquerra decideix el format de la cel·la que el segueix:

|                  ^ Encapçalament 1     ^ Encapçalament 2   ^
^ Encapçalament 3  | Fila 1 Columna 2    | Fila 1 Columna 3  |
^ Encapçalament 4  | ara no és doble     |                   |
^ Encapçalament 5  | Fila 2 Columna 2    | Fila 2 Columna 3  |

Nota: No es poden fer cel·les dobles verticalment.

També podeu aliniar el contingut de les taules. Simplement afegiu almenys dos espais en blanc al l'extrem contrari del text que vulgueu aliniar: dos espais a l'esquerra per aliniar a la dreta; dos espais a la dreta per a liniar a l'esquerra; i almenys dos espais a cada banda per centrar el text.

Taula amb aliniament
dreta centre esquerra
esquerra dreta centre
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Aquest és l'aspecte del codi font:

^           Taula amb aliniament           ^^^
|         dreta|    centre    |esquerra      |
|esquerra      |         dreta|    centre    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Blocs sense analitzar

Podeu incloure blocs de text sense analitzar dins dels documents. Teniu dues opcions: sagnar cada línia amb dos espais en blanc (com s'ha fet als exemples anteriors) o usar els marcadors code o file.

Aquest codi preformatat conserva els espais en blanc: com              <-aquests
Ve a ser més o menys el mateix, però podeu usar-lo per indicar que heu citat un fitxer.

Per fer que l'analitzador ignori completament una àrea (no interpretant-hi format), tanqueu-la entre etiquetes nowiki o, encara més senzill entre dobles signes de percentatge %%.

Aquest text conté adreces del tipus: http://www.splitbrain.org i **textos amb format**, però no són interpretats.

Veieu el codi font d'aquesta pàgina per veure com s'usen aquests blocs.

Realçat de sintaxi

DokuWiki pot realçar codi font perquè sigui més còmode de llegir. Per fer-ho utilitza el Realçador Genèric de Sintaxi GeSHi – així s'admet qualsevol llenguatge acceptat per GeSHi. La sintaxi és la mateixa que en el blocs de codi de la secció anterior, però ara s'insereix el nom del llenguatge de programació utilitzat dins l'etiqueta. Per exemple: <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.
    }
}

Es reconeixen les següents etiquetes de llenguatges de programació: actionscript-french, actionscript, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, bnf, caddcl, cadlisp, cfdg, cfm, c_mac, c, cpp, cpp-qt, csharp, css, delphi, diff, div, dos, d, eiffel, fortran, freebasic, gml, groovy, html, idl, ini, inno, io, java5, java, javascript, latex, lisp, lua, matlab, mirc, mpasm, mysql, nsis, objc, ocaml-brief, ocaml, oobas, oracle8, pascal, perl, 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

Agregació de canals RSS/ATOM

DokuWiki pot integrar dades de canals XML externs. Per analitzar els canals XML s'utilitza SimplePie. Tots els formats que entén SimplePie es poden usar igualment a Dokuwiki. Podeu variar la renderització usant diversos paràmetres separats amb espais:

Paràmetre Descripció
qualsevol número s'usarà com a màxim nombre d'items a mostrar, el valor predeterminat és 8
reverse mostra primer els darrers ítems del canal
author mostra el nom dels autors dels ítems
date mostra la data dels ítems
description mostra la descripció de l'ítem. Si està desactivat l'HTML es mostraran les etiquetes
n[dhm] periode de refresc, on d=dies, h=hores, m=minuts. (p.ex. 12h = 12 hores).

El periode de refresc predeterminat és de 4 hores. Qualsevol valor per sota de 10 minuts serà tractat com a 10 minuts. DokuWiki intentarà generalment oferir una versió en memòria cau de la pàgina. Obviament això no passarà quan la pàgina tingui contingut dinàmic extern. El paràmetre diu a DokuWiki que torni a renderitzar la pàgina si des de la darrera vegada que es va renderitzar ha transcorregut més temps que el periode de refresc.

Exemple:

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

HTML i PHP incrustat

Podeu incrustar codi HTML o PHP als documents usant les etiquetes html o php d'aquesta manera:

<html>
This is some <font color="red" size="+1">HTML</font>
</html>

This is some HTML

<php>
echo 'A logo generated by PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
</php>

A logo generated by PHP:PHP Logo !

Alerta: La característica d'incrustar HTML i PHP està desactivada per defecte a la configuració. Essent així, el codi és mostrat en lloc de ser executat.

Connectors de sintaxi

La sintaxi de DokuWiki pot ser ampliada amb connectors (plugins). La manera d'usar els connectors instal·lats s'explica a les seves pàgines de descripció. En aquesta instal·lació concreta de DokuWiki estan disponibles els següents connectors:

  • Note Plugin 2006-03-29 per Olivier Cortès / Eric Hameleers / Christopher Smith
    Add Note/Important/Tip/Warning Capability (DIV+CSS box)
  • Box Plugin 2008-03-03 per Christopher Smith
    Boxes with titles, colour and rounded corners.
    Syntax: <box width class colours|title> ... </box|caption>
    width, class, colours title & caption are optional.
    The title can include some wiki markup, the box
    contents can include almost any wiki markup.
  • addnewpage 20/12/2006 per iDo
    This add a "new page form" in your page. \ Syntax : {{NEWPAGE[>namespace]}} where [>namespace] is optional.
  • Info Plugin 2006-12-09 per Andreas Gohr
    Displays information about various DokuWiki internals

Referències

**EN ANGLÈS:** Formatting Syntax

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.

Basic text formatting

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.

Links

DokuWiki supports multiple ways of creating links.

External

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

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:

  • Links to existing pages are shown in a different style from nonexisting ones.
  • DokuWiki does not use CamelCase to automatically create links by default, but this behaviour can be enabled in the wiki:config file. Hint: If DokuWiki is a link, then it's enabled.
  • When a section's heading is changed, its bookmark changes, too. So don't rely on section linking too much.

Interwiki

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

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:

  • For security reasons direct browsing of windows shares only works in Microsoft Internet Explorer per default (and only in the “local zone”).
  • For Mozilla and Firefox it can be enabled through the config option security.checkloaduri but this is not recommended.
  • See 151 for more info.

Image Links

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

Footnotes

You can add footnotes 2) by using double parentheses.

You can add footnotes ((This is a footnote)) by using double parentheses.

Sectioning

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
==== Headline Level 3 ====
=== Headline Level 4 ===
== Headline Level 5 ==

By using four or more dashes, you can make a horizontal line:


Images and other files

You can include external and internal wiki:images with curly brackets. Optionally you can specify the size of them.

Real size:

Resize to given width:

Resize to given width and height:

Resized external image:

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.

This is the caption

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

Lists

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
  1. The same list but ordered
  2. Another item
    1. Just use indention for deeper levels
  3. That's it
  * 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

Smileys

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.

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

Typography

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.

Quoting

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!

Tables

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 |

Non-parsed Blocks

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.

Syntax Highlighting

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

RSS/ATOM Feed Aggregation

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

Embedding HTML and PHP

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>

A logo generated by PHP:PHP Logo !(inline HTML)

The same, but inside a block level element:PHP Logo !

Please Note: HTML and PHP embedding is disabled by default in the configuration. If disabled, the code is displayed instead of executed.

Control Macros

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

Syntax Plugins

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:

  • Note Plugin 2006-03-29 per Olivier Cortès / Eric Hameleers / Christopher Smith
    Add Note/Important/Tip/Warning Capability (DIV+CSS box)
  • Box Plugin 2008-03-03 per Christopher Smith
    Boxes with titles, colour and rounded corners.
    Syntax: <box width class colours|title> ... </box|caption>
    width, class, colours title & caption are optional.
    The title can include some wiki markup, the box
    contents can include almost any wiki markup.
  • addnewpage 20/12/2006 per iDo
    This add a "new page form" in your page. \ Syntax : {{NEWPAGE[>namespace]}} where [>namespace] is optional.
  • Info Plugin 2006-12-09 per Andreas Gohr
    Displays information about various DokuWiki internals
1) Això és una nota a peu de pàgina
2) This is a footnote
wiki/syntax.txt · Darrera modificació: 2008/05/12 15:43 per jbasela
Torna dalt
chimeric.de = chi`s home Creative Commons License Valid CSS Driven by DokuWiki do yourself a favour and use a real browser - get firefox!! Recent changes RSS feed Valid XHTML 1.0