Sintaxe de formatação

DokuWiki suporta uma linguagem de marcação simples, que tenta organizar a estrutura dos arquivos o mais legível possível. Esta página contém toda as possíveis sintaxes que você por ventura queira utilizar quando estiver editando as páginas do wiki. Dê uma olhada no código fonte desta página, basta pressionar o botão Editar no topo e no rodapé da página. Se você deseja testar ou praticar, utilize a página de playground. A sintaxe de formatação/marcação é facilmente acessada via quickbuttons, também.

Formatação básica de texto

DokuWiki suporta negrito, itálico, sublinhado e textos monospaced. Claro que você pode combinar todos estes.

DokuWiki suporta **negrito**, //itálico//, __sublinhado__ e textos ''monospaced'' .
Claro que você pode **__//''combinar''//__** todos estes.

Você pode usar subescrito and superescrito, também.

Você pode usar <sub>subescrito</sub> and <sup>superescrito</sup>, também.

Você pode marcar texto como deletado.

Você pode marcar texto como <del>deletado</del>.

Parágrafos são criados apartir de linhas em branco. Se você deseja forçar a criação de uma nova linha sem um parágrafo, você pode usar contra-barras seguidas por um espaço em branco ou o final da linha.

Exemplo de texto com quebras de linha
Note que as contra-barras são somente reconhecida no final da linha
ou seguidas por
um espaço em branco.

Exemplo de texto com quebras de linha\\ Note que as 
contra-barras são somente reconhecida no final da linha\\
ou seguidas por\\ um espaço em branco.

Você só deve utilizar quebra de linhas se realmente for necessário.

Links

DokuWiki suporta múltiplas maneiras de criação de links.

Externo

Links externos são reconhecidos automaticamente assim: http://www.google.com ou simplesmente www.google.com - Você pode setar o nome do link tambem: Esse link aponta para o Google. Endereços de e-mail podem ser reconhecidos dessa forma: andi@splitbrain.org tambem.

