Formatação de texto

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

Links

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: User manual
  • [[Guide#User-guide|User guide]] exibe um link para o cabeçalho daquela página mas com texto diferente: 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: !

Links externos

URLs HTTP são automaticamente transformados em hyperlinks: 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/attachments/7069/Redmine_logo.png(Redmine web site)!:http://www.redmine.org -- Imagem externa com título que linka para uma URL:

Redmine web site

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
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
  • "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help -- Link de e-mail com assunto "Website Help": Email someone for help
  • "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

Formatação de texto

Para elementos como cabeçalhos, negrito, tabelas, listas, o Redmine suporta Sintaxe Textile. 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.

Acrônimo

JPL(Jean-Philippe Lang)

Exibe:

JPL

Estilo de fonte

* *negrito*
* _itálico_
* *_negrito itálico_*
* +sublinhado+
* -riscado-
* Texto ^sobrescrito^
* Texto ~subscrito~
* @Monoespaçado em linha@
* normal *negrito* _itálico_ normal;E=mc ^2^
* normal<notextile></notextile>*negrito*<notextile></notextile>_itálico_<notextile></notextile>normal;E=mc<notextile></notextile>^2^
* 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;
* <pre>*algumas linhas*      algum "link":http://www.redmine.org</pre>
* <pre><notextile></notextile>*algumas linhas*      algum "link":http://www.redmine.org</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
  • normalnegritoitáliconormal;E=mc2
  • Escaping: *negrito* _itálico_ @monoespaçado@       Alternativa usando códigos HTML: *negrito* _itálico_ @monoespaçado@
  • *algumas linhas*      algum "link":http://www.redmine.org
  • algumas linhas      algum link

Cores

* %{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%

Exibição:

  • vermelho verde amarelo azul
  • vermelhoverdeamareloazul
  • Fundo verde-claro Fundo amarelo
  • Fundo verde-claroFundo amarelo

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.

Cabeçalhos

h1. Título

h2. Subtítulo

h3. Subtítulo

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

Parágrafos

p. alinhado à esquerda

  p(. identado à equerda em 1em

    p((. identado à equerda em  2em
    bem como as seguintes linhas

                                                                                   p>. alinhado à direita

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

                           p=. Parágrafo centralizado.

Linha horizontal

----
Exibição:


Pré-definido

Para escapar sintaxe wiki

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

Exibição:

 *Seu texto não será negrito* 

Citações

Inicie o parágrafo com bq.:

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.

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.

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

>> 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!

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!

Listas não-ordenadas

* Item 1
* Item 2
** Item 21
** Item 22
* Item 3

exibição:

  • Item 1
  • Item 2
    • Item 21
    • Item 22
  • Item 3

Listas ordenadas

# Item 1
# Item 2
# Item 3
## Item 3.1
## Item 3.2

exibição:

  1. Item 1
  2. Item 2
  3. Item 3
    1. Item 3.1
    2. Item 3.2

Tabelas

|_.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      |

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

UserID Nome Grupo lista atributos
Iniciando com uma simples linha
TI alinha esquerda
1 Artur Pirozhkov 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> |

Tabela de conteúdo (TOC)

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

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

Exemplo:


h1. TítuloUm

h2. subtítulo

{{toc}}

h2. outro subtítulo

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:

hello_world

Sample macro.

macro_list

Displays a list of all available macros, including description if available.

child_pages

Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:

!{{child_pages}} -- can be used from a wiki page only
!{{child_pages(depth=2)}} -- display 2 levels nesting only
include

Include a wiki page. Example:

!{{include(Foo)}}

or to include a page of a specific project wiki:

!{{include(projectname:Foo)}}
collapse

Inserts of collapsed block of text. Example:

{{collapse(View details...)
This is a block of text that is collapsed by default.
It can be expanded by clicking a link.
}}
thumbnail

Displays a clickable thumbnail of an attached image. Examples:

{{thumbnail(image.png)}}
{{thumbnail(image.png, size=300, title=Thumbnail)}}
sample_macro

Sample macro

Realçar códigos

O Redmine utiliza o CodeRay 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 utilizand a sintaxe:

<pre><code class="ruby">
  Insira o código aqui.
</code></pre>

Exemplo:

# A classe Cumprimentar
class Cumprimentar
  def initialize(nome)
    @nome = nome.capitalize
  end

  def cumprimente
    puts "Olá #{@nome}!" 
  end
end

Formatação Textile

O Redmine suporta formatação textile. Para detalhes, consulte: Syntaxe Textile

Formatação adicional textile suportada:
  • %{background:lightgreen}Fundo verde% exibe Fundo verde