Sintaxis de formato
DokuWiki soporta un lenguaje de marcas simple, que intenta hacer los ficheros de datos tan legibles como sea posible. Esta página contiene todas las posibles opciones que puede utilizar al editar las páginas. Basta echar un vistazo a la fuente de esta página pulsando “Editar esta página”. Si quieres probar algo, sólo tienes que utilizar la página de la guardería.
Las marcas más simples también están accesibles fácilmente a través de los botones de la barra de herramientas.
Formato de texto básico
DokuWiki soporta remarcar textos en negrita, cursiva, subrayado y mono espaciado
. Por supuesto puedes combinarlos
.
DokuWiki soporta textos en **negrita**, //cursiva//, __subrayado__ y ''mono espaciado''. Por supuesto puedes **__//''combinarlos''//__**.
Puedes usar también subíndices y superíndices.
Puedes usar también <sub>subíndices</sub> y <sup>superíndices</sup>.
También puedes marcar con tachaduras.
También puedes marcar con <del>tachaduras</del>.
Párrafos. Los párrafos son creados con líneas en blanco. Si quieres forzar una línea nueva sin crear un nuevo párrafo, puedes usar 2 barras invertidas seguidas de un espacio en blanco al final de la línea.
Este texto posee varios saltos de línea
Fíjate que las
dos barras invertidas son reconocidas solamente al final de una línea
o seguidas por
un espacio en blanco \\esto sucede sin él.
Este texto posee varios saltos de línea\\ Fíjate que las dos barras invertidas son reconocidas solamente al final de una línea\\ o seguidas por\\ un espacio en blanco \\esto sucede sin él.
Debes forzar saltos de línea sólo si realmente los necesitas.
Enlaces
DokuWiki puede crear enlaces de varias maneras.
Externos
Los enlaces externos son reconocidos automaticamente: http://www.google.com o simplemente www.google.com - Puedes también ponerlo de esta forma: Este enlace apunta a Google. Las direcciones de correo electrónico como esta: andi@splitbrain.org también son reconocidas.
Los enlaces externos son reconocidos automaticamente: http://www.google.com o simplemente www.google.com - Puedes también ponerlo de esta forma: [[http://www.google.com|Este enlace apunta a Google]]. Las direcciones de correo electrónico como esta: <andi@splitbrain.org> también son reconocidas.
Internos
Los enlaces internos se crean mediante corchetes. Puedes dar simplemente un nombre_de_la_pagina o usar un texto del enlace.
Los enlaces internos se crean mediante corchetes. Puedes dar simplemente un [[nombre_de_la_pagina]] o usar un [[nombre_de_la_pagina | texto del enlace]].
Los nombres de la páginas Wiki son convertidas automaticamente a minúsculas, no permitiéndose caracteres especiales.
Puedes utilizar namespaces mediante el uso de dos puntos en el nombre de la página.
Puedes utilizar [[some:namespaces]] mediante el uso de dos puntos en el nombre de la página.
Para más detalles acerca de los namespaces mira namespaces.
También es posible enlazar a una sección específica. Para ello tienes que añadir el nombre de sección detrás de una almohadilla, como se hace en HTML. Esto enlaza a esta sección.
Esto enlaza a [[02_syntax#internos|esta sección]].
Notas
- Los enlaces a paginas existentes se muestran en un estilo diferente de las inexistentes.
- Cuando se cambia el encabezado de una sección, su bookmark a utilizar para los enlaces también cambia. Por ello, cuidado con los enlaces a ella creados en otras secciones.
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>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 homogeneous 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 different workaround mentioned in the Mozilla Knowledge Base. However, there will still be a JavaScript warning about trying to open a Windows Share. To remove this warning (for all users), put the following line in
conf/userscript.js
:
LANG.nosmblinks = '';
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 1) 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:
Media Files
You can include external and internal images, videos and audio files with curly brackets. Optionally you can specify the size of them.
Resize to given width and height2):
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}}
For linking an image to another page see Image Links above.
Supported Media Formats
DokuWiki can embed the following media formats directly.
Image | gif , jpg , png |
Video | webm , ogv , mp4 |
Audio | ogg , mp3 , wav |
Flash | swf |
If you specify a filename that is not a supported media format, then it will be displayed as a link instead.
Fallback Formats
Unfortunately not all browsers understand all video and audio formats. To mitigate the problem, you can upload your file in different formats for maximum browser compatibility.
For example consider this embedded mp4 video:
{{video.mp4|A funny video}}
When you upload a video.webm
and video.ogv
next to the referenced video.mp4
, DokuWiki will automatically add them as alternatives so that one of the three files is understood by your browser.
Additionally DokuWiki supports a “poster” image which will be shown before the video has started. That image needs to have the same filename as the video and be either a jpg or png file. In the example above a video.jpg
file would work.
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
- The same list but ordered
- Another item
- Just use indention for deeper levels
- 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
Also take a look at the FAQ on list items.
Text Conversions
DokuWiki can convert certain pre-defined characters or strings into images or other text or HTML.
The text to image conversion is mainly done for smileys. And the text to HTML conversion is used for typography replacements, but can be configured to use other HTML as well.
Text to Image Conversions
DokuWiki converts commonly used emoticons to their graphical equivalents. Those Smileys and other images can be configured and extended. Here is an overview of Smileys included in DokuWiki:
- 8-)
- 8-O
- :-(
- :-)
- =)
- :-/
- :-\
- :-?
- :-D
- :-P
- :-O
- :-X
- :-|
- ;-)
- ^_^
- :?:
- :!:
- LOL
- FIXME
- DELETEME
Text to HTML Conversions
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'..."
The same can be done to produce any kind of HTML, it just needs to be added to the pattern file.
There are three exceptions which do not come from that pattern file: multiplication entity (640×480), 'single' and “double quotes”. They can be turned off through a config option.
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 3 Col 2 | Row 3 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 3 Col 2 | Row 3 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 |
You can have rowspans (vertically connected cells) by adding :::
into the cells below the one to which they should connect.
Heading 1 | Heading 2 | Heading 3 |
---|---|---|
Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 |
Row 2 Col 1 | Row 2 Col 3 | |
Row 3 Col 1 | Row 2 Col 3 |
Apart from the rowspan syntax those cells should not contain anything else.
^ Heading 1 ^ Heading 2 ^ Heading 3 ^ | Row 1 Col 1 | this cell spans vertically | Row 1 Col 3 | | Row 2 Col 1 | ::: | Row 2 Col 3 | | Row 3 Col 1 | ::: | Row 2 Col 3 |
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 |
Note: Vertical alignment is not supported.
No Formatting
If you need to display text exactly like it is typed (without any formatting), 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. The same is true for //__this__ text// with a smiley ;-).
<nowiki> This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it. </nowiki> The same is true for %%//__this__ text// with a smiley ;-)%%.
Code Blocks
You can include code 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 text is indented by two spaces.
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.
Those blocks were created by this source:
This is text is indented by two spaces.
<code> This is preformatted code all spaces are preserved: like <-this </code>
<file> This is pretty much the same, but you could use it to show that you quoted a file. </file>
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 uses the same code and file blocks described in the previous section, but this time the name of the language syntax to be highlighted is included inside the tag, e.g. <code java>
or <file 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: 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
Downloadable Code Blocks
When you use the <code>
or <file>
syntax as above, you might want to make the shown code available for download as well. You can do this by specifying a file name after language code like this:
<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>
.
Incrustando HTML y PHP
Puedes incrustar código HTML o PHP tal cual, en tus documentos, usando las etiquetas <html>
o <php>
. Utiliza las etiquetas en mayúsculas si necesitas adjuntar elementos a nivel de bloque.
Ejemplo HTML
<html> Esto es algo de <span style="color:red;font-size:150%;">HTML en una línea</span> </html> <HTML> <p style="border:2px dashed red;">Y esto es algo de HTML en bloque</p> </HTML>
<html> Esto es algo de HTML en una línea </html> <HTML> <p style=“border:2px dashed red;”>Y esto es algo de HTML en bloque</p> </HTML>
Ejemplo PHP
<php> echo 'Versión PHP: '; echo phpversion(); echo ' (generated inline HTML)'; </php> <PHP> echo '<table class="inline"><tr><td>Lo mismo, pero dentro de un elemento a nivel de bloque:</td>'; echo '<td>'.phpversion().'</td>'; echo '</tr></table>'; </PHP>
<php> echo 'Versión PHP: '; echo phpversion(); echo ' (inline HTML)'; </php> <PHP> echo '<table class=“inline”><tr><td>Lo mismo, pero dentro de un elemento a nivel de bloque:</td>'; echo '<td>'.phpversion().'</td>'; echo '</tr></table>'; </PHP>
Nota. El incrustado de HTML y PHP está desactivado por defecto en la configuración. Esto hace que se muestre el código en lugar de ejecutarse.
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 }}
- Is Your Master's Degree Useless? por msmash (2024/11/21 17:01)
- The Growth Rate For Mobile Internet Subscribers Has Stalled Across the World por msmash (2024/11/21 16:23)
- Steam Tightens Rules on Game Season Passes por msmash (2024/11/21 15:42)
- OpenAI Accidentally Deleted Potential Evidence in New York Times Copyright Lawsuit por msmash (2024/11/21 15:04)
- NASA Wants SpaceX and Blue Origin To Deliver Cargo To the Moon por BeauHD (2024/11/21 12:00)
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:
- include plugin 2023-09-22 por Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
Functions to include another page in a wiki page - keyboard 2023-02-23 por Gina Häußge
The keyboard plugin provides a combined syntax and action plugin in order to markup text as keyboard keys, similar to (and making use of) the existing (X)HTML tag <kbd>…</kbd>. A quick button for the markup is automatically inserted into the toolbar of the edit form. - Math Plugin 2024-05-23 por Christopher Smith
Add mathematical formulae to dokuwiki. Syntax: <m size>math formulae</m> - Open Document Plugin 2023-03-03 por Andreas Gohr, Aurelien Bompard, Florian Lamml, LarsDW223
Export the current Wiki page to a OpenOffice ODT file - Video Sharing Site Plugin 2024-03-24 por Andreas Gohr
Easily embed videos from various Video Sharing sites. Example: {{youtube>XXXXXX}} - Wrap Plugin 2023-08-13 por Anika Henke
Universal plugin which combines functionalities of many other plugins. Wrap wiki text inside containers (divs or spans) and give them a class (choose from a variety of preset classes), a width and/or a language with its associated text direction.