wiki.txt 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427
  1. ====== Sintaxe de Formatação ======
  2. Suportamos a seguinte linguagem de marcação, a qual tenta ser o mais legível possível. Essa página contêm todos os tipos utilizáveis na edição de páginas. Veja a 'fonte' desta página clicando em "Editar essa página". Se você quer tentar algo, use a [[playground:playground|página de testes]]. A sintaxe de marcação também é facilmente acessível pelos [[doku>toolbar|quickbuttons]].
  3. ===== Formatação Básica de Texto =====
  4. A Wiki suporta textos em **negrito**, //itálico//, __sublinhado__ e ''mono-espaçado''. Você também pode **__//''combiná-los''//__**.
  5. A Wiki suporta textos em **negrito**, //itálico//, __sublinhado__ e ''mono-espaçado''.
  6. Você também pode **__//''combiná-los''//__.
  7. Também pode-se utilizar <sub> subscrito </sub> e <sup> sobrescrito </sup>.
  8. Também pode-se utilizar <sub> subscrito </sub> e <sup> sobrescrito </sup>.
  9. Ademais, você pode marcar algo como <del> deletado </del>.
  10. Ademais, você pode marcar algo como <del> deletado </del>.
  11. **Parágrafos** são criados a partir de linhas em branco. Se você quer **forçar
  12. uma nova linha** sem iniciar um parágrafo, deve usar duas contra-barras seguidas de um espaço em branco ou apenas as barras no final da linha.
  13. Este é um texto com algumas quebras de linhas\\ Note que os
  14. dois contra-barras só funcionam no fim da linha\\
  15. ou quando tem\\ uma espaço em branco \\Isso acontece sem o espaço em branco.
  16. Você só deve forçar novas linhas quando for estritamente necessário.
  17. ===== Links =====
  18. A Wiki suporta vários meios de se criar links.
  19. ==== Externo ====
  20. Links externos são vinculados automaticamente: https://www.fsf.org ou simplesmente www.fsf.org - Você pode utilizar links como textos: [[https://www.gnu.org|Esse link aponta para o projeto GNU]]. Endereços de email como <john@teste.org> também são aceitos.
  21. A Wiki suporta vários meios de se criar links. Links externos são vinculados
  22. automaticamente: https://www.fsf.org ou simplesmente www.fsf.org - Você pode
  23. utilizar links como textos: [[https://www.gnu.org|Esse link aponta para o projeto GNU]].
  24. Endereços de email como <john@teste.org> também são aceitos.
  25. ==== Interno ====
  26. Links internos são criados usando colchetes. Apenas use o nome da [[página]] ou use um [[página|texto]] para vinculá-los.
  27. Links internos são criados usando colchetes. Apenas use o nome
  28. da [[página]] ou use um [[página|texto]] para vinculá-los.
  29. [[doku>página|Páginas da Wiki]] são convertidas em caixa-baixa automaticamente, caracteres especiais não são aceitos.
  30. Você pode utilizar [[algum:espaço de nomes]] usando dois pontos no nome da página.
  31. Você pode utilizar [[alguma:espaço de nomes]] usando dois pontos no nome da página.
  32. Para mais detalhes sobre espaço de nomes, veja [[doku>espaço de nomes]].
  33. Apontar para uma sessão específica também é possível. Adicione o nome da sessão entre um cerquilha, assim como no HTML. Isso aponta para [[sintaxe#interno|essa Sessão]].
  34. Isso aponta para [[sintaxe#interno| essa Sessão]].
  35. Notas:
  36. * Links para [[sintaxe|páginas existentes]] são mostrados de forma diferente de uma [[página inexistente]].
  37. * Quando o título de uma sessão é mudado, a marcação também muda. Não confie muito ao linkar sessões.
  38. ==== InterWiki ====
  39. Também suportamos Interwiki links. São links rápidos para outras Wikis. Por exemplo, esse é um link para a página da Wikipedia sobre Linux: [[wp>Linux]].
  40. Também suportamos Interwiki links. São links rápidos para outras Wikis.
  41. Por exemplo, esse é um link para a página da Wikipedia sobre Linux: [[wp>Linux]].
  42. ==== Links em Imagens ====
  43. Você pode adicionar uma imagem apontando para algum link interno ou externo combinando a sintaxe de links e [[#imagens_e_outros_arquivos|imagens]] (veja abaixo) assim:
  44. [[https://kernel.org|{{wiki:tux.png}}]]
  45. [[https://kernel.org|{{wiki:tux.png}}]]
  46. Toda a sintaxe de [[#imagens_e_outros_arquivos]] e [[#link|link]] é suportada (incluindo redimensionamento de imagem, imagens internas e externas, URLs e links para outras wikis).
  47. ===== Notas de rodapé =====
  48. Notas de rodapé são adicionadas usando parênteses duplos. ((Este é um exemplo de nota de rodapé)).
  49. Notas de rodapé são adicionadas usando parênteses duplos. ((Este é um exemplo de nota de rodapé)).
  50. ===== Sessões =====
  51. Pode-se utilizar diferentes níveis de títulos para a estruturação do artigo. Se você tem três ou mais títulos, o índice do artigo é gerado automaticamente.
  52. ==== Título Nível 3 ====
  53. === Título Nível 2 ===
  54. == Títulos Nível 1 ==
  55. ==== Título Nível 3 ====
  56. === Título Nível 2 ===
  57. == Títulos Nível 1 ==
  58. Utilizando quatro ou mais traços, você pode criar uma linha horizontal:
  59. ----
  60. ===== Arquivos de Mídia =====
  61. Você pode incluir [[doku>imagens|imagens, vídeos e arquivos de áudio]] externos e internos com colchetes. Opcionalmente você pode especificar o tamanho deles.
  62. Tamanho real: {{wiki:tux.png}}
  63. Redimensionando a largura: {{wiki:tux.png?50}}
  64. Redimensionando a altura e largura: ((se a altura x largura especificadas não coincidirem com a da imagem, ela será recortada para a nova proporção antes do redimensionamento)) {wiki:tux.png?200x50}}
  65. Imagem externa resimensionada: {{http://www.gnu.org/graphics/heckert_gnu.transp.small.png?200x50}}
  66. Tamanho real: {{wiki:tux.png}}
  67. Redimensionando a largura: {{wiki:tux.png?50}}
  68. Redimensionando a altura e largura: {{wiki:tux.png?200x50}}
  69. Imagem externa resimensionada: {{http://www.gnu.org/graphics/heckert_gnu.transp.small.png?200x50}}
  70. Usando um espaço a direita ou esquerda, você pode escolher o alinhamento das imagens.
  71. {{ wiki:tux.png}}
  72. {{wiki:tux.png }}
  73. {{ wiki:tux.png }}
  74. {{ wiki:tux.png}}
  75. {{wiki:tux.png }}
  76. {{ wiki:tux.png }}
  77. Obviamente, você também pode adicionar um título (exibida como uma 'dica de ferramenta' pela maioria dos navegadores).
  78. {{ wiki:gnu.png |Exemplo de legenda}}
  79. {{ wiki:gnu.png |Exemplo de legenda}}
  80. Para linkar uma imagem a outra página, veja [[#Links em Imagens]].
  81. ==== Formatos de Mídia Suportados ====
  82. A Wiki consegue exibir diretamente os seguintes formatos:
  83. | Imagem | ''gif'', ''jpg'', ''png'' |
  84. | Vídeo | ''webm'', ''ogv'', ''mp4'' |
  85. | Áudio | ''ogg'', ''mp3'', ''wav'' |
  86. | Flash | ''swf'' |
  87. Caso você especifique um arquivo que não seja suportado, ele será exibido como um link para o original.
  88. Adicioanndo ''?linkonly'' você provêm um link para o arquivo sem exibi-lo.
  89. {{wiki:tux.png?linkonly}}
  90. {{wiki:tux.png?linkonly}} Um link para um imagem.
  91. ==== Formatos reservas ====
  92. Infelizmente, nem todos os navegadores conseguem entender todos os formatos de vídeo e áudio. Para contornar esse problema, você pode colocar o seu arquivo em diferentes formatos para uma maior compatibilidade.
  93. Por exemplo, considere este vídeo mp4:
  94. {{video.mp4| Um vídeo qualquer}}
  95. Quando você subir um ''video.webm'' e um ''video.ogv'' ao lado de ''video.mp4'', a Wiki automaticamente adicioná-los-á como alternativas ao ''video.mp4'', exibindo algum que seja entendido pelo navegador.
  96. Adicionalmente, a Wiki suporta uma imagem como miniatura do vídeo, exibindo-a antes do vídeo ser reproduzido. Essa imagem tem que ter o mesmo nome do vídeo e ser do formato png ou jpg. Para o exemplo anterior, a imagem 'video.jpg' deve funcionar.
  97. ===== Listas =====
  98. Suportamos listas ordenadas e inordenadas. Para criar um item na lista, indente seu texto com dois espaços e use um ''*'' para listar inordenadas e ''-'' para ordenadas.
  99. * Essa é uma lista inordenada
  100. * Segundo item
  101. * Você também pode ter subitens
  102. * Mais um item
  103. - Outra lista, dessa vez ordenada
  104. - Outro item
  105. - Subitens em ordem alfabética
  106. - Item número 3
  107. <code>
  108. * Essa é uma lista inordenada
  109. * Segundo item
  110. * Você também pode ter subitens
  111. * Mais um item
  112. - Outra lista, dessa vez ordenada
  113. - Outro item
  114. - Subitens em ordem alfabética
  115. - Item número 3
  116. </code>
  117. ===== Citações =====
  118. Às vezes você pode desejar marcar certos trechos do texto como uma citação ou comentário. Utilize esta sintaxe:
  119. <code>
  120. Acho que devemos fazê-lo.
  121. >Não, não devemos.
  122. >> Bem, digo que devemos.
  123. > Sério?
  124. >> Sim!
  125. >>> Então fá-lo-emos.
  126. </code>
  127. Acho que devemos fazê-lo.
  128. >Não, não devemos.
  129. >> Bem, digo que devemos.
  130. > Sério?
  131. >> Sim!
  132. >>> Então fá-lo-emos.
  133. ===== Tabelas =====
  134. Suportamos um modo simples de criar tabelas:
  135. ^ Título 1 ^ Título 2 ^ Título 3 ^
  136. | linha 1 col 1 | linha 1 col 2 | linha 1 col 3 |
  137. | linha 2 col 1 | linha extra-colunal (dois) ||
  138. | linha 3 col 1 | linha 3 col 2 | linha 3 col 3 |
  139. As linhas da tabela devem começar e terminar com um ''|'' para linhas e ''^'' para cabeçalhos.
  140. ^ Título 1 ^ Título 2 ^ Título 3 ^
  141. | linha 1 col 1 | linha 1 col 2 | linha 1 col 3 |
  142. | linha 2 col 1 | linha extra-colunal (dois) ||
  143. | linha 3 col 1 | linha 3 col 2 | linha 3 col 3 |
  144. Para conectar linhas horizontalmente, apenas deixe a próxima linha na coluna desejada em branco. Certifique-se de ter sempre a mesma quantidade de separadores!
  145. Também é possível criar cabeçalhos na vertical.
  146. | ^ Título 1 ^ Título 2 ^
  147. ^ Título 3 | linha 1 col 2 | linha 1 col 3 |
  148. ^ Título 4 | sem dados nessas duas linhas | |
  149. ^ Título 5 | linha 3 col 2 | linha 3 col 3 |
  150. Como você pode observar, é a separador de colunas antes da linha que decide o formato:
  151. | ^ Título 1 ^ Título 2 ^
  152. ^ Título 3 | linha 1 col 2 | linha 1 col 3 |
  153. ^ Título 4 | sem dados nessas duas linhas | |
  154. ^ Título 5 | linha 3 col 2 | linha 3 col 3 |
  155. Você também pode criar linhas conectadas verticalmente adicionando ''%%:::%%'' nas linhas que devem ser preenchidas.
  156. ^ Título 1 ^ Título 2 ^ Título 3 ^
  157. | linha 1 col 1 | estender-se-á verticalmente | linha 1 col 3 |
  158. | linha 2 col 1 | ::: | linha 2 col 3 |
  159. | linha 3 col 1 | ::: | linha 3 col 3 |
  160. Considerando a sintaxe para linhas conectadas verticalmente associadas, esse exemplo mostra uma verticalmente estendida por duas linhas vazias.
  161. ^ Título 1 ^ Título 2 ^ Título 3 ^
  162. | linha 1 col 1 | estender-se-á verticalmente | linha 1 col 3 |
  163. | linha 2 col 1 | ::: | linha 2 col 3 |
  164. | linha 3 col 1 | ::: | linha 3 col 3 |
  165. Para criar uma tabela com alinhamentos, adicione dois espaços no lado oposto do termino do seu texto: dois a esquerda para alinhar a direita, dois a direita para alinhar a esquerda e dois nos dois lados para alinhar ao centro.
  166. ^ Tabela com alinhamentos ^^^
  167. | direita| centro |esquerda |
  168. |esquerda | direita| centro |
  169. | xxxxxxxxxxxxx | xxxxxxxxxxxxx | xxxxxxxxxxxxx |
  170. Parecer-se-á assim na fonte:
  171. ^ Tabela com alinhamentos ^^^
  172. | direita| centro |esquerda |
  173. |esquerda | direita| centro |
  174. | xxxxxxxxxxxxx | xxxxxxxxxxxxx | xxxxxxxxxxxxx |
  175. Nota: alinhamento na vertical não é suportado.
  176. ===== Sem Formatação =====
  177. Se você precisar inserir um texto e não desejar que ele seja 'interpretado' pelo nosso esquema de sintaxe, utilize a seguinte notação:
  178. <nowiki>
  179. Esse texto não será __formatado__ de forma //alguma//, mesmo que eu utilize vários parâmetros da [[http://gnulinux.gq/wiki|wiki]].
  180. </nowiki>
  181. Outro **texto**, mas agora **__//formatado//__**.
  182. <nowiki>
  183. Esse texto não será __formatado__ de forma //alguma//, mesmo que utilize-se de vários parâmetros da [[http://gnulinux.gq/wiki|wiki]].
  184. </nowiki>
  185. Outro **texto**, mas agora **__//formatado//__**.
  186. ===== Blocos de Código =====
  187. Você pode incluí-los no artigo deixando dois espaços entre a margem esquerda e o texto (como nos exemplos dados neste artigo> ou então utilizando as tags ''%%<code>%%'' ou ''%%<file>%%''.
  188. Esse é um exemplo utilizando dois espaços como recuo e sinalização.
  189. <code>
  190. Outro exemplo, só que neste todos os espaços são preservados: mais ou menos <- assim.
  191. </code>
  192. <file>
  193. Mais ou menos igual, mas neste você pode mostrar como se estivesse quotando um arquivo.
  194. </file>
  195. Esses exemplos foram criados assim:
  196. Esse é um exemplo utilizando dois espaços como recuo e sinalização.
  197. <code>
  198. Outro exemplo, só que neste todos os espaços são preservados: mais ou menos <- assim.
  199. </code>
  200. <file>
  201. Mais ou menos igual, mas neste você pode mostrar como se estivesse quotando um arquivo.
  202. </file>
  203. ==== Realce de sintaxe ====
  204. Nossa Wiki pode realçar os códigos fontes nela inseridos, isso torna-os mais legíveis. Utiliza o mesmo sistema das tags ''<nowiki> <code> </nowiki>'' e ''<nowiki> <file> </nowiki>''. O nome da linguagem a ser sinalizada deve vir logo após a 'abertura' da tag: ''<nowiki> <code bash> </nowiki>'' ou ''<nowiki> <file php> </nowiki>''.
  205. <code c>
  206. /* Exemplo de código em C para demonstrar o realce de sintaxe */
  207. #include <stdio.h>
  208. int
  209. main(void)
  210. {
  211. fprintf(stdout,"Realce de sintaxe é demais!\n");
  212. return 0;
  213. }
  214. </code>
  215. As seguintes linguagens podem utilizar-se deste recurso: //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//
  216. <note> Utilize esse ótimo recurso sempre que possível! </note>
  217. ====== Incorporando HTML e PHP =====
  218. Você pode adicionar código em HTML e PHP no seu artigo utilizando as tags ''%%<html>%%'' ou ''%%<php>%%''. (Utilize ''%%<HTML>%%'' e ''%%PHP%%'' para fechar blocos internos de código.)
  219. Exemplo de HTML:
  220. <code>
  221. <html>
  222. Exemplo de <span style="color:red;font-size:150%;">texto em HTML</span>
  223. </html>
  224. <HTML>
  225. <p style="border:2px dashed red;">E este é um bloco em HTML</p>
  226. </HTML>
  227. </code>
  228. <html>
  229. Exemplo de <span style="color:red;font-size:150%;">texto em HTML</span>
  230. </html>
  231. <HTML>
  232. <p style="border:2px dashed red;">E este é um bloco em HTML</p>
  233. </HTML>
  234. Exemplo de PHP:
  235. <code>
  236. <php>
  237. echo 'versão do PHP: ';
  238. echo phpversion();
  239. echo ' (gerado em uma linha HTML)';
  240. </php>
  241. <PHP>
  242. echo '<table class="inline"><tr><td>Idem, mas dentro de um sub bloco.:</td>';
  243. echo '<td>'.phpversion().'</td>';
  244. echo '</tr></table>';
  245. </PHP>
  246. </code>
  247. ===== Agregamento de Feed RSS/ATOM =====
  248. Pode-se agregar Feeds em XML na wiki. Para 'traduzir' (parsing) o Feed em XML, o [[http://simplepie.org|SimplePie]] é usado. Todos os formatos entendidos por ele são aceitos na Wiki. Você pode customizar a renderização utilizado estes parâmetros:
  249. ^ Parâmetro ^ Descrição ^
  250. | qualquer número | será utilizado para especificar o número de itens a serem exibidos. 8 é o padrão |
  251. | reverso | mostrará o feed na ordem inversa (os últimos serão os primeiros) |
  252. | autor | mostra o autor dos itens do feed |
  253. | date | exibe a data dos itens |
  254. | nosort | não ordena os itens do feed |
  255. | //n/[dhn] | período de atualização, onde d=dias, h=horas, m=minutos |
  256. O período padrão de atualização é 4 horas. Qualquer valor abaixo de 10 minutos será tratado como 10 minutos.
  257. Por padrão, os feeds serão organizados pela data, os mais novos primeiro. Você pode organizá-los a partir dos mais antigos utilizando o parâmetro ''reverse'', ou deixá-lo como ''nosort''.
  258. **Exemplo**
  259. {{rss>http://slashdot.org/index.rss 5 author date 1h }}
  260. {{rss>http://slashdot.org/index.rss 5 author date 1h }}
  261. ===== Macros de Controle =====
  262. Algumas sintaxes na página também influenciam no modo como a Wiki renderiza a página, no entanto, elas não produzem nenhuma saída explícita. Os seguintes macros estão disponíveis:
  263. ^ Macro ^ Descrição |
  264. | %%~~NOTOC~~%% | Se este macro estiver na página, nenhuma tabela será criada |
  265. | %%~~NOCACHE~~%% | A Wiki guardará em cache toda a saída por padrão. Às vezes esse comportamento não é esperado (por exemplo, quanto a sintaxe %%<php>%% abaixo é utilizada), adicionar esse macro forçará a Wiki a renderizar a página a cada chamada |
  266. Tradução e adaptação não oficial para o português do [[https://www.dokuwiki.org/wiki:syntax|artigo original da DokuWiki]].