Suporte a reStructuredText no Trac

Trac suporta usando reStructuredText (RST) com uma alternativa para a formatação de alto nível na wiki em qualquer contexto que WikiFormatting seja usado.

Da página do reStructuredText: "reStruturedText é fácil de ler, o que você vê é o que realmente é, sintaxe de alto nível em texto puro e análise das frases/palavras do sistema.Isso é muito útil para documentação interna de programas( como as docstrings do Python), para uma simples e rápida criação de páginas web e para documentos. reStructuredText é desenhado com uma capacidade de extensão para domínios de aplicações específicas.

Pré-Requisitos

Perceba que para ativar o suporte a RST no Trac, o pacote de docutil do Python precisa estar instalado. Se ele não estiver disponível na sua máquina, você pode fazer o download dele em RST Website.

Mais informação sobre RST

• Site do reStructuredText RST -- http://docutils.sourceforge.net/rst.html
• Guia de referência rápida do RST -- http://docutils.sourceforge.net/docs/rst/quickref.html

---

Usando RST no Trac

Para especificar que um bloco de texto deve ser formatado usando-se RST, usa-se o processador rst

TracLinks no reStructuredText

• O Trac fornece por padrão uma diretriz de referencia o 'trac' que permite TracLinks para dentro de textos RST

Exemplo:

 {{{
 #!rst
 Isto é uma referencia para |um ticket|



 .. |um ticket| trac:: #42
 }}}

Para um completo exemplo com todos os usos das diretivas do trac, veja WikiRestructuredTextLinks.

• O Trac permite um jeito fácil de criação de TracLinks no RST, usando o link padrão :trac: chamado esquema.

Exemplo:

 {{{
 #!rst
 Isto é uma referência para o ticket `#12`:trac:

 Para aprender a usar o Trac, veja o `TracGuide`:trac:
 }}}

Sintaxe para destacar no reStructuredText

Veja abaixo uma maneira de fazer TracSyntaxColoring no RST. Essa maneira é conhecida como code-block ou bloco de código

Exemplo

{{{
#!rst

.. code-block:: python

 class Test:

    def TestFunction(self):
        pass

}}}

Irá resultar no resultado abaixo.

None

Exemplo

O exemplo abaixo é geralmente auto-explicativo:

{{{
#!rst
FooBar Header
=============
reStructuredTexto é **legal**. Ele possui o seu próprio site_.

A tabela:
=====  =====  ======
   Entrada    Saida
------------  ------
  A      B    A or B
=====  =====  ======
Verd.  Falso  Falso
Verd.  Falso   Verd.
Falso  Verd.   Verd.
Verd.  Verd.   Verd.
=====  =====  ======

RST TracLinks
-------------

Veja também o ticket |#42|.

.. |#42| trac:: #42

.. _site: http://docutils.sourceforge.net/rst.html
}}}

Resulta em:

FooBar Header

reStructuredText é legal. Ele possui seu próprio site.

A tabela:

Entrada		Saída
A	B	A or B
Falso	Falso	Falso
Verd.	Falso	Verd.
Falso	Verd.	Verd.
Verd.	Verd.	Verd.

RST TracLinks

Veja também o ticket .

42

System Message: WARNING/2 (<string>, line 23)

Substitution definition "#42" empty or invalid.

.. |#42| trac:: #42

---

Veja também: WikiRestructuredTextLinks, WikiProcessors, WikiFormatting