DokuWiki suporta várias formas de criação de links. Links Externos são reconhecidos automaticamente assim: 
http://www.google.com ou simplesmente www.google.com ou simplesmente www.google.com.br - Você pode setar
um nome do link tambem:[[http://www.google.com|Este link aponta para o Google]]. Endereços de e-mail podem
ser reconhecidos dessa forma: <andi@splitbrain.org> tambem.

Interno

Links Internos são criados usando colchetes. Você pode apenas dar o wiki:nome_da_pagina ou usar um titulo adicional Titulo do texto. O nome_da_pagina é convertido para letra minuscula automaticamente, caracteres especiais não são permitidos.

Links Internos são criados usando colchetes. Você pode apenas dar o 
o [[doku>wiki:nome_da_pagina]] ou usar um titulo adicional [[[doku>wiki:nome_da_pagina|Titulo do texto]].
O nome_da_pagina é convertido para letra minuscula automaticamente, caracteres especiais não são permitidos.

You can use namespaces by using a colon in the pagename.

You can use [[wiki:namespaces]] by using a colon in the pagename.

Para detalhes sobre namespaces veja wiki:namespaces.

É possivel fazer um link para uma sessão especifica tambem. Apenas adcione o nome da seção atrás da cerquilha conhecido do HTML. Assim fazemos um link para essa seção.

Assim fazemos um link para [[syntax#interno|essa seção]].

Notas:

  • Links para páginas existentes são mostrados em estilos diferentes daqueles não existentes.
  • DokuWiki não usa CamelCase para criar automaticamente links por padrão, mas essa ação pode ser habilitada no arquivo config. Sugestão: Se DokuWiki é um link, então habilite.
  • Quando um seção cabeçalho é mudada, seu bookmark muda também. Então não conte com seção ligar demais.

Interwiki

DokuWiki suportam Interwiki. Estes links apontam para outros Wikis. Por exemplo: Este é um link para página da Wikipedia sobre Wikis: Wiki.

DokuWiki suportam [[doku>wiki:interwiki|Interwiki]]. Estes links apontam para outros Wikis.
Por exemplo: Este é um link para página da Wikipedia sobre Wikis: [[wp>Wiki]].

Links com Imagens

Você pode usar uma imagem como link para uma página interna ou externa combinando a sintaxe de links e imagens. Veja abaixo:

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

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.

Secionar

Você pode usar até cinco níveis diferentes de cabeçalhos na estrutura do seu indice. Se você mais que três cabeçalhos, a tabela de índice é gerada automaticamente – Isso pode ser desabilitado incluindo ~~NOTOC~~ em seu documento.

Cabeçalho Nivel 3

Cabeçalho Nivel 4

Cabeçalho Nivel 5
==== Cabeçalho Nivel 3 ====
=== Cabeçalho Nivel 4 ===
== Cabeçalho Nivel 5 ==

Usando-se quatro ou mais traços, você pode fazer uma linha horizontal:


Imagens e outros arquivos

Você pode incluir imagens internas e externas com suporte ondulado. Opcionalmente você pode especificar o tamanho tambem.

Tamanho real:

Redimensionar a largura dada:

Redimensionar a largura e a altura dada:

Redimensionar imagem externa:

Tamanho real:                            {{wiki:dokuwiki-128.png}}
Redimensionar a largura dada:            {{wiki:dokuwiki-128.png?50}}
Redimensionar a largura e a altura dada: {{wiki:dokuwiki-128.png?200x50}}
Redimensionar imagem externa:            {{http://de3.php.net/images/php.gif?200x50}}

Usa-se espaços em branco para definir alinhamento da imagem (direita, esquerda e centralizado):

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

Naturalmente, você pode adicionar um subtítulo a imagem.

Isto é um subtítulo

{{ wiki:dokuwiki-128.png |Isto é um subtítulo}}

Se você especificar um nome de arquivo (interno ou externo) que não é uma imagem (gif, jpge, png), então isso indicará um link para download.

Para ligar uma imagem a outra página veja Links com Imagens logo acima.

Listas

Dokuwiki suporta listas ordenadas e desordenadas. Para criar um item de lista, deixe dois espaços em branco no início para identar seu texto e use o * para listas desordenadas ou o - para listas ordenadas.

  • Isto é uma lista
  • Aqui, o segundo item da lista
    • Você pode desejar inserir níveis na lista
  • Mais um item
  1. A mesma lista só que ordenada
  2. Outro item
    1. Apenas um item para mostrar o nivelamento das listas
  3. Bem, é isto!

</code>

Emotions

DokuWiki converte os emoticons geralmente usados para seu grafico equivalente. Mais smileys podem ser colocado no diretório smiley e configurado no arquivo conf/smileys.conf. Abaixo segue uma visão geral dos emotions incluidos no DokuWiki

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

Tipografia

DokuWiki pode converter caracteres de texto simples para sua tipografia correta. Abaixo segue um exemplo de caracteres reorganizados.

→ ← ↔ ⇒ ⇐ ⇔ » « – — 640×480 © ™ ® “Ele pensou ‘Este é o mundo dos homens...”

-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"Ele pensou 'Este é o mundo dos homens..."

Observação: Você pode desabilitar a conversão através das opção de configuração e um arquivo de teste padrão.

Quote

As vezes você deseja marcar algum texto para mostrar que é uma resposta ou um comentário. Você pode usar a seguinte sintaxe:

Eu acho que nós deveríamos fazer isto

> Não, nós não deveríamos.

>> Bem, eu digo que deveríamos.

> Será?

>> Sim!

>>> Então vamos fazer!

Eu acho que nós deveríamos fazer isto

Não, nós não deveríamos.
Bem, eu digo que deveríamos
Será?
Sim!
Então vamos fazer!

Tabelas

O DokuWiki utiliza 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 célula mesclada (perceba o duplo pipe)
Linha 3 Coluna 1 Linha 2 Coluna 2 Linha 2 Coluna 3

As linhas da tabela são iniciadas e finalizadas com um | (pipe) para linhas normais e um ^ para cabeçalhos.

^ 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    | célula mesclada (perceba o duplo pipe) ||
| Linha 3 Coluna 1    | Linha 2 Coluna 2     | Linha 2 Coluna 3        |

Para mesclar horizontalmente, é só inserir uma nova celula completamente vazia como mostrado abaixo. Tenha certeza que vai existir sempre o mesmo número de células!

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

Cabeçalho 1 Cabeçalho 2
Cabeçalho 3 Linha 1 Coluna 2 Linha 1 Coluna 3
Cabeçalho 4 Desta vez, sem mesclagem
Cabeçalho 5 Linha 2 Coluna 2 Linha 2 Coluna 3

Como você pode ver, é o separador antes da célula que decide seu formato:

|              ^ Cabeçalho 1            ^ Cabeçalho 2          ^
^  Cabeçalho 3    | Linha 1 Coluna 2          | Linha 1 Coluna 3        |
^  Cabeçalho 4    | Desta vez, sem mesclagem |                    |
^  Cabeçalho 5    | Linha 2 Coluna 2          | Linha 2 Coluna 3        |

Não é possível mesclar na vertical, nesta versão do Dokuwiki.

Você pode alinhar o conteúdo da tabela. Basta adicionar pelo menos dois espaços no lado oposto do final do texto: adicione dois espaços para alinhar à direita e dois espaços para alinhar à esquerda. Dois espaços de ambos os lados centralizam o texto.

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

Veja os fontes:

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

Blocos não convertidos

Você pode incluir trechos que não deverão ser traduzidos pelo Dokuwiki, ou iniciando com dois espaços ou usando as tags code e file.

Este é código pré-formatado com todos os espaços mantidos como             <-este
Praticamente idêntico, mas pode ser usado quando citando um arquivo.   

Para fazer o Dokuwiki ignorar um bloco completo, use a tag nowiki ou, ainda mais simples, marque o bloco com um sinal de percentagem duplo %%.

This is some text which contains addresses like this: http://www.splitbrain.org and **formatting**, but nothing is done with it.

Veja o código para página para ver como conseguir estes efeitos.

Sintaxe Destacada

DokuWiki pode destacar códigos fonte, tornando-os de mais fácil leitura. Ele faz uso do GeSHi Generic Syntax Highlighter – logo qualquer linguagem aceita pelo GeSHi é aceita também. A sintaxe é a mesma do bloco code, da seção anterior, apenas incluindo a linguagem, como em <code java></nowiki>.

/** 
 * 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: 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, 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, smarty, sql, tsql, robots, ruby, vb, vbnet, vhdl, visualfoxpro, xml

Utilizando HTML

Você pode inserir comandos HTML nos seus documentos com a tag html :

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

This is some HTML

Sintaxe dos Plugins Adicionais

Veja nesta outra página, a sintaxe para os Plugins adicionais do Dokuwiki.

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:

~~INFO:syntaxplugins~~

1) Isto é uma nota de rodapé
wiki/syntax.txt · Modificado em: 05/08/2006 23:14