Sintaxis de Formato
A continuación encontraréis la documentación sobre la sintaxis de formato de la wiki.
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 puedes usar a la hora de editar las páginas. Simplemente, observa el código de esta página pulsando sobre Editar esta página en la parte superior y en la parte inferior de la página. Si quieres intentar algo, usa la página de pruebas. Las marcas más simples también se encuentran accesibles mediante toolbar.
Páginas Wiki
Una página es el elemento central de una wiki. Todas las URLs en una wiki deberían llevar a una página de edición para que los usuarios puedan crear/editar/borrar libremente las páginas.
Ciclo de vida de una Página
¿Cómo añadir páginas?
En Dokuwiki las páginas son creadas como en cualquier otro wiki. Simplemente crea un enlace a una página no existente, sígue éste enlace y pulsa en Crear ésta página
. Esta es la forma más recomendable de hacerlo. Así te aseguras de que todas las páginas son enlazadas juntas correctamente y no se crean páginas huérfanas.
Metodos alternativos:
- Hacer una búsqueda de una nueva página, en la respuesta a la búsqueda, también da la opción de crearla.
- Copiar un archivo
.txt
a un directorio (namespace) donde quiera que resida.→ ./data/pages (servidor)
Editando una página
Para editar una página hacer click sobre el botón Edita esta página
, excepto en el caso de no existir este y en su lugar encontrar el botón Crear esta página
La creación de una página nos lleva directamente a una ventana de edición que permite introducir texto.
La función vista previa nos permite una edición más amigable.
Una vez tenemos la página terminada, pulsaremos el botón “Guardar”. Esto nos genera una página html.
De todas formas, adjuntamos un manual en formato pdf genérico sobre la wiki donde encontraremos un ejemplo de como crear páginas y contenido en la wiki. Manual de la Wiki para Viavox
Eliminando una página
Si guardamos una página vacía DokuWiki eliminará la página, y el pagename asociado.
Formato básico de texto
DokuWiki soporta negritas, cursivas, subrayados y texto monoespaciado
. Por supuesto, puedes combinarlos
todos.
DokuWiki soporta **negritas**, //cursivas//, __subrayados__ y texto ''monoespaciado''. Por supuesto, puedes **__//''combinarlos''//__** todos.
También puedes usar subíndices y superíndices.
También puedes usar <sub>subíndices</sub> y <sup>superíndices</sup>.
Del mismo modo, también puedes marcar algo como borrado.
Del mismo modo, también puedes marcar algo como <del>borrado</del>.
Los párrafos se crean a partir de líneas en blanco. Si quieres forzar un salto de línea sin un párrafo, puedes usar dos barras invertidas seguidas por un espacio en blanco o el final de la línea.
Esto es un texto con algunos saltos de línea.
Advierte que las
dos barras invertidas son reconocidas solamente al final de una línea
o cuando están seguidas de
un espacio en blanco \\Esto sucede sin él.
Esto es un texto con algunos saltos de línea.\\ Advierte que las dos barras invertidas son reconocidas solamente al final de una línea\\ o cuando están seguidas de\\ un espacio en blanco \\Esto sucede sin él.
Solamente deberías forzar saltos de línea cuando realmente lo necesites.
Enlaces
DokuWiki soporta múltiples formas de crear enlaces.
Externos
Los enlaces externos se reconocen automáticamente: http://www.google.com o simplemente www.google.com - También puedes establecer enlaces con un nombre: Este enlace apunta a google. Las direcciones de correo electrónico como ésta: andi@splitbrain.org también son reconocidas.
Dokuwiki soporta múltiples formas de crear enlaces. Los enlaces externos se reconocen automáticamente: http://www.google.com o simplemente www.google.com - También puedes establecer enlaces con nombre: [[http://www.google.com|Este enlace apunta a google]]. Las direcciones de correo electrónico como ésta: <andi@splitbrain.org> también son reconocidas.
Internos
Los enlaces internos se crean mediante corchetes. Puedes tanto simplemente usar pagename como usar el extendidoTexto de título. Los nombres de páginas wiki son convertidos a minúsculas automáticamente y no se permiten caracteres especiales.
Los enlaces internos se crean mediante corchetes. Puedes tanto simplemente usar [[doku>pagename]] como usar el extendido[[doku>pagename|Texto de título]]. Los nombres de páginas wiki son convertidos a minúsculas automáticamente y no se permiten caracteres especiales.
Puedes usar namespaces mediante dos puntos en el nombre de la página.
Puedes usar [[namespaces]] mediante dos puntos en el nombre de la página.
Para más detalles sobre espacios de nombres mira namespaces.
Es también posible enlazar con una sección específica. Basta con 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 [[syntax#internos|Esta sección]].
Notas:
- Los enlaces a páginas existentes se muestran de forma diferente a los no existentes.
- Cuando se cambia el encabezamiento de una sección, su bookmark también cambia. Así que no dependas demasiado del enlace de secciones.
Interwiki
DokuWiki permite enlaces interwiki. Estos son enlaces rápidos a otros Wikis. Por ejemplo, esto es un enlace a la página de la Wikipedia sobre Wikis: Wiki.
DokuWiki permite enlaces [[doku>interwiki]]. Estos son enlaces rápidos a otros Wikis. Por ejemplo, esto es un enlace a la página web de la Wikipedia sobre Wikis: [[wp>Wiki]].
Recursos compartidos de Windows
Los recursos compartidos de Windows como este también son reconocidos. Por favor, date cuenta de que éstos solamente tienen sentido en un grupo de usuarios homogéneo, tales como una Intranet corporativa.
Los recursos compartidos de Windows como [[\\server\share|este]] también son reconocidos.
Nota:
- Por motivos de seguridad, la navegación directa por recursos compartidos solamente funciona en Microsoft Internet Explorer.
- Para Mozilla y Firefox puede ser habilitada a través de una opción de configuración security.checkloaduri pero no es recomendado.
- Ver 151 para más información.
Enlaces imagen
También puedes usar una imagen como enlace a otra página externa o interna combinando la sintaxis de enlaces e imágenes (ver abajo) así:
[[http://www.php.net|{{wiki:dokuwiki-128.png}}]]
Por favor, ten en cuenta que el formato de imagen es la única sintaxis de formato aceptada en los nombres de enlace.
Está soportada la sintaxis completa de imagen y enlace (incluyendo modificar el tamaño de la imagen, e imágenes, URLs y enlaces interwiki internas y externas).
Notas al pie
Puedes añadir notas al pie 1) usando paréntesis dobles.
Puedes añadir notas al pie ((Esto es una nota al pie)) usando paréntesis dobles.
Secciones
Puedes usar hasta cinco niveles de encabezado distintos para estructurar tus contenidos. Si tienes más de tres encabezados, un índice se genera automáticamente – se puede deshabilitar incluyendo la cadena ~~NOTOC~~
en el documento.
Titular Nivel 3
Titular Nivel 4
Titular Nivel 5
==== Titular Nivel 3 ==== === Titular Nivel 4 === == Titular Nivel 5 ==
Usando cuatro o más guiones, puedes hacer una línea horizontal:
Imágenes y otros ficheros
Puedes incluir imágenes externas e internas usando llaves. De manera opcional, puede especificar sus tamaños.
Redimensionando altura y ancho:
Imagen externa redimensionada:
Tamaño real: {{wiki:dokuwiki-128.png}} Redimensionando la anchura: {{wiki:dokuwiki-128.png?50}} Redimensionando altura y anchura: {{wiki:dokuwiki-128.png?200x50}} Imagen externa redimensionada: {{http://de3.php.net/images/php.gif?200x50}}
Usando espacios en blanco a derecha o izquierda puedes escoger el alineamiento:
{{ wiki:dokuwiki-128.png}} {{wiki:dokuwiki-128.png }} {{ wiki:dokuwiki-128.png }}
Naturalmente, también puedes añadir un título (se muestra como tooltip en la mayoría de los navegadores).
{{ wiki:dokuwiki-128.png |Este es el título}}
Si especificas un nombre de fichero (externo o interno) que no es una imagen (gif,jpeg,png
), entonces será mostrado como un enlace.
Para enlazar una imagen a otra página ver mas arriba en Enlaces imagen.
Para la publicación de documentos como pdf, docx, pptx.. primero tendremos que tener dicho documento guardado en media en la sección correspondiente.
Después tendríamos que incorporar un enlace como las imagenes con la ruta de la imagen dentro del árbol en media.
EJ: : Club de descuentos para empleados y familiares de Viavox 2024
Listas
Dokuwiki soporta listas ordenadas y desordenadas. Para crear un elemento de lista, indenta tu texto con dos espacios y usa un *
para listas desordenadas o un -
para las listas ordenadas.
- Esto es una lista
- El segundo elemento
- Puedes tener diferentes niveles
- Otro elemento
- La misma lista pero ordenada
- Otro elemento
- Basta con usar sangría para obtener niveles más anidados
- Eso es
* Esto es una lista * El segundo elemento * Puedes tener diferentes niveles * Otro elemento - La misma lista pero ordenada - Otro elemento - Basta con usar indentación para obtener niveles más anidados - Eso es
Smileys
DokuWiki convierte los emoticonos usados habitualmente a sus equivalentes gráficos. Se pueden poner más smileys en el directorio smiley
y configurarlos en el fichero conf/smileys.conf
. Aquí tienes los Smileys incluidos en DokuWiki.
- 8-)
- 8-O
- :-(
- :-)
- =)
- :-/
- :-\
- :-?
- :-D
- :-P
- :-O
- :-X
- :-|
- ;-)
- ^_^
- :?:
- :!:
- LOL
- FIXME
- DELETEME
Tipografía
DokuWiki puede convertir caracteres de texto simples a su tipografía correcta. Aquí tienes un ejemplo de caracteres reconocidos.
→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “El pensó 'It's a man's world'…”
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r) "El pensó 'It's a man's world'..."
Por favor, advierte: Estas conversiones pueden ser deshabilitadas en las opciones de configuración.
Citas
A veces desea marcar algún texto para indicar que es una respuesta o comentario. Puede usar la siguiente sintaxis:
Pienso que deberíamos hacerlo > No deberíamos >> Bueno, yo digo que deberíamos > En serio? >> Si! >>> Entonces hagámoslo!
Pienso que deberíamos hacerlo
No deberíamos
Bueno, yo digo que deberíamos
En serio?
Si!
Entonces hagámoslo!
Tablas
DokuWiki soporta una sintaxis simple para crear tablas.
Encabezado 1 | Encabezado 2 | Encabezado |
---|---|---|
Fila 1 Col 1 | Fila 1 Col 2 | Fila 1 Col 3 |
Fila 2 Col 1 | una combinación(mira la barra doble) | |
Fila 3 Col 1 | Fila 2 Col 2 | Fila 2 Col 3 |
Las filas tienen que empezar y terminar con un |
para las filas normales o con un ^
para los encabezados.
^ Encabezado 1 ^ Encabezado 2 ^ Encabezado ^ | Fila 1 Col 1 | Fila 1 Col 2 | Fila 1 Col 3 | | Fila 2 Col 1 | una combinación(mira la barra doble)|| | Fila 3 Col 1 | Fila 2 Col 2 | Fila 2 Col 3 |
Para conectar celdas horizontalmente, haz la celda siguiente completamente vacía como se muestra arriba. ¡Asegúrate de tener siempre el mismo número de separadores de celda!
Los encabezados verticales también son posibles.
Encabezado 1 | Encabezado 2 | |
---|---|---|
Encabezado 3 | Fila 1 Col 2 | Fila 1 Col 3 |
Encabezado 4 | Sin combinación ahora | |
Encabezado 5 | Fila 2 Columna 2 | Fila 2 Columna 3 |
Como puedes ver, el separador de celda antes de una celda es quien decide cómo es el formato:
| ^ Encabezado 1 ^ Encabezado 2 ^ ^ Encabezado 3 | Fila 1 Col 2 | Fila 1 Col 3 | ^ Encabezado 4 | Sin combinación ahora| | ^ Encabezado 5 | Fila 2 Columna 2 | Fila 2 Columna 3 |
Puedes combinar celdas verticalmente (rowspans) añadiendo :::
en las celdas debajo de la que deseas combinar.
Encabezado 1 | Encabezado 2 | Encabezado 3 |
---|---|---|
Fila 1 Columna 1 | Esta celda se combina verticalmente | Fila 1 Columna 3 |
Fila 2 Columna 1 | Fila 2 Columna 3 | |
Fila 3 Columna 1 | Fila 2 Columna 3 |
^Encabezado 1 ^Encabezado 2 ^Encabezado 3 ^ |Fila 1 Columna 1 |Esta celda se combina verticalmente |Fila 1 Columna 3 | |Fila 2 Columna 1 |::: |Fila 2 Columna 3 | |Fila 3 Columna 1 |::: |Fila 2 Columna 3 |
También puedes alinear los contenidos de la tabla. Basta con añadir al menos dos espacios en blanco en el lado opuesto de tu texto: Añade dos espacios a la izquierda para alinear a la derecha, dos espacios a la derecha para alinear a la izquierda y dos espacios en cada extremo para obtener texto centrado.
Tabla con alineamiento | ||
---|---|---|
derecha | centro | izquierda |
izquierda | derecha | centro |
xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx8 |
Así es como aparece en el fuente:
^ Tabla con alineamiento ^^^ | derecha| centro |izquierda | |izquierda | derecha| centro | | xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Bloques no analizados
Puedes incluir en tus documentos bloques sin analizar tanto intentando con al menos dos espacios (como se ha usado en los ejemplos anteriores) o usando las etiquetas code
or file
.
Esto es código preformateado, todos los espacios se preservan: como <-este
Esto es muy parecido, pero podrías usarlo para indicar que estás mostrando un fichero.
Para que el analizador ignore por completo una zona (es decir, no le aplique ningún formato), encierra el área entre etiquetas nowiki
o, incluso más simple, con signos de porcentaje duplicados %%
.
Esto es un texto que contiene direcciones como ésta: http://www.splitbrain.org y **formatos**, pero no se hace nada con ellos.
Echa un vistazo al fuente de esta página para ver cómo usar estos bloques.
Resaltado de Sintaxis
DokuWiki puede resaltar el código fuente, que lo hace más sencillo de leer. Usa GeSHi Generic Syntax Highlighter – por lo que cualquier lenguaje soportado por GeSHi es soportado. La sintaxis es muy parecida a la del bloque de código de la sección anterior, pero esta vez el nombre del lenguaje utilizado se inserta dentro de la etiqueta. Por ej. <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. } }
Los lenguajes siguientes son reconocidos actualmente: actionscript, actionscript-french, ada, apache, applescript, asm, asp, autoit, bash, blitzbasic, caddcl, cadlisp, c, c_mac, cfm, cpp, csharp, css, delphi, diff, d, div, dos, eiffel, freebasic, gml, groovy, html4strict, ini, inno, java, java5, javascript, lisp, lua, matlab, mpasm, mysql, nsis, objc, ocaml, ocaml-brief, oobas, oracle8, pascal, perl, php-brief, php, python, qbasic, scheme, sdlbasic, smalltalk, smarty, sql, tcl, text, tsql, reg, robots, ruby, vb, vbnet, vhdl, visualfoxpro, winbatch, xml
Agregar fuentes RSS/ATOM
DokuWiki puede integrar información de fuentes XML externas. Para procesar las fuentes XML, se ocupa SimplePie. Todos los formatos entendidos por SimplePie, pueden usarse también en DocuWiki. Se puede afectar el despliegue por medio de varios parámetros separados por espacios:
Parámetro | Descripción |
---|---|
cualquier número | número de artículos a mostrar como máximo; por omisión, 8 |
reverse | mostrar los últimos artículos al principio |
author | mostrar los nombres de los autores de los artículos |
date | mostrar las fechas de los artículos |
description | mostrar las descripciones de los artículos. Si el HTML está deshabilitado, toda etiqueta se rasurará |
n[dhm] | periodo de actualización, donde d=días, h=horas, m=minutos. (ej. 12h = 12 horas). |
El periodo de actualización por omisión es de 4 horas. Cualquier valor menor a 10 minutos será tratado como 10 minutos. DokuWiki generalmente tratará de entregar una versión en caché de la página; obviamente esto no es apropiado cuando la página incluye contenido dinámico externo. El parámetro le dice a DokuWiki que regenere la página si hace más de periodo de actualización desde que la página se generó por última vez.
Ejemplo:
{{rss>http://barrapunto.com/index.rss 10 author date 2h }}
- An error occurred while fetching this feed: http://barrapunto.com/index.rss
Incrustar HTML y PHP
Puedes incrustar código HTML o PHP puro en tus documentos usando las etiquetas html
o php
de este modo:
<html> Esto es <font color="red" size="+1">HTML</font> </html>
<html> Esto es <font color=“red” size=“+1”>HTML</font> </html>
<php> echo 'Un logo generado por PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; </php>
<php> echo 'Un logo generado por PHP:'; echo '<img src=“' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '” alt=“PHP Logo !” />'; </php>
Por favor observa: La inclusión de HTML y PHP se encuentra deshabilitada predeterminadamente en la configuración. Si se encuentra deshabilitado, el código se muestra en lugar de ejecutarse.
Macros de Control
Algunas expresiones afectan la manera en que DokuWiki despliega una página, sin producir una salida per se. Se cuenta con las siguientes macros de control:
Macro | Descripción |
---|---|
~~NOTOC~~ | Si esta macro se encuentra en la página, no se generará una tabla de contenidos |
~~NOCACHE~~ | DokuWiki, por omisión, hace un caché de todo lo que despliega. A veces esto no es deseable (por ejemplo, cuando se usa la sintaxis <php> descrita arriba); añadir esta macro forzará a DokuWiki a regenerar la página cada vez que sea solicitada |
Plugins de Sintaxis
La sintaxis de DokuWiki puede extenderse con Plugins. Como se usan los plugin instalados se describe en sus correspondientes páginas descriptivas. Los siguientes plugins de sintaxis están disponibles en esta particular instalación de DokuWiki:
- Ad-Hoc HTML Plugin 2023-10-14 by Sascha Leib
(Formerly: Ad Hoc Tags) A secure but flexible way to insert HTML tags into DokuWiki - Ad-Hoc Wrap Plugin 2023-04-05 by Sascha Leib
Replacing the WRAP plugin, building upon the code already present in the "Ad Hoc Tags" plugin (under development!) - ifauthex plugin 2023-02-08 by Pietro Saccardi
Toggle DokuWiki page content based on users and groups with arbitrary boolean expressions. - include plugin 2023-09-22 by Michael Hamann, Gina Häussge, Christopher Smith, Michael Klier, Esther Brunner
Functions to include another page in a wiki page - Mikio plugin 2023-10-16 by James Collins
Mikio Plugin adds a heap of layout and Bootstrap 4 elements that can be used on your DokuWiki pages - nspages plugin 2023-09-16 by Guillaume Turri
Presents a toc of the selected namespace using <nspages> - Wrap Plugin 2023-08-13 by 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.