Redmine

h1. Formatação de texto

A seguir a formatação de texto em Textile, para formatação em Markdown, consulte #15520

{{>TOC}}

h2. Links

h3. Links do Redmine

O Redmine permite hiperligações entre recursos (tarefas, revisões, páginas wiki...) a partir de qualquer formatação usada.

* Link para uma tarefa: *!#124* (exibe #124, o link aparece riscado se a tarefa estiver fechada)

* Link para uma nota de tarefa: *!#124-6*, or *!#124!#note-6*

* Link para uma revisão: *!r758* (exibe r758)

* Link para uma revisão com um hash não númerico: *commit:c6f4d0fd* (exibe c6f4d0fd).

Links na Wiki:

* *[[Guide]]* exibe um link para a página nomeada 'Guide': [[Guide]]

* *[[Guide|User manual]]* exibe um link para aquela página mas com um texto diferente: [[Guide|User manual]]

* *[[Guide#User-guide|User guide]]* exibe um link para o cabeçalho daquela página mas com texto diferente: [[Guide#User-guide|User guide]]

Você também pode linkar para uma página wiki de outro projeto (usando o identificador do projeto):

* *[[sandbox:some page]]* exibe um link para a página wiki nomeada 'Some page' do projeto Sandbox

* *[[sandbox:]]* exibe um link para a página principal da wiki do projeto Sandbox

Links wiki são exibidos em vermelho se a página não existir, ex.: [[Nonexistent page]].

Links para outros recursos:

* Documentos:

  * *!document#17* (link para o documento de id 17)

  * *!document:Greetings* (link para o documento com título "Greetings")

  * *!document:"Some document"* (aspas duplas devem ser usadas quando o título do documento tiver espaços)

  * *!sandbox:document:"Some document"* (link para o documento de título "Some document" do projeto "sandbox")

* Versões:

  * *!version#3* (link para a versão de id 3)

  * *!version:1.0.0* (link para a versão nomeada "1.0.0")

  * *!version:"1.0 beta 2"* (aspas duplas devem ser usadas se o nome da versão tiver espaços)

  * *!sandbox:version:1.0.0* (link para a versão "1.0.0" do projeto "sandbox")

* Anexos:

  * *!attachment:file.zip* (link para o anexo nomeado como file.zip)

  * *!attachment:"file.zip"* (aspas duplas devem ser usadas quando o nome do arquivo apresentar caracteres especiais)

  * Por enquanto, só é possível referenciar anexos do recurso atual (se estiver em uma tarefa, apenas é possível referenciar anexos desta mesma tarefa)

* Revisões:

  * *!r758* (link para revisão)

  * *!commit:c6f4d0fd* (link para revisão com hash não-númerico)

  * *!svn1|r758* (link para revisão de um repositório específico, para projetos com múltiplos repositórios)

  * *!commit:hg|c6f4d0fd* (link para revisão com hash não-númerico de um repositório específico)

  * *!sandbox:r758* (link para revisão de outro projeto)

  * *!sandbox:commit:c6f4d0fd* (link para revisão com hash não-númerico de outro projeto)

* Arquivos do repositório:

  * *!source:some/file*           -- Link para arquivo localizado em /some/file no repositório do projeto

  * *!source:some/file@52*        -- Link para revisão 52 do arquivo

  * *!source:some/file#L120*      -- Link para linha 120 do arquivo

  * *!source:some/file@52#L120*   -- Link para linha 120 na revisão 52 do arquivo

  * *!source:"some file@52#L120"* -- Aspas duplas devem ser usadas quando a URL apresentar espaços

  * *!source:repo_identifier|some/file* -- Link para arquivo de outro repositório que não seja o padrão do projeto. 

  * *!source:"repo_identifier|some file"* -- Link para arquivo de outro repositório que não seja o padrão do projeto, contendo espaços no nome do arquivo. 

  * *!export:some/file*           -- Força o download do arquivo

* Fórums:

  * *!forum#2* (link para fórum de id 2)

  * *!forum:Discussion* (link para fórum de nome "Discussion")

  * *!forum:"Help and more"* (aspas duplas devem ser usadas quando o nome do fórum apresentar espaços)

* Mensagens de fóruns:

  * *!message#1218* (link para mensagem de id 1218)

* Notícias

  * *!news#1* (link para notícia de id 1)

  * *!news:Greetings* (link para notícia nomeada "Greetings")

  * *!news:"eCookbook first release !"* (aspas duplas devem ser usadas quando o nome da notícia apresentar espaços)

* Projetos:

  * *!project#3* (link para projeto de id 3)

  * *!project:someproject* (link para projeto de nome "someproject")

  * *!project:"Multiple words project"* (aspas duplas devem ser usadas quando o nome do projeto apresentar espaços)

Escapando:

* Você pode evitar que links do Redmine sejam processados, precedendo-os com uma exclamação: !

h3. Links externos

URLs HTTP são automaticamente transformados em hyperlinks: 

* *http://www.redmine.org* -- Link externo para o website do Redmine: http://www.redmine.org

* *someone@foo.bar* -- Link para o endereço de email: someone@foo.bar

URLs HTTP também podem apresentar texto customizado ao invés da URL:

* *"Redmine web site":http://www.redmine.org* -- Link externo com texto customizado: "Redmine web site":http://www.redmine.org

* *!http://www.redmine.org/attachments/7069/Redmine_logo.png(Redmine web site)!:http://www.redmine.org* -- Imagem externa com título que linka para uma URL: 

p=. !http://www.redmine.org/attachments/7069/Redmine_logo.png(Redmine web site)!:http://www.redmine.org

h3. Endereço de e-mail

Endereços de e-mail são automaticamente transformados em hyperlinks:

* *"Email someone":mailto:someone@foo.bar* -- Link de e-mail com texto customizado: "Email someone":mailto:someone@foo.bar

Instruções adicionais podem ser adicionadas ao link de e-mail. Pré-definições de assunto, corpo e cópia (CC) podem ser incluídas. Note que espaços em branco nesses campos devem ser substituídos pelo código %20.

* *"Email webmaster and admin":mailto:webmaster@foo.bar?cc=admin@foo.bar* -- Link de e-mail para webmaster, CC admin:  "Email webmaster and admin":mailto:webmaster@foo.bar?cc=admin@foo.bar

* *"Email someone for help":mailto:someone@foo.bar?subject=Website%20Help* -- Link de e-mail com assunto "Website Help": "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help

* *"Email someone for help":mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20* -- Link de e-mail com assunto "Website Help" e corpo: "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20

h2. Formatação de texto

Para elementos como cabeçalhos, negrito, tabelas, listas, o Redmine suporta "Sintaxe Textile":http://en.wikipedia.org/wiki/Textile_%28markup_language%29. Consulte http://redcloth.org/hobix.com/textile/ para informações de uso das funcionalidades. Alguns exemplos são apresentados a seguir, mas o recurso é bem mais capaz.

h3. Acrônimo

<pre>

JPL(Jean-Philippe Lang)

</pre>

Exibe:

JPL(Jean-Philippe Lang)

h3. Estilo de fonte

<pre><code>* *negrito*

* _itálico_

* *_negrito itálico_*

* +sublinhado+

* -riscado-

* Texto ^sobrescrito^

* Texto ~subscrito~

* @Monoespaçado em linha@

* <notextile>normal *negrito* _itálico_ normal;E=mc ^2^</notextile>

* <notextile>normal<notextile></notextile>*negrito*<notextile></notextile>_itálico_<notextile></notextile>normal;E=mc<notextile></notextile>^2^</notextile>

* <notextile>Escapando: <notextile>*negrito* _itálico_ @monoespaçado@</notextile> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Alternativa usando códigos HTML: &#42;negrito&#42; &#95;itálico&#95; &#64;monoespaçado&#64;</notextile>

* <notextile><pre>*algumas linhas*      algum "link":http://www.redmine.org</pre></notextile>

* <notextile><pre><notextile></notextile>*algumas linhas*      algum "link":http://www.redmine.org</pre></notextile>

</code></pre>

Exibição:

 * *negrito*

 * _itálico_

 * *_negrito itálico_*

 * +sublinhado+

 * -riscado-

 * Texto ^sobrescrito^

 * Texto ~subscrito~

 * @Monoespaçado@

 * normal *negrito* _itálico_ normal;E=mc ^2^

 * normal<notextile></notextile>*negrito*<notextile></notextile>_itálico_<notextile></notextile>normal;E=mc<notextile></notextile>^2^

 * Escaping: <notextile>*negrito* _itálico_ @monoespaçado@</notextile> &nbsp;&nbsp;&nbsp;&nbsp;&nbsp; Alternativa usando códigos HTML: &#42;negrito&#42; &#95;itálico&#95; &#64;monoespaçado&#64;

 * <pre>*algumas linhas*      algum "link":http://www.redmine.org</pre>

 * <pre><notextile></notextile>*algumas linhas*      algum "link":http://www.redmine.org</pre>

h3. Cores

<pre><code><notextile>* %{color:red}vermelho% %{color:green}verde% %{color:yellow}amarelo% %{color:#82B6E1}azul%

* %{color:red}vermelho%<notextile></notextile>%{color:green}verde%<notextile></notextile>%{color:yellow}amarelo%<notextile></notextile>%{color:#82B6E1}azul%

* %{background:lightgreen}Fundo verde-claro% %{background:yellow}Fundo amarelo%

* %{background:lightgreen}Fundo verde-claro%<notextile></notextile>%{background:yellow}Fundo amarelo%

</notextile></code></pre>

Exibição:

 * %{color:red}vermelho% %{color:green}verde% %{color:yellow}amarelo% %{color:#82B6E1}azul%

 * %{color:red}vermelho%<notextile></notextile>%{color:green}verde%<notextile></notextile>%{color:yellow}amarelo%<notextile></notextile>%{color:#82B6E1}azul%

 * %{background:lightgreen}Fundo verde-claro% %{background:yellow}Fundo amarelo%

 * %{background:lightgreen}Fundo verde-claro%<notextile></notextile>%{background:yellow}Fundo amarelo%

h3. Imagens

* *!image_url!* exibe imagem localizada em image_url (textile syntax)

* *!>image_url!* imagem alinhada à direita

* *!image_url(Image title)!* exibe imagem com atributo alt/title

* *!image_url!:URL* exibe imagem localiza em image_url com link embutido

Se você tiver uma imagem anexada na página wiki, pode ser inserida informando o nome do arquivo: *!attached_image.png!*

Você também pode aplicar estilo CSS na image da mesma forma ao estilizar SPANs. O código *!{width: 100%}attached_image.png!* irá ajustar a imagem conforme largura do elemento pai. 

h3. Cabeçalhos

<pre><code>h1. Título

h2. Subtítulo

h3. Subtítulo

</code></pre>

Redmine atribui uma âncora para cada um desses títulos, assim você pode linká-los com "#Heading", "#Subheading" e assim por diante.

h3. Parágrafos

<pre><code>p. alinhado à esquerda

  p(. identado à esquerda em 1em

    p((. identado à esquerda em  2em

    bem como as seguintes linhas

                                                                                   p>. alinhado à direita

                                                                        p)))>. identado à direita em 3em

                           p=. Parágrafo centralizado.

</code></pre>

h3. Linha horizontal

@----@

Exibição: 

----

h3. Pré-definido

Para escapar sintaxe wiki

<pre> <pre> *Seu texto não será negrito* </pre> </pre>

Exibição:

<pre> *Seu texto não será negrito* </pre>

h3. Citações

Inicie o parágrafo com *bq.*:

<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.

To go live, all you need to add is a database and a web server.

</code></pre>

Exibição:

bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.

To go live, all you need to add is a database and a web server.

Você também pode usar > no inicio de cada linha e empilhá-los para citações aninhadas:

<pre>

>> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.

>> To go live, all you need to add is a database and a web server.

> Great!

</pre>

Exibição:

>>  Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.

>>  To go live, all you need to add is a database and a web server.

> Great!

h3. Listas não-ordenadas

<pre>

* Item 1

* Item 2

** Item 21

** Item 22

* Item 3

</pre>

exibição:

* Item 1

* Item 2

** Item 21

** Item 22

* Item 3

h3. Listas ordenadas

<pre>

# Item 1

# Item 2

# Item 3

## Item 3.1

## Item 3.2

</pre>

exibição:

# Item 1

# Item 2

# Item 3

## Item 3.1

## Item 3.2

h3. Tabelas

<pre>

|_.UserID      |_.Nome          |_.Grupo     |_. lista atributos  |

|Iniciando com | uma            |   simples  |linha               |

|\3=.TI                                      |<. alinha esquerda  |

|1             |Artur Pirozhkov |/2.Users    |>. alinha direita   |

|2             |Vasya Rogov     |=. centraliza |

|3             |John Smith      |Admin

                                 (root)      |^. alinha topo      |

|4             |-               |Ninguém

                                 (anônimo)   |~. alinha base      |

</pre>

displays (all multiple spaces are replaced by 1 space):

|_.UserID      |_.Nome          |_.Grupo     |_. lista atributos  |

|Iniciando com | uma            |   simples  |linha               |

|\3=.TI                                      |<. alinha esquerda  |

|1             |Artur Pirozhkov |/2.Users    |>. alinha direita   |

|2             |Vasya Rogov     |=. centraliza |

|3             |John Smith      |Admin

                                 (root)      |^. alinha topo      |

|4             |-               |Ninguém

                                 (anônimo)   |~. alinha base      |

Se você quiser inserir o caracter | (pipe) dentro da tabela (ex.: links Wiki), deve-se prevenir que o textile os interprete:

|_.Entrada |_. Saída|

|*<notextile><notextile>|</notextile></notextile>*|<notextile>|</notextile>|

h3. Tabela de conteúdo (TOC)

<pre><code>{{toc}} => toc alinhado à esquerda

{{>toc}} => toc alinhado à direita

</code></pre>

Observe que a tag do TOC precisa de uma linha vazia antes e depois da mesma.

Exemplo:

<pre><code>

h1. TítuloUm

h2. subtítulo

{{toc}}

h2. outro subtítulo

</code></pre>

h2. Macros

O Redmine inclui um sistema de macros que permite adicionar funções personalizadas para inserir conteúdo dinâmico no texto formatado. Você pode aprender a escrever suas próprias macros em [[RedmineMacros]]. O Redmine também inclui algumas macros pré-definidas:

{{macro_list}}

h2. Realçar códigos

O Redmine utiliza o "CodeRay":http://coderay.rubychan.de/ para realce de códigos, uma biblioteca completamente escrita em Ruby. Oferece suporte a C, C++, CSS, Delphi, Diff, Groovy, HTML, Java, Javascript, JSON, Nitro-XHTML, PHP, Python, RHTML, Ruby, Scheme, SQL, XML and YAML code.

Você pode realçar códigos em páginas wiki utilizando a sintaxe:

<pre><code><pre><code class="ruby">

  Insira o código aqui.

</code></pre>

</code></pre>

Exemplo:

<pre><code class="ruby">

# A classe Cumprimentar

class Cumprimentar

  def initialize(nome)

    @nome = nome.capitalize

  end

  def cumprimente

    puts "Olá #{@nome}!"

  end

end

</code></pre>

h2. Formatação Textile

O Redmine suporta formatação textile. Para detalhes, consulte: "Syntaxe Textile":http://en.wikipedia.org/wiki/Textile_%28markup_language%29

Formatação adicional textile suportada:

* *<notextile>%</notextile>{background:lightgreen}Fundo verde%* exibe %{background:lightgreen}Fundo verde%