Table of Contents

Sintaxe de Formatação

O Dokuwiki suporta algumas linguagens de marcação bem simples que procuram fazer com que os arquivos de dados sejam o mais legíveis possível. Esta página contém todos os comandos disponíveis que você poderá usar para editar as páginas. Veja o código-fonte, clicando no botão Editar esta página no topo ou no rodapé da página. Se quiser treinar, use a página playground. As marcações mais simples também são acessíveis através da barra de botões.

Formatação Básica de Texto

O Dokuwiki suporta textos em negrito, itálico, sublinhado e mono espaçado. Obviamente, você poderá combinar todos os formatos.

O Dokuwiki suporta textos em **negrito**, 
//itálico//, __sublinhado__ e ''mono espaçado''.
Obviamente, você poderá **__//''combinar''//__** 
todos os formatos.

Você também pode usar texto subscrito e texto sobrescrito.

Você também pode usar <sub>texto subscrito</sub> e <sup>texto sobrescrito</sup>.

Você poderá marcar algo como tachado.

Você poderá marcar algo como <del>tachado</del>.

Parágrafos são criados a partir de linhas em branco. Se quiser forçar a quebra de linha sem um novo parágrafo, você poderá usar duas barras (\\) seguidas do fim da linha ou de um espaço em branco.

Este é um texto com algumas quebras de linha
Note que as duas barras (\\) são reconhecidas apenas no fim da linha
ou seguidas por
um espaço \\isto que acontece sem o espaço.

Este é um texto com algumas quebras de linha\\ Note que as
duas barras (\\) são reconhecidas apenas no fim da linha\\
ou seguidas por\\ um espaço \\isto que acontece sem o espaço.

Você deve forçar as quebras de linha apenas quando necessário.

O Dokuwiki suporta múltiplas formas de criar ligações entre páginas (links).

Externos

Links externos são reconhecidos automaticamente: http://www.google.com ou simplesmente www.google.com - Você também pode rotular os links: Este link aponta para o Google. Endereços de e-mail como este: andi@splitbrain.org também são reconhecidos automaticamente.

