{{{ #!comment # Copyright (C) 2009 Gabriel Falcão # # This program is free software; you can redistribute it and/or # modify it under the terms of the GNU General Public License as # published by the Free Software Foundation; either version 2 of the # License, or (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU # General Public License for more details. # # You should have received a copy of the GNU General Public # License along with this program; if not, write to the # Free Software Foundation, Inc., 59 Temple Place - Suite 330, # Boston, MA 02111-1307, USA. }}} = Escrevendo no Wiki = O wiki possui um código simples de formatação de texto, você não precisa ser um programador para entender, a sintaxe é bastante simples, mas é poderosa o suficiente para suportar integração com o sistema de tickets e tudo o mais! A linguagem de formatação deriva do MoinMoin, um software livre de wiki [http://moinmoin.wikiwikiweb.de/ MoinMoin]. Esta página possui exemplos de como escrever textos no wiki. == Estilos de fontes == Exemplos de como formatar as fontes: {{{ * '''negrito''', '''!''' também pode ficar em negrito''', e '''! ''' * ''itálico'' * '''''negrito e itálico ao mesmo tempo''''' * __sublinhado__ * {{{mono-espaçado}}} ou `mono-espaçado` * ~~tracejado~~ * ^sobrescrito^ * ,,subscrito,, }}} Será exibido como: * '''negrito''', '''!''' também pode ficar em negrito''', e '''! ''' * ''itálico'' * '''''negrito e itálico ao mesmo tempo''''' * __sublinhado__ * {{{mono-espaçado}}} ou `mono-espaçado` * ~~tracejado~~ * ^sobrescrito^ * ,,subscrito,, Note que: * Os comandos `{{{...}}}` e {{{`...`}}} não deixam a fonte simplesmente mono-espaçada, mas também trata seu conteúdo como texto verbatim, ou seja, o wiki não processará nenhum código de formatação que estiver dentro dessas tríades de chaves. * {{{ ! }}} serve para dizer ao wiki: "Ignore esses caracteres especiais, portanto, preste atenção ao colocar espaço em branco após !. == Cabeçalhos == Você pode criar um cabeçalho começando a linha com até cinco caracteres de ''igual'' ("=") seguido por '''um''' espaço em branco e o título do seu cabeçalho, que por sua vez deve terminar com um espaço em branco e o mesmo número de caracteres de ''igual'' que você utilizou para começar o cabeçalho. O Cabeçalho pode opcionalmente possuir um ''ID'' explícito. Senão, um ''ID'' ilegível e implícito será gerado, evitando o trabalho de criar um :) Exemplo: {{{ = Título = == Subtítulo == === Terceiro ''nível'' === === Com identificador (''ID'') explícito === #usando-identificador-explicito }}} Resultará em: = Título = == Subtítulo == === Terceiro ''nível'' === === Com identificador (''ID'') explícito === #usando-identificador-explicito == Parágrafos == Um novo parágrafo é iniciado sempre que dois blocos de texto forem separados por uma ou mais linhas em branco. Você também pode forçar uma quebra de linha, como no exemplo: {{{ Primeira linha[[BR]]Segunda linha }}} Resultará em: Primeira linha[[BR]]Segunda linha == Listas == O wiki suporta tanto listas numeradas/ordenadas como não-numeradas. Exemplo: {{{ * Item 1 * Item 1.1 * Item 1.1.1 * Item 1.1.2 * Item 1.1.3 * Item 1.2 * Item 2 1. Item 1 a. Item 1.a a. Item 1.b i. Item 1.b.i i. Item 1.b.ii 1. Item 2 E linhas numeradas também podem ter numeração explícita 3. Item 3 }}} Resultará em: * Item 1 * Item 1.1 * Item 1.1.1 * Item 1.1.2 * Item 1.1.3 * Item 1.2 * Item 2 1. Item 1 a. Item 1.a a. Item 1.b i. Item 1.b.i i. Item 1.b.ii 1. Item 2 E linhas numeradas também podem ter numeração explícita 3. Item 3 Note que é necessário um ou mais espaços antes de iniciar os marcadores de itens de lista, caso contrário, o texto será tratado como um parágrafo qualquer. == Listas de definição == O wiki também suporta listas de definição. Exemplo: {{{ lhama:: um tipo de mamífero, dos cabeludos :) ppython:: uma linguagem de programação, em que o Trac foi escrito (você pôde notar o erro de escrita ?) }}} Resultará em: lhama:: um tipo de mamífero, dos cabeludos :) ppython:: uma linguagem de programação, em que o Trac foi escrito (você pôde notar o erro de escrita ?) Note que você também precisa usar um espaço na frente do texto que define o termo. == Texto pré-formatado (ou texto "crú) == Blocos contendo textos pré-formatados se encaixam perfeitamente em porções reutilizáveis de código de programação, notas e exemplos. Use três ''chaves'' em volta do texto para definir um bloco de texto pré-formatado. As chaves precisam começar numa nova linha. Exemplo: {{{ {{{ def funcao_python(): print "Hello World" }}} }}} Resultará em: {{{ def funcao_python(): print "Hello World" }}} == Citações == Para marcar um parágrafo como citação, começe-o com dois espaços em branco. Exemplo: {{{ Ser ou não ser, eis a questão - Shakespeare }}} Display: Ser ou não ser, eis a questão - Shakespeare == Citações de discussões == Muita gente usa listas de discussões de email e não conhece sua notação mais básica, que se dá através do uso dos caracteres (">", ">>", etc.) O wiki suporta essas marcações, como no exemplo: {{{ >> Texto original de alguém > Resposta sobre o texto original Minha opinião sobre a discussão }}} Resultará em: >> Texto original de alguém > Resposta sobre o texto original Minha opinião sobre a discussão ''Observação: Alguns itens do EscrevendoNoWiki, tais como listas e textos pré-formatados, serão perdidos na área de citação. Alguma reformatação pode ser necessária para criar uma citação limpa.'' == Tabelas == Tabelas simples podem ser criadas assim: {{{ ||Célula 1||Célula 2||Célula 3|| ||Célula 4||Célula 5||Célula 6|| }}} Resultando em: ||Célula 1||Célula 2||Célula 3|| ||Célula 4||Célula 5||Célula 6|| Tabelas mais complexas podem ser criadas seguindo a [wiki:WikiRestructuredText#BiggerReSTExample documentação (em inglês)]. == Links == Hyperlinks são automaticamente criados para NomesComoEste and URLs. !NomesAssim também podem ser desabilitados, quando precedidos de uma exclamação "!" bem como em {{{!WikiPageLink}}}. Exemplo: {{{ EscrevendoNoWiki, http://www.edgewall.com/, !NotAlink }}} Display: EscrevendoNoWiki, http://www.edgewall.com/, !NotAlink Links podem possuir um título melhor elaborado simplesmente escrevendo o link, seguido por um espaço em branco, e a descrição. Tudo dentro de chaves. Se a descrição for omitida, será tratado como um link normal, a não ser que seja um link externo. Isso é muito útil caso você queira escrever páginas de wiki que não sigam a convenção !DesteEstiloDeNome. Exemplo: {{{ * [http://www.edgewall.com/ Edgewall Software] * [wiki:TitleIndex Title Index] * [wiki:ISO9000] }}} Resultará em: * [http://www.edgewall.com/ Edgewall Software] * [wiki:TitleIndex Title Index] * [wiki:ISO9000] == Trac Links == Wiki pages can link directly to other parts of the Trac system. Pages can refer to tickets, reports, changesets, milestones, source files and other Wiki pages using the following notations: {{{ * Tickets: #1 or ticket:1 * Reports: {1} or report:1 * Changesets: r1, [1] or changeset:1 * ... }}} Display: * Tickets: #1 or ticket:1 * Reports: {1} or report:1 * Changesets: r1, [1] or changeset:1 * ... Existem muitos outros ''"sabores"'' de Trac links, acesse TracLinks para mais informações. == Escapando links e WikiPages == Você pode evitar a criação de hiperlinks adicionando uma exclamação "!" como prefixo do texto. Exemplo: {{{ !SemLinkAqui !#42 não é um link }}} Display: !SemLinkAqui !#42 não é um link == Imagens == Urls terminadas em `.png`, `.gif` ou `.jpg` não são mais interpretadas como links de imagem e convertidas em tags html ``. A partir desta versão do trac você precisa usar a macro ![[Image]]. A maneira mais simples de adicionar uma imagem à uma página de wiki é fazendo o upload de imagens como anexos à página (note que há um campo para isso no rodapé da página), e colocar o nome do arquivo na chamada da macro, como no exemplo: `[[Image(picture.gif)]]`. Adicionalmente você pode reutilizar imagens de outros recursos do wiki, como outras páginas, arquivos em controle de versão, em tickets, etc. Exemplos: * `[[Image(wiki:WikiFormatting:picture.gif)]]` (imagem em outra página de wiki) * `[[Image(ticket:1:picture.gif)]]` (arquivo anexo à um ticket) * `[[Image(htdocs:picture.gif)]]` (arquivo embutido no Trac) * `[[Image(source:/trunk/trac/htdocs/trac_logo_mini.png)]]` (arquivo em controle de versões) Exemplo de como ficará: [[Image(htdocs:../common/trac_logo_mini.png)]] Veja a página WikiMacros para mais informações sobre a macro `[[Image()]]`. == Macros == Macros são funções que adicionam conteúdo dinâmico às suas páginas de Wiki. Exemplo: {{{ [[RecentChanges(Trac,3)]] }}} Resultará em: [[RecentChanges(Trac,3)]] Veja a página WikiMacros para mais informações e uma lista de todas as macros disponíveis no Trac. == Processadores de texto == O Trac suporta códigos de formatação alternativos através dos chamados WikiProcessors. Por exemplo, processadores podem ser usados para escrever páginas de wiki em [wiki:WikiRestructuredText reStructuredText] ou [wiki:WikiHtml HTML]. Exemplo de HTML: {{{ #!html 
{{{
#!html
<h1 style="text-align: right; color: blue">Exemplo em HTML</h1>
}}}
}}} Resultará em: {{{ #!html

Exemplo em HTML

}}} Exemplo de código Python: {{{ #!html 
{{{
#!python
class Test:

    def __init__(self):
        print "Hello World"
if __name__ == '__main__':
   Test()
}}}
}}} Resultará em: {{{ #!python class Test: def __init__(self): print "Hello World" if __name__ == '__main__': Test() }}} Exemplo em Perl: {{{ #!perl my ($test) = 0; if ($test > 0) { print "hello"; } }}} Acesse a página WikiProcessors para mais informações. == Comentários == Para documentar as páginas de wiki em nível de código, você pode usar os comentários, assim, poderá adicionar informações relevantes à quem for dar manutenção na página de wiki, e suas instruções não apareceram na página em si. {{{ {{{ #!comment Seu comentário aqui }}} }}} == Diversos == Quatro ou mais hífens serão substituídos por uma linha horizontal (
) Exemplo: {{{ ---- }}} Resultará em: ---- ---- Veja também as páginas: TracLinks, TracGuide, WikiHtml, WikiMacros, WikiProcessors, TracSyntaxColoring (todas em inglês).