====== Sintaxe de Formatação ======
O [[doku>DokuWiki]] suporta uma linguagem de marcação simples, que busca tornar os arquivos de dados o mais legíveis possível. Esta página contém toda a sintaxe que você pode utilizar ao editar as páginas. Basta conferir o código-fonte desta página clicando em "Editar esta página". Se quiser fazer testes, utilize a página [[playground:playground|playground]]. A marcação mais simples também é facilmente acessível através da [[doku>toolbar|barra de ferramentas]].
===== Formatação Básica de Texto =====
O DokuWiki suporta textos em **negrito**, //itálico//, __sublinhado__ e ''monoespaçado''. Naturalmente, você pode **__//''combinar''//__** todos eles.
O DokuWiki suporta textos em **negrito**, //itálico//, __sublinhado__ e ''monoespaçado''.
Naturalmente, você pode **__//''combinar''//__** todos eles.
Observe que os marcadores de formatação devem envolver o texto diretamente; portanto, ''%%** negrito **%%'' (com espaços dentro dos marcadores) não será formatado.
Você também pode usar subscrito e sobrescrito.
Você também pode usar subscrito e sobrescrito.
Você também pode marcar algo como excluído.
Você também pode marcar algo como excluído.
**Parágrafos** são criados a partir de linhas em branco. Se quiser **forçar uma quebra de linha** sem iniciar um novo parágrafo, pode usar duas barras invertidas seguidas de um espaço ou do fim da linha.
Este é um texto com algumas quebras de linha\\ Observe que as
duas barras invertidas só são reconhecidas no final de uma linha\\
ou seguidas por\\ um espaço \\isto acontece sem ele.
Este é um texto com algumas quebras de linha\\ Observe que as
duas barras invertidas só são reconhecidas no final de uma linha\\
ou seguidas por\\ um espaço \\isto acontece sem ele.
Você deve usar quebras de linha forçadas apenas quando realmente necessário.
===== Links =====
O DokuWiki suporta várias formas de criar links.
==== Externos ====
Links externos são reconhecidos automaticamente: http://www.google.com ou simplesmente www.google.com - Você também pode definir o texto do link: [[http://www.google.com|Este link aponta para o Google]]. Endereços de e-mail como este: também são reconhecidos.
O DokuWiki suporta várias formas de criar links. Links externos são reconhecidos
automaticamente: http://www.google.com ou simplesmente www.google.com - Você também pode definir
o texto do link: [[http://www.google.com|Este link aponta para o Google]]. Endereços
de e-mail como este: também são reconhecidos.
==== Internos ====
Links internos são criados usando colchetes. Você pode simplesmente indicar um [[nome da página]] ou usar a forma [[nome da página|texto do link]].
Links internos são criados usando colchetes. Você pode simplesmente indicar
um [[nome da página]] ou usar a forma [[nome da página|texto do link]].
[[doku>nome da página|Nomes de páginas da Wiki]] são convertidos automaticamente para letras minúsculas; caracteres especiais não são permitidos.
Você pode usar [[alguns:namespaces]] inserindo dois-pontos no nome da página.
Você pode usar [[alguns:namespaces]] inserindo dois-pontos no nome da página.
Para detalhes sobre namespaces, consulte [[doku>namespaces]].
Também é possível criar links para uma seção específica. Basta adicionar o nome da seção após um caractere de cerquilha (#), como é feito em HTML. Este link aponta para [[syntax#internal|esta seção]].
Este link aponta para [[syntax#internal|esta seção]].
Notas:
* Links para [[syntax|páginas existentes]] são exibidos com um estilo diferente daqueles para [[páginas inexistentes]].
* Por padrão, o DokuWiki não usa [[wp>CamelCase]] para criar links automaticamente, mas esse comportamento pode ser ativado no arquivo de configuração [[doku>config]]. Dica: se a palavra "DokuWiki" aparecer como um link, então o recurso está ativado.
* Quando o título de uma seção é alterado, sua âncora (bookmark) também muda. Portanto, evite depender excessivamente de links para seções.
==== Interwiki ====
O DokuWiki suporta links [[doku>Interwiki]]. Estes são links rápidos para outras wikis. Por exemplo, este é um link para a página da Wikipédia sobre wikis: [[wp>Wiki]].
O DokuWiki suporta links [[doku>Interwiki]]. Estes são links rápidos para outras wikis.
Por exemplo, este é um link para a página da Wikipédia sobre wikis: [[wp>Wiki]].
==== Compartilhamentos do Windows ====
Compartilhamentos do Windows como [[\\server\share|este]] também são reconhecidos. Observe que eles só fazem sentido em um grupo de usuários homogêneo, como uma [[wp>Intranet]] corporativa.
Compartilhamentos do Windows como [[\\server\share|este]] também são reconhecidos.
Notas:
* Por motivos de segurança, a navegação direta em compartilhamentos do Windows funciona por padrão apenas no Microsoft Internet Explorer (e somente na "zona local").
* No Mozilla e no Firefox, isso pode ser habilitado através de soluções alternativas mencionadas na [[http://kb.mozillazine.org/Links_to_local_pages_do_not_work|Base de Conhecimento da Mozilla]]. No entanto, ainda haverá um aviso do JavaScript sobre a tentativa de abrir um compartilhamento do Windows. Para remover esse aviso (para todos os usuários), insira a seguinte linha em ''conf/lang/en/lang.php'' (mais detalhes em [[doku>localization#changing_some_localized_texts_and_strings_in_your_installation|localization]]):
==== Links de Imagem ====
Você também pode usar uma imagem para criar um link para outra página interna ou externa, combinando a sintaxe de links e de [[#images_and_other_files|imagens]] (veja abaixo), desta forma:
[[http://php.net|{{wiki:dokuwiki-128.png}}]]
[[http://php.net|{{wiki:dokuwiki-128.png}}]]
Observe: a formatação de imagem é a única sintaxe de formatação aceita nos nomes dos links.
Toda a sintaxe de [[#images_and_other_files|imagens]] e [[#links|links]] é suportada (incluindo redimensionamento de imagem, imagens e URLs internas e externas, e links interwiki).
===== Notas de Rodapé =====
Você pode adicionar notas de rodapé ((Esta é uma nota de rodapé)) usando parênteses duplos.
Você pode adicionar notas de rodapé ((Esta é uma nota de rodapé)) usando parênteses duplos.
===== Divisão em Seções =====
Você pode usar até cinco níveis diferentes de títulos para estruturar seu conteúdo. Se houver mais de três títulos, um sumário é gerado automaticamente — isso pode ser desativado incluindo a string ''~~NOTOC~~'' no documento.
==== Título de Nível 3 ====
=== Título de Nível 4 ===
== Título de Nível 5 ==
==== Título de Nível 3 ====
=== Título de Nível 4 ===
== Título de Nível 5 ==
Usando quatro ou mais traços, você pode criar uma linha horizontal:
----
===== Arquivos de Mídia =====
Você pode incluir [[doku>images|imagens, vídeos e arquivos de áudio]] externos e internos usando chaves. Opcionalmente, você pode especificar o tamanho deles.
Tamanho real: {{wiki:dokuwiki-128.png}}
Redimensionar para a largura especificada: {{wiki:dokuwiki-128.png?50}}
Redimensionar para a largura e altura especificadas((quando a proporção da largura e altura especificadas não corresponder à da imagem, ela será cortada para a nova proporção antes do redimensionamento)): {{wiki:dokuwiki-128.png?200x50}}
Imagem externa redimensionada: {{https://www.php.net/images/php.gif?200x50}}
Tamanho real: {{wiki:dokuwiki-128.png}}
Redimensionar para a largura especificada: {{wiki:dokuwiki-128.png?50}}
Redimensionar para a largura e altura especificadas: {{wiki:dokuwiki-128.png?200x50}}
Imagem externa redimensionada: {{https://www.php.net/images/php.gif?200x50}}
Você pode definir o alinhamento usando espaços em branco à esquerda ou à direita.
{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png}}
{{wiki:dokuwiki-128.png }}
{{ wiki:dokuwiki-128.png }}
Você também pode definir o alinhamento explicitamente com um parâmetro ''?left'', ''?right'' ou ''?center''. Isso tem precedência sobre o alinhamento por espaços em branco mencionado acima e pode ser combinado com uma definição de tamanho.
{{wiki:dokuwiki-128.png?100&right}}
{{wiki:dokuwiki-128.png?100&right}}
É claro que você também pode adicionar um título (exibido como uma dica de ferramenta pela maioria dos navegadores). {{ wiki:dokuwiki-128.png |Esta é a legenda}}
{{ wiki:dokuwiki-128.png |Esta é a legenda}}
Para vincular uma imagem a outra página, consulte [[#Links de Imagem]] acima.
==== Formatos de Mídia Suportados ====
O DokuWiki pode incorporar diretamente os seguintes formatos de mídia.
| Imagem | ''gif'', ''jpg'', ''png'' |
| Vídeo | ''webm'', ''ogv'', ''mp4'' |
| Áudio | ''ogg'', ''mp3'', ''wav'' |
| Flash | ''swf'' |
Se você especificar um nome de arquivo que não corresponda a um formato de mídia suportado, ele será exibido como um link.
Ao adicionar ''?linkonly'', você cria um link para a mídia sem exibi-la diretamente na página (inline).
{{wiki:dokuwiki-128.png?linkonly}}
{{wiki:dokuwiki-128.png?linkonly}} Este é apenas um link para a imagem.
==== Formatos Alternativos (Fallback) ====
Infelizmente, nem todos os navegadores reconhecem todos os formatos de vídeo e áudio. Para contornar esse problema, você pode enviar seu arquivo em diferentes formatos, garantindo a máxima compatibilidade entre navegadores.
Por exemplo, considere este vídeo mp4 incorporado:
{{video.mp4|Um vídeo engraçado}}
Ao enviar os arquivos ''video.webm'' e ''video.ogv'' juntamente com o ''video.mp4'' referenciado, o DokuWiki os adicionará automaticamente como alternativas, garantindo que pelo menos um dos três arquivos seja reconhecido pelo seu navegador.
Além disso, o DokuWiki suporta uma imagem de capa ("poster") que será exibida antes de o vídeo começar. Essa imagem deve ter o mesmo nome de arquivo que o vídeo e estar no formato jpg ou png. No exemplo acima, um arquivo ''video.jpg'' funcionaria.
===== Listas =====
O DokuWiki suporta listas ordenadas e não ordenadas. Para criar um item de lista, recue o texto em dois espaços e use um ''*'' para listas não ordenadas ou um ''-'' para listas ordenadas.
* Esta é uma lista
* O segundo item
* Você pode ter diferentes níveis
* Outro item
- A mesma lista, mas ordenada
- Outro item
- Basta usar recuo para níveis mais profundos
- É só isso
* Esta é uma lista
* O segundo item
* Você pode ter diferentes níveis
* Outro item
- A mesma lista, mas ordenada
- Outro item
- Basta usar recuo para níveis mais profundos
- É só isso
Veja também o [[doku>faq:lists|FAQ sobre itens de lista]].
===== Conversões de Texto =====
O DokuWiki pode converter certos caracteres ou sequências predefinidos em imagens, ou em outros textos ou HTML.
A conversão de texto para imagem é realizada principalmente para *smileys*. Já a conversão de texto para HTML é utilizada para substituições tipográficas, mas também pode ser configurada para utilizar outros elementos HTML.
==== Conversões de Texto para Imagem ====
O DokuWiki converte [[wp>emoticon|emoticons]] de uso comum em seus equivalentes gráficos. Esses [[doku>Smileys|Smileys]] e outras imagens podem ser configurados e ampliados. Abaixo, apresentamos uma visão geral dos *Smileys* incluídos no DokuWiki:
* 8-) %% 8-) %%
* 8-O %% 8-O %%
* :-( %% :-( %%
* :-) %% :-) %%
* =) %% =) %%
* :-/ %% :-/ %%
* :-\ %% :-\ %%
* :-? %% :-? %%
* :-D %% :-D %%
* :-P %% :-P %%
* :-O %% :-O %%
* :-X %% :-X %%
* :-| %% :-| %%
* ;-) %% ;-) %%
* ^_^ %% ^_^ %%
* m( %% m( %%
* :?: %% :?: %%
* :!: %% :!: %%
* LOL %% LOL %%
* FIXME %% FIXME %%
* DELETEME %% DELETEME %%
==== Conversões de Texto para HTML ====
Tipografia: O [[DokuWiki]] pode converter caracteres de texto simples em suas entidades tipograficamente corretas. Aqui está um exemplo de caracteres reconhecidos.
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"Ele pensou 'É um mundo dos homens'..."
-> <- <-> => <= <=> >> << -- --- 640x480 (c) (tm) (r)
"Ele pensou 'É um mundo dos homens'..."
O mesmo pode ser feito para produzir qualquer tipo de HTML; basta adicionar o padrão ao [[doku>entities|arquivo de padrões]].
Existem três exceções que não vêm desse arquivo de padrões: a entidade de multiplicação (640x480), as aspas 'simples' e as "duplas". Elas podem ser desativadas por meio de uma [[doku>config:typography|opção de configuração]].
===== Citações =====
Às vezes, você quer marcar um texto para indicar que se trata de uma resposta ou comentário. Você pode usar a seguinte sintaxe:
Acho que deveríamos fazer isso
> Não, não deveríamos
>> Bem, eu digo que deveríamos
> Sério?
>> Sim!
>>> Então vamos fazer!
Acho que deveríamos fazer isso
> Não, não deveríamos
>> Bem, eu digo que deveríamos
> Sério?
>> Sim!
>>> Então vamos fazer!
===== Tabelas =====
O DokuWiki suporta uma sintaxe simples para criar tabelas.
^ Cabeçalho 1 ^ Cabeçalho 2 ^ Cabeçalho 3 ^
| Linha 1 Col 1 | Linha 1 Col 2 | Linha 1 Col 3 |
| Linha 2 Col 1 | algum colspan (note a barra dupla) ||
| Linha 3 Col 1 | Linha 3 Col 2 | Linha 3 Col 3 |
As linhas da tabela devem começar e terminar com um caractere ''|'' (para linhas normais) ou ''^'' (para cabeçalhos).
^ Cabeçalho 1 ^ Cabeçalho 2 ^ Cabeçalho 3 ^
| Linha 1 Col 1 | Linha 1 Col 2 | Linha 1 Col 3 |
| Linha 2 Col 1 | colspan (note a barra dupla) ||
| Linha 3 Col 1 | Linha 3 Col 2 | Linha 3 Col 3 |
Para unir células horizontalmente, basta deixar a célula seguinte completamente vazia, como mostrado acima. Certifique-se de manter sempre a mesma quantidade de separadores de célula!
Também é possível criar cabeçalhos de tabela verticais.
| ^ Cabeçalho 1 ^ Cabeçalho 2 ^
^ Cabeçalho 3 | Linha 1 Col 2 | Linha 1 Col 3 |
^ Cabeçalho 4 | sem colspan desta vez| |
^ Cabeçalho 5 | Linha 2 Col 2 | Linha 2 Col 3 |
Como você pode ver, é o separador de célula posicionado antes da célula que define a formatação:
| ^ Cabeçalho 1 ^ Cabeçalho 2 ^
^ Cabeçalho 3 | Linha 1 Col 2 | Linha 1 Col 3 |
^ Cabeçalho 4 | sem colspan desta vez| |
^ Cabeçalho 5 | Linha 2 Col 2 | Linha 2 Col 3 |
Você pode criar *rowspans* (células unidas verticalmente) inserindo ''::: '' nas células abaixo daquela com a qual elas devem se unir.
^ Cabeçalho 1 ^ Cabeçalho 2 ^ Cabeçalho 3 ^
| Linha 1 Col 1 | esta célula se estende verticalmente | Linha 1 Col 3 |
| Linha 2 Col 1 | ::: | Linha 2 Col 3 |
| Linha 3 Col 1 | ::: | Linha 2 Col 3 |
Exceto pela sintaxe do *rowspan*, essas células não devem conter mais nada.
^ Cabeçalho 1 ^ Cabeçalho 2 ^ Cabeçalho 3 ^
| Linha 1 Col 1 | esta célula se estende verticalmente | Linha 1 Col 3 |
| Linha 2 Col 1 | ::: | Linha 2 Col 3 |
| Linha 3 Col 1 | ::: | Linha 2 Coluna 3 |
Você também pode alinhar o conteúdo da tabela. Basta adicionar pelo menos dois espaços em branco na extremidade oposta ao texto: adicione dois espaços à esquerda para alinhar à direita, dois espaços à direita para alinhar à esquerda e pelo menos dois espaços em ambas as extremidades para centralizar o texto.
^ Tabela com alinhamento ^^^
| direita | centro |esquerda |
|esquerda | direita | centro |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Veja como isso aparece no código-fonte:
^ Tabela com alinhamento ^^^
| direita| centro |esquerda |
|esquerda | direita| centro |
| xxxxxxxxxxxx | xxxxxxxxxxxx | xxxxxxxxxxxx |
Nota: O alinhamento vertical não é suportado.
===== Sem Formatação =====
Se você precisar exibir um texto exatamente como foi digitado (sem nenhuma formatação), envolva a área com as tags ''%%%%'' ou, de forma ainda mais simples, com dois sinais de porcentagem ''%%''.
Este é um texto que contém endereços como este: http://www.splitbrain.org e **formatação**, mas nada é feito com ele.
O mesmo vale para %%//__este__ texto// com um smiley ;-)%%.
Este é um texto que contém endereços como este: http://www.splitbrain.org e **formatação**, mas nada é feito com ele.
O mesmo vale para %%//__este__ texto// com um smiley ;-)%%.
===== Blocos de Código =====
Você pode incluir blocos de código em seus documentos recuando-os em pelo menos dois espaços (como usado nos exemplos anteriores) ou usando as tags ''%%%%'' ou ''%%%%''.
Este texto está recuado em dois espaços.
Este é um código pré-formatado; todos os espaços são preservados: como <-isto
Isso é praticamente a mesma coisa, mas você pode usar para indicar que citou um arquivo.
Esses blocos foram criados a partir deste código-fonte:
Este texto está recuado em dois espaços.
Este é um código pré-formatado; todos os espaços são preservados: como <-isto
Isso é praticamente a mesma coisa, mas você pode usar para indicar que citou um arquivo.
==== Realce de Sintaxe ====
O [[wiki:DokuWiki]] pode realçar código-fonte, facilitando a leitura. Ele utiliza o [[http://qbnz.com/highlighter/|GeSHi]] (Generic Syntax Highlighter) — portanto, qualquer linguagem suportada pelo GeSHi também é suportada aqui. A sintaxe utiliza os mesmos blocos de código e arquivo descritos na seção anterior, mas, desta vez, o nome da linguagem a ser realçada é incluído dentro da tag, por exemplo: ''
/**
* A classe HelloWorldApp implementa uma aplicação que
* simplesmente exibe "Hello World!" na saída padrão.
*/
class HelloWorldApp {
public static void main(String[] args) {
System.out.println("Hello World!"); // Exibe a string. }
}
As seguintes strings de linguagem são reconhecidas atualmente: //4cs 6502acme 6502kickass 6502tasm 68000devpac abap actionscript3 actionscript ada aimms algol68 apache applescript apt_sources arm asm asp asymptote autoconf autohotkey autoit avisynth awk bascomavr bash basic4gl batch bf biblatex bibtex blitzbasic bnf boo caddcl cadlisp ceylon cfdg cfm chaiscript chapel cil c_loadrunner clojure c_mac cmake cobol coffeescript c cpp cpp-qt cpp-winapi csharp css cuesheet c_winapi dart dcl dcpu16 dcs delphi diff div dos dot d ecmascript eiffel email epc e erlang euphoria ezt f1 falcon fo fortran freebasic freeswitch fsharp gambas gdb genero genie gettext glsl gml gnuplot go groovy gwbasic haskell haxe hicest hq9plus html html4strict html5 icon idl ini inno intercal io ispfpanel java5 java javascript jcl j jquery julia kixtart klonec klonecpp kotlin latex lb ldif lisp llvm locobasic logtalk lolcode lotusformulas lotusscript lscript lsl2 lua m68k magiksf make mapbasic mathematica matlab mercury metapost mirc mk-61 mmix modula2 modula3 mpasm mxml mysql nagios netrexx newlisp nginx nimrod nsis oberon2 objc objeck ocaml-brief ocaml octave oobas oorexx oracle11 oracle8 oxygene oz parasail parigp pascal pcre perl6 perl per pf phix php-brief php pic16 pike pixelbender pli plsql postgresql postscript povray powerbuilder powershell proftpd progress prolog properties providex purebasic pycon pys60 python qbasic qml q racket rails rbs rebol reg rexx robots roff rpmspec rsplus ruby rust sas sass scala scheme scilab scl sdlbasic smalltalk smarty spark sparql sql sshconfig standardml stonescript swift systemverilog tclegg tcl teraterm texgraph text thinbasic tsql twig typoscript unicon upc urbi uscript vala vbnet vb vbscript vedit verilog vhdl vim visualfoxpro visualprolog whitespace whois winbatch wolfram xbasic xml xojo xorg_conf xpp yaml z80 zxbasic//
Existem [[doku>syntax_highlighting|opções avançadas]] adicionais disponíveis para o destaque de sintaxe, como destacar linhas ou adicionar números de linha.
==== Blocos de código para download ====
Ao utilizar a sintaxe ''%%%%'' ou ''%%%%'' como mostrado acima, você pode querer disponibilizar o código exibido para download também. Você pode fazer isso especificando um nome de arquivo após o código da linguagem, assim:
Se você não quiser destaque de sintaxe, mas desejar um arquivo para download, especifique um traço (''-'') como código da linguagem: ''%%%%''.
===== Agregação de feeds RSS/ATOM =====
O [[DokuWiki]] pode integrar dados de feeds XML externos. O [[http://simplepie.org/|SimplePie]] é utilizado para processar os feeds XML. Todos os formatos reconhecidos pelo SimplePie também podem ser usados no DokuWiki. Você pode influenciar a renderização utilizando vários parâmetros adicionais separados por espaços:
^ Parâmetro ^ Descrição ^
| qualquer número | será usado como o número máximo de itens a exibir; o padrão é 8 |
| reverse | exibe os últimos itens na feed first |
| author | exibir nomes dos autores dos itens |
| date | exibir datas dos itens |
| description| exibir a descrição do item. Todas as tags HTML serão removidas |
| nosort | não ordenar os itens no feed |
| //n//[dhm] | período de atualização, onde d=dias, h=horas, m=minutos (ex.: 12h = 12 horas). |
O período de atualização padrão é de 4 horas. Qualquer valor inferior a 10 minutos será tratado como 10 minutos. O [[wiki:DokuWiki]] geralmente tenta fornecer uma versão em cache da página; obviamente, isso é inadequado quando a página contém conteúdo externo dinâmico. O parâmetro instrui o [[wiki:DokuWiki]] a renderizar novamente a página se tiver passado mais tempo do que o //período de atualização// desde a última renderização.
Por padrão, o feed será ordenado por data, com os itens mais recentes primeiro. Você pode ordená-lo começando pelos mais antigos usando o parâmetro ''reverse'', ou exibir o feed como está com ''nosort''.
**Exemplo:**
{{rss>http://slashdot.org/index.rss 5 author date 1h }}
{{rss>http://slashdot.org/index.rss 5 author date 1h }}
===== Macros de Controle =====
Alguns elementos de sintaxe influenciam a forma como o DokuWiki renderiza uma página sem gerar nenhuma saída por si só. As seguintes macros de controle estão disponíveis:
^ Macro ^ Descrição |
| %%~~NOTOC~~%% | Se esta macro for encontrada na página, nenhum sumário será criado |
| %%~~NOCACHE~~%% | O DokuWiki armazena em cache toda a saída por padrão. Às vezes, isso pode não ser desejado (por exemplo, quando a sintaxe %%%% acima é usada); adicionar esta macro forçará o DokuWiki a renderizar novamente a página a cada acesso |
===== Plugins de Sintaxe =====
A sintaxe do DokuWiki pode ser estendida por meio de [[doku>plugins|Plugins]]. A forma de utilização dos plugins instalados é descrita em suas respectivas páginas de descrição. Os seguintes plugins de sintaxe estão disponíveis nesta instalação específica do DokuWiki:
~~INFO:syntaxplugins~~