Links externos são reconhecidos automaticamente: http://www.google.com
ou simplesmente www.google.com - Você também pode rotular os links:
[[http://www.google.com|Este link aponta para o Google]]. 
Endereços de e-mail como este: <andi@splitbrain.org> 
também são reconhecidos automaticamente.

Internos

Links internos são criados usando colchetes. Você pode apenas fornecer o nome da página ou usar uma descrição adicional Título da Página. Os nomes das páginas wiki são convertidos para minúsculo automaticamente e caracteres especiais(espaço, acentos e pontuação) não são permitidos.

Links internos são criados usando colchetes. Você pode apenas fornecer
o [[doku>wiki:nome_da_pagina]] ou usar uma descrição adicional
[[doku>wiki:nome_da_pagina|Título da Página]]. Os nomes das páginas 
wiki são convertidos para minúsculo automaticamente e 
caracteres especiais(espaço, acentos e pontuação) não são permitidos. 

Você pode usar namespaces acrescentando : (dois-pontos) ao nome da página.

Você pode usar [[namespaces:]] acrescentando : (dois-pontos) ao nome da página.

Namespaces são diretórios de páginas usados para organizar e evitar que páginas com o mesmo nome entrem em conflito. Clique aqui para saber mais sobre namespaces.

É possível apontar um link para uma seção específica da página. Basta adicionar o nome da seção após um caractere de cerquilha (#) igual como é no HTML. Este link aponta para seção Internos.

Este link aponta para [[#internos|seção Internos]].

Notas:

Interwiki

O Dokuwiki suporta links Interwiki, que são links rápidos com outros wikis. Este é um exemplo de link para a página sobre Wikis da Wikipedia: Wiki.

O Dokuwiki suporta links [[doku>wiki:interwiki|Interwiki]], que são
links rápidos com outros wikis. Este é um exemplo de link para a 
página sobre Wikis da Wikipedia: [[wp>Wiki]].

Você também poderá usar uma imagem para linkar outra página interna ou externa combinando a sintaxe de links e de imagens (veja abaixo) desta forma:

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

Importante: A formatação de imagem é a única sintaxe de formatação aceita nos nomes de links.

A sintaxe completa de imagem e de link é suportada. (incluindo redimensionamento de imagens, imagens internas e externas e links para URLs e interwiki).

Notas de Rodapé

Você pode adicionar notas de rodapé 1) usando parênteses duplos.

Você pode adicionar notas de rodapé ((Isto é uma nota de rodapé))
usando parênteses duplos.

Seções

Você pode usar até cinco diferentes níveis de títulos para estruturar o conteúdo. Com 3 ou mais níveis será automaticamente gerada uma Tabela de Conteúdos visível à direita do topo da página. A Tabela de Conteúdos poderá ser desabilitada, incluindo o comando ~~NOTOC~~ no documento.

O documento DokuWiki and Search Engine Optimization (SEO) recomenda que todo título de página seja definido com nível 1.

Título de nível 1

Título de nível 2

Título de nível 3

Título de nível 4

Título de nível 5
====== Título de nível 1 ======
===== Título de nível 2 =====
==== Título de nível 3 ====
=== Título de nível 4 ===
== Título de nível 5 ==

Para incluir uma linha horizontal como a abaixo digite 4 ou mais traços:


Imagens e Outros Arquivos

Você pode incluir imagens internas e externas usando chaves. Opcionalmente, o tamanho das imagens pode ser especificado.

Tamanho real:

Tamanho personalizado:

Redimensionar para uma largura ou largura específica2):

Imagem externa redimensionada:

Tamanho Real:                               {{wiki:dokuwiki-128.png}}
Redimensionada para uma largura específica: {{wiki:dokuwiki-128.png?50}}
Redimensionada para uma altura específica:  {{wiki:dokuwiki-128.png?200x50}}
Imagem externa redimensionada:              {{http://de3.php.net/images/php.gif?200x50}}

Usando espaços em branco na direita e na esquerda, você poderá mudar o alinhamento:

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

Obviamente, você também pode trocar o título da imagem (exibido como tooltip por muitos navegadores quando se pára o mouse sobre a imagem ou a imagem não é encontrada).

Este é o título

{{ wiki:dokuwiki-128.png |Este é o título}}

Se você especificar um nome de arquivo (externo ou interno) que não seja uma imagem (gif, jpeg, png), então o texto “Este é o título” será exibido como um link.

Para linkar uma imagem para outra página, veja o tópico Links com Imagens acima.

Arquivos PDF

Para abrir arquivos PDF, execute primeiro o upload com o Media Manager, programe a referência semelhante à das imagens. Por exemplo, se foi feito o upload do arquivo manual.pdf para \media\pdf, assim ficará a referência:

{{:pdf\manual.pdf|Manual do Sistema}}

Listas

O Dokuwiki suportas listas ordenadas (numeradas) e não-ordenadas. Para criar um item de listas, endente seu texto com dois espaços e use um *(asterísco) para listas não-ordenadas e um -(traço) para listas ordenadas.

  1. A mesma lista porém ordenada
  2. Outro Item
    1. Simplesmente use endentação para criar níveis
  3. Último item
  * Esta é uma lista
  * O segundo item
    * você pode ter diferentes níveis
  * Outro item

  - A mesma lista porém ordenada
  - Outro Item
    - Simplesmente use endentação para criar níveis
  - Último item

Veja também o FAQ de listas de itens.

Conversões de Texto

O DokuWiki pode converter certos caracteres ou textos predefinidos em imagens ou em outro texto ou em HTML.

A conversão de texto para imagem é feito principalmente para smileys(carinhas). E a conversão de texto para HTML é usado para substituição de tipografia, mas também pode ser configurada para usar outro HTML.

Conversão de Texto para Imagem

O DokuWiki produz os emoticons mais usados, convertendo em imagens os caracteres digitados no texto. Estes Smileys e outras imagens podem ser configurados e estendidos. Aqui está uma visão geral do que já está incluído:

Conversão de Texto para HTML

O Dokuwiki pode converter caracteres de texto simples em suas entidades tipograficamente corretas. Aqui está um exemplo de caracteres reconhecidos.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “Ele disse: 'Aquilo é um frango-d'água'…”

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"Ele disse: 'Aquilo é um frango-d'água'..."

Citações

Se precisar mostrar textos como diálogos igual ao abaixo, a sintaxe é a seguinte:

Eu pensei que nos deveríamos fazer isto

> Não, não deveríamos

>> Bem, eu disse que nós deveríamos

> Realmente?

>> Sim!

>>> Então vamos fazer isto!

Eu pensei que nos deveríamos fazer isto

Não, não deveríamos
Bem, eu disse que nós deveríamos
Realmente?
Sim!
Então vamos fazer isto!

Tabelas

O Dokuwiki disponibiliza uma sintaxe simples para criação de tabelas.

Cabeçalho 1 Cabeçalho 2 Cabeçalho 3
Linha 1 Coluna 1 Linha 1 Coluna 2 Linha 1 Coluna 3
Linha 2 Coluna 1 Linha mesclada (repare o pipeline duplo)
Linha 3 Coluna 1 Linha 3 Coluna 2 Linha 3 Coluna 3

Linhas de tabelas devem iniciar e terminar com um ^(circunflexo) para cabeçalhos e com um |(pipeline) para linhas de dados.

^ Cabeçalho 1       ^ Cabeçalho 2       ^ Cabeçalho 3           ^
| Linha 1 Coluna 1  | Linha 1 Coluna 2  | Linha 1 Coluna 3      |
| Linha 2 Coluna 1  | Linha mesclada (repare o pipeline duplo) ||
| Linha 3 Coluna 1  | Linha 3 Coluna 2  | Linha 3 Coluna 3      |

Para conectar células horizontalmente, apenas faça a próxima célula vazia como exibido abaixo. Certifique-se de que existe a mesma quantidade de separadores de células em todas as linhas!

Cabeçalhos verticais também são possíveis.

Cabeçalho 1 Cabeçalho 2
Cabeçalho 3 Linha 1 Coluna 3 Linha 1 Coluna 3
Cabeçalho 4 Sem mesclar dessa vez
Cabeçalho 5 Linha 2 Coluna 3 Linha 2 Coluna 3

Como você pode ver, é o separador de células anterior à célula que decide sobre a formatação:

|              ^ Cabeçalho 1           ^ Cabeçalho 2       ^
^ Cabeçalho 3  | Linha 1 Coluna 3      | Linha 1 Coluna 3  |
^ Cabeçalho 4  | Sem mesclar dessa vez |                   |
^ Cabeçalho 5  | Linha 2 Coluna 3      | Linha 2 Coluna 3  |

Você pode conectar células verticalmente adicionando ::: dentro das células abaixo da qual elas devem conectar.

Cabeçalho 1 Cabeçalho 2 Cabeçalho 3
Linha 1 Coluna 1 esta célula expande verticalmente Linha 1 Coluna 3
Linha 2 Coluna 1 Linha 2 Coluna 3
Linha 3 Coluna 1 Linha 2 Coluna 3

Estas células não deverão conter nada além da sintaxe de conexão vertical.

^ Cabeçalho 1          ^ Cabeçalho  2                       ^ Cabeçalho  3       ^
| Linha  1 Coluna 1    | esta célula expande verticalmente  | Linha  1 Coluna 3  |
| Linha  2 Coluna 1    | :::                                | Linha  2 Coluna 3  |
| Linha  3 Coluna 1    | :::                                | Linha  2 Coluna 3  |

Você também pode alinhar o conteúdo da tabela, adicionando dois espaços no lado oposto ao do alinhamento:

Tabela com alinhamento
direita centro esquerda
esquerda direita centro
xxxxxxxxxxxx xxxxxxxxxxxx xxxxxxxxxxxx

Assim que aparede no código-fonte:

^           Tabela com alinhamento         ^^^
|       direita|    centro    |esquerda      |
|esquerda      |       direita|    centro    |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |

Nota: Alinhamento vertical não é suportado.

Blocos não-interpretados

Se você precisar exibir um texto sem formatação exatamente como digitado, delimite o texto com a tag <nowiki>...</nowiki> ou simplesmente com dois caracteres de porcentagem %%...%%.

Este é um texto que contém endereços como este: http://www.Dokuwiki.com.br e **formatação**, mas nada é feito com eles. O mesmo acontece com //__este__ **texto**// com um smiley ;-).

<nowiki>
Este é um texto que contém endereços como este: http://www.Dokuwiki.com.br e   **formatação**, mas nada é feito com eles.
</nowiki>
O mesmo acontece com %%//__este__ **texto**// com um smiley ;-)%%.

Blocos de código

Você pode incluir blocos de código-fonte em seu documento endentando-os com dois espaços no início da linha(como nos exemplos anteriores) ou usando as tags code ou file.

Este é um código pré-formatado, todos os espaços são preservados: como     <- este
Este é exatamente o mesmo mas você deve usá-lo para dizer que citou um arquivo.  

Estes blocos foram criados pelo seguinte fonte:

<code>
Este é um código pré-formatado, todos os espaços são preservados: como     <-este
</code>
<file>
Este é exatamente o mesmo mas você deve usá-lo para dizer que citou um arquivo.  
</file>

Destaque de Sintaxe

DokuWiki pode destacar códigos-fonte para facilitar a sua leitura. Ele usa o GeSHi Generic Syntax Highlighter – portanto, qualquer linguagem suportada pelo GeSHi é suportada. A sintaxe é a mesma da dos blocos de código(code) e arquivo(file) da seção anterior, mas desta vez o nome da linguagem usada é inserida dentro da tag. Ex. <code java> ou <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.
    }
}

As seguintes linguagens são reconhecidas: abap, actionscript-french, actionscript, actionscript3, ada, apache, applescript, asm, asp, autoit, avisynth, bash, basic4gl, bf, bibtex, blitzbasic, bnf, boo, c, c_mac, caddcl, cadlisp, cfdg, cfm, cil, cmake, cobol, cpp, cpp-qt, csharp, css, d, dcs, delphi, diff, div, dos, dot, eiffel, email, erlang, fo, fortran, freebasic, genero, glsl, gml, gnuplot, groovy, gettext, haskell, hq9plus, html, idl, ini, inno, intercal, io, java5, java, javascript, kixtart, klonec, klonecpp, latex, lisp, locobasic, lolcode, lotusformulas, lotusscript, lscript, lsl2, lua, m68k, make, matlab, mirc, modula3, mpasm, mxml, mysql, nsis, oberon2, objc, ocaml-brief, ocaml, oobas, oracle8, oracle11, pascal, perl, per, php-brief, php, pic16, pixelbender, plsql, povray, powershell, progress, prolog, properties, providex, python, qbasic, rails, rebol, reg, robots, ruby, sas, scala, scheme, scilab, sdlbasic, smalltalk, smarty, sql, tcl, teraterm, text, thinbasic, tsql, typoscript, vbnet, vb, verilog, vhdl, vim, visualfoxpro, visualprolog, whitespace, winbatch, whois, xml, xorg_conf, xpp, z80

Blocos de Código Baixáveis

Quando você usa as sintaxes <code> ou <file> descritas acima, poderá desejar que o código-fonte exibido seja disponibilizado para download. Para isso deve especificar o nome do arquivo após o nome da linguagem de programação desta forma:

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

Se você não quiser nenhum destaque no código-fonte mas quiser que o arquivo seja baixável, troque o nome da linguagem de programação por um traço (-) assim: <code - exemplo.php> ou <file - exemplo.php>.

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

HTML e PHP embutido

Você pode embutir HTML e PHP puros dentro de seus documentos usando as tags <html> ou <php>. (Use tags maiúsculas se você precisar incluir níveis de blocos de elementos.)

Exemplo em HTML:

<html>
Este é um <span style="color:red;font-size:150%;">HTML em linha</span>
</html>
<HTML>
<p style="border:2px dashed red;">E este é um bloco HMTL</p>
</HTML>

Este é um <span style="color:red;font-size:150%;">HTML em linha</span>

<p style="border:2px dashed red;">E este é um bloco HMTL</p>

Exemplo em PHP:

<php>
echo 'Uma logo gerada pelp PHP:';
echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />';
echo '(HTML gerado em linha)';
</php>
<PHP>
echo '<table class="inline"><tr><td>O mesmo, mas dentro de um elemento de bloco de nível:</td>';
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';
echo '</tr></table>';
</PHP>

echo 'Uma logo gerada pelp PHP:'; echo '<img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" />'; echo '(HTML gerado em linha)';

echo '<table class="inline"><tr><td>O mesmo, mas dentro de um elemento de bloco de nível:</td>';
echo '<td><img src="' . $_SERVER['PHP_SELF'] . '?=' . php_logo_guid() . '" alt="PHP Logo !" /></td>';
echo '</tr></table>';

Nota: HTML e PHP embutidos ficam desabilitados por padrão na configuração. Quando desabilitados, o código é exibido ao invés de executado. Se quiser habilitá-los, vá em Administrar → Configurações do DokuWiki → Configurações de edição e marque Permitir incorporação de HTML (htmlok) e Permitir incorporação de PHP (phpok).

RSS/ATOM Feed Aggregation

O Dokuwiki pode integrar com dados externos de XML feeds. O SimplePie é usado para interpretar os XML feeds. Todos os formatos suportados pelo SimplePie podem ser usados no Dokuwiki. Você pode influenciar na interpretação através de múltiplos parâmetros adicionais separados por espaço:

Parâmetro Descrição
número itens será usado como máximo de itens a serem exibidos, o padrão é 8
reverse exibe os últimos itens no início na lista
author exibe os nome dos autores dos itens
date exibe as datas dos itens
description exibe a descrição do item. Se HTML estiver desabilitado todas as tags serão removidas
n[dhm] período de atualização, onde d=dias, h=horas, m=minutos. (ex. 12h = 12 horas).

O período de atualização por padrão é 4 horas. Qualquer valor abaixo de 10 minutos será tratado como 10 minutos. O Dokuwiki geralmente vai tentar fornecer uma versão do cache da página, claro que isto é inapropriado quando a página contém conteúdo externo dinâmico. Os parâmetros falam pro Dokuwiki recarregar a página se tiver um perído maior que o período de atualização desde a última carga.

Exemplo:

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

Comandos de Controle

Alguns comandos influenciam em como o DokuWiki monta a página sem criar nenhuma informação visível para o leitor. Os seguintes comandos de controle estão disponíveis:

Comando Descrição
~~NOTOC~~ Se este controle for encontrado na página, a Tabela de Conteúdos não será criada
~~NOCACHE~~ O DokuWiki faz cache de todas as páginas por padrão. Em alguns casos isto pode não ser desejável. Adicionar este controle forçará o DokuWiki a interpretar a página em cada chamada.
1)
Isto é uma nota de rodapé
2)
Quando a proporção da largura e altura especificada não coincidir com a da imagem, ela será recortada para a nova proporção antes de ser redimensionada