Project

General

Profile

BrRedmineWikiFormatting » History » Version 1

André Domarques, 2015-01-21 15:42

1 1 André Domarques
h1. Formatação de texto
2
3
A seguir a formatação de texto em Textile, para formatação em Markdown, consulte #15520
4
5
{{>TOC}}
6
7
h2. Links
8
9
h3. Links do Redmine
10
11
O Redmine permite hiperligações entre recursos (tarefas, revisões, páginas wiki...) a partir de qualquer formatação usada.
12
13
* Link para uma tarefa: *!#124* (exibe #124, o link aparece riscado se a tarefa estiver fechada)
14
* Link para uma nota de tarefa: *!#124-6*, or *!#124!#note-6*
15
* Link para uma revisão: *!r758* (exibe r758)
16
* Link para uma revisão com um hash não númerico: *commit:c6f4d0fd* (exibe c6f4d0fd).
17
18
Links na Wiki:
19
20
* *[[Guide]]* exibe um link para a página nomeada 'Guide': [[Guide]]
21
* *[[Guide|User manual]]* exibe um link para aquela página mas com um texto diferente: [[Guide|User manual]]
22
* *[[Guide#User-guide|User guide]]* exibe um link para o cabeçalho daquela página mas com texto diferente: [[Guide#User-guide|User guide]]
23
24
Você também pode linkar para uma página wiki de outro projeto (usando o identificador do projeto):
25
26
* *[[sandbox:some page]]* exibe um link para a página wiki nomeada 'Some page' do projeto Sandbox
27
* *[[sandbox:]]* exibe um link para a página principal da wiki do projeto Sandbox
28
29
Links wiki são exibidos em vermelho se a página não existir, ex.: [[Nonexistent page]].
30
31
Links para outros recursos:
32
33
* Documentos:
34
35
  * *!document#17* (link para o documento de id 17)
36
  * *!document:Greetings* (link para o documento com título "Greetings")
37
  * *!document:"Some document"* (aspas duplas devem ser usadas quando o título do documento tiver espaços)
38
  * *!sandbox:document:"Some document"* (link para o documento de título "Some document" do projeto "sandbox")
39
40
* Versões:
41
42
  * *!version#3* (link para a versão de id 3)
43
  * *!version:1.0.0* (link para a versão nomeada "1.0.0")
44
  * *!version:"1.0 beta 2"* (aspas duplas devem ser usadas se o nome da versão tiver espaços)
45
  * *!sandbox:version:1.0.0* (link para a versão "1.0.0" do projeto "sandbox")
46
47
* Anexos:
48
  
49
  * *!attachment:file.zip* (link para o anexo nomeado como file.zip)
50
  * *!attachment:"file.zip"* (aspas duplas devem ser usadas quando o nome do arquivo apresentar caracteres especiais)
51
  * Por enquanto, só é possível referenciar anexos do recurso atual (se estiver em uma tarefa, apenas é possível referenciar anexos desta mesma tarefa)
52
53
* Revisões:
54
55
  * *!r758* (link para revisão)
56
  * *!commit:c6f4d0fd* (link para revisão com hash não-númerico)
57
  * *!svn1|r758* (link para revisão de um repositório específico, para projetos com múltiplos repositórios)
58
  * *!commit:hg|c6f4d0fd* (link para revisão com hash não-númerico de um repositório específico)
59
  * *!sandbox:r758* (link para revisão de outro projeto)
60
  * *!sandbox:commit:c6f4d0fd* (link para revisão com hash não-númerico de outro projeto)
61
62
* Arquivos do repositório:
63
64
  * *!source:some/file*           -- Link para arquivo localizado em /some/file no repositório do projeto
65
  * *!source:some/file@52*        -- Link para revisão 52 do arquivo
66
  * *!source:some/file#L120*      -- Link para linha 120 do arquivo
67
  * *!source:some/file@52#L120*   -- Link para linha 120 na revisão 52 do arquivo
68
  * *!source:"some file@52#L120"* -- Aspas duplas devem ser usadas quando a URL apresentar espaços
69
  * *!source:repo_identifier|some/file* -- Link para arquivo de outro repositório que não seja o padrão do projeto. 
70
  * *!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. 
71
  * *!export:some/file*           -- Força o download do arquivo
72
 
73
* Fórums:
74
75
  * *!forum#2* (link para fórum de id 2)
76
  * *!forum:Discussion* (link para fórum de nome "Discussion")
77
  * *!forum:"Help and more"* (aspas duplas devem ser usadas quando o nome do fórum apresentar espaços)
78
79
* Mensagens de fóruns:
80
81
  * *!message#1218* (link para mensagem de id 1218)
82
83
* Notícias
84
85
  * *!news#1* (link para notícia de id 1)
86
  * *!news:Greetings* (link para notícia nomeada "Greetings")
87
  * *!news:"eCookbook first release !"* (aspas duplas devem ser usadas quando o nome da notícia apresentar espaços)
88
89
* Projetos:
90
91
  * *!project#3* (link para projeto de id 3)
92
  * *!project:someproject* (link para projeto de nome "someproject")
93
  * *!project:"Multiple words project"* (aspas duplas devem ser usadas quando o nome do projeto apresentar espaços)
94
95
Escapando:
96
97
* Você pode evitar que links do Redmine sejam processados, precedendo-os com uma exclamação: !
98
99
h3. Links externos
100
101
URLs HTTP são automaticamente transformados em hyperlinks: 
102
* *http://www.redmine.org* -- Link externo para o website do Redmine: http://www.redmine.org
103
* *someone@foo.bar* -- Link para o endereço de email: someone@foo.bar
104
105
URLs HTTP também podem apresentar texto customizado ao invés da URL:
106
* *"Redmine web site":http://www.redmine.org* -- Link externo com texto customizado: "Redmine web site":http://www.redmine.org
107
* *!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: 
108
109
p=. !http://www.redmine.org/attachments/7069/Redmine_logo.png(Redmine web site)!:http://www.redmine.org
110
111
h3. Endereço de e-mail
112
113
Endereços de e-mail são automaticamente transformados em hyperlinks:
114
115
* *"Email someone":mailto:someone@foo.bar* -- Link de e-mail com texto customizado: "Email someone":mailto:someone@foo.bar
116
117
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.
118
* *"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
119
* *"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
120
* *"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
121
122
h2. Formatação de texto
123
124
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.
125
126
h3. Acrônimo
127
128
<pre>
129
JPL(Jean-Philippe Lang)
130
</pre>
131
132
Exibe:
133
134
JPL(Jean-Philippe Lang)
135
136
h3. Estilo de fonte
137
138
<pre><code>* *negrito*
139
* _itálico_
140
* *_negrito itálico_*
141
* +sublinhado+
142
* -riscado-
143
* Texto ^sobrescrito^
144
* Texto ~subscrito~
145
* @Monoespaçado em linha@
146
* <notextile>normal *negrito* _itálico_ normal;E=mc ^2^</notextile>
147
* <notextile>normal<notextile></notextile>*negrito*<notextile></notextile>_itálico_<notextile></notextile>normal;E=mc<notextile></notextile>^2^</notextile>
148
* <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>
149
* <notextile><pre>*algumas linhas*      algum "link":http://www.redmine.org</pre></notextile>
150
* <notextile><pre><notextile></notextile>*algumas linhas*      algum "link":http://www.redmine.org</pre></notextile>
151
</code></pre>
152
153
Exibição:
154
155
 * *negrito*
156
 * _itálico_
157
 * *_negrito itálico_*
158
 * +sublinhado+
159
 * -riscado-
160
 * Texto ^sobrescrito^
161
 * Texto ~subscrito~
162
 * @Monoespaçado@
163
 * normal *negrito* _itálico_ normal;E=mc ^2^
164
 * normal<notextile></notextile>*negrito*<notextile></notextile>_itálico_<notextile></notextile>normal;E=mc<notextile></notextile>^2^
165
 * 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;
166
 * <pre>*algumas linhas*      algum "link":http://www.redmine.org</pre>
167
 * <pre><notextile></notextile>*algumas linhas*      algum "link":http://www.redmine.org</pre>
168
169
h3. Cores
170
171
<pre><code><notextile>* %{color:red}vermelho% %{color:green}verde% %{color:yellow}amarelo% %{color:#82B6E1}azul%
172
* %{color:red}vermelho%<notextile></notextile>%{color:green}verde%<notextile></notextile>%{color:yellow}amarelo%<notextile></notextile>%{color:#82B6E1}azul%
173
* %{background:lightgreen}Fundo verde-claro% %{background:yellow}Fundo amarelo%
174
* %{background:lightgreen}Fundo verde-claro%<notextile></notextile>%{background:yellow}Fundo amarelo%
175
</notextile></code></pre>
176
177
Exibição:
178
179
 * %{color:red}vermelho% %{color:green}verde% %{color:yellow}amarelo% %{color:#82B6E1}azul%
180
 * %{color:red}vermelho%<notextile></notextile>%{color:green}verde%<notextile></notextile>%{color:yellow}amarelo%<notextile></notextile>%{color:#82B6E1}azul%
181
 * %{background:lightgreen}Fundo verde-claro% %{background:yellow}Fundo amarelo%
182
 * %{background:lightgreen}Fundo verde-claro%<notextile></notextile>%{background:yellow}Fundo amarelo%
183
184
h3. Imagens
185
186
* *&#33;image_url&#33;* exibe imagem localizada em image_url (textile syntax)
187
* *&#33;>image_url&#33;* imagem alinhada à direita
188
* *&#33;image_url(Image title)&#33;* exibe imagem com atributo alt/title
189
* *&#33;image_url&#33;:URL* exibe imagem localiza em image_url com link embutido
190
191
Se você tiver uma imagem anexada na página wiki, pode ser inserida informando o nome do arquivo: *&#33;attached_image.png&#33;*
192
193
Você também pode aplicar estilo CSS na image da mesma forma ao estilizar SPANs. O código *&#33;{width: 100%}attached_image.png&#33;* irá ajustar a imagem conforme largura do elemento pai. 
194
195
h3. Cabeçalhos
196
197
<pre><code>h1. Título
198
199
h2. Subtítulo
200
201
h3. Subtítulo
202
</code></pre>
203
204
Redmine atribui uma âncora para cada um desses títulos, assim você pode linká-los com "#Heading", "#Subheading" e assim por diante.
205
206
h3. Parágrafos
207
208
<pre><code>p. alinhado à esquerda
209
210
  p(. identado à equerda em 1em
211
212
    p((. identado à equerda em  2em
213
    bem como as seguintes linhas
214
215
                                                                                   p>. alinhado à direita
216
217
                                                                        p)))>. identado à direita em 3em
218
219
                           p=. Parágrafo centralizado.
220
</code></pre>
221
222
h3. Linha horizontal
223
224
@----@
225
Exibição: 
226
227
----
228
229
230
h3. Pré-definido
231
232
Para escapar sintaxe wiki
233
<pre> <pre> *Seu texto não será negrito* </pre> </pre>
234
Exibição:
235
236
<pre> *Seu texto não será negrito* </pre>
237
238
h3. Citações
239
240
Inicie o parágrafo com *bq.*:
241
242
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
243
To go live, all you need to add is a database and a web server.
244
</code></pre>
245
246
Exibição:
247
248
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
249
To go live, all you need to add is a database and a web server.
250
251
Você também pode usar > no inicio de cada linha e empilhá-los para citações aninhadas:
252
253
<pre>
254
>> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
255
>> To go live, all you need to add is a database and a web server.
256
> Great!
257
</pre>
258
259
Exibição:
260
261
>>  Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
262
>>  To go live, all you need to add is a database and a web server.
263
> Great!
264
265
h3. Listas não-ordenadas
266
267
<pre>
268
* Item 1
269
* Item 2
270
** Item 21
271
** Item 22
272
* Item 3
273
</pre>
274
275
exibição:
276
277
* Item 1
278
* Item 2
279
** Item 21
280
** Item 22
281
* Item 3
282
283
h3. Listas ordenadas
284
285
<pre>
286
# Item 1
287
# Item 2
288
# Item 3
289
## Item 3.1
290
## Item 3.2
291
</pre>
292
293
exibição:
294
295
# Item 1
296
# Item 2
297
# Item 3
298
## Item 3.1
299
## Item 3.2
300
301
h3. Tabelas
302
303
<pre>
304
|_.UserID      |_.Nome          |_.Grupo     |_. lista atributos  |
305
|Iniciando com | uma            |   simples  |linha               |
306
|\3=.TI                                      |<. alinha esquerda  |
307
|1             |Artur Pirozhkov |/2.Users    |>. alinha direita   |
308
|2             |Vasya Rogov     |=. centraliza |
309
|3             |John Smith      |Admin
310
                                 (root)      |^. alinha topo      |
311
|4             |-               |Ninguém
312
                                 (anônimo)   |~. alinha base      |
313
</pre>
314
315
displays (all multiple spaces are replaced by 1 space):
316
317
|_.UserID      |_.Nome          |_.Grupo     |_. lista atributos  |
318
|Iniciando com | uma            |   simples  |linha               |
319
|\3=.TI                                      |<. alinha esquerda  |
320
|1             |Artur Pirozhkov |/2.Users    |>. alinha direita   |
321
|2             |Vasya Rogov     |=. centraliza |
322
|3             |John Smith      |Admin
323
                                 (root)      |^. alinha topo      |
324
|4             |-               |Ninguém
325
                                 (anônimo)   |~. alinha base      |
326
327
Se você quiser inserir o caracter | (pipe) dentro da tabela (ex.: links Wiki), deve-se prevenir que o textile os interprete:
328
329
|_.Entrada |_. Saída|
330
|*<notextile><notextile>|</notextile></notextile>*|<notextile>|</notextile>|
331
332
h3. Tabela de conteúdo (TOC)
333
334
<pre><code>{{toc}} => toc alinhado à esquerda
335
{{>toc}} => toc alinhado à direita
336
</code></pre>
337
338
Observe que a tag do TOC precisa de uma linha vazia antes e depois da mesma.
339
340
Exemplo:
341
342
<pre><code>
343
h1. TítuloUm
344
345
h2. subtítulo
346
347
{{toc}}
348
349
h2. outro subtítulo
350
</code></pre>
351
352
h2. Macros
353
354
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:
355
356
{{macro_list}}
357
358
h2. Realçar códigos
359
360
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.
361
362
Você pode realçar códigos em páginas wiki utilizand a sintaxe:
363
364
<pre><code><pre><code class="ruby">
365
  Insira o código aqui.
366
</code></pre>
367
</code></pre>
368
369
Exemplo:
370
371
<pre><code class="ruby">
372
# A classe Cumprimentar
373
class Cumprimentar
374
  def initialize(nome)
375
    @nome = nome.capitalize
376
  end
377
 
378
  def cumprimente
379
    puts "Olá #{@nome}!"
380
  end
381
end
382
</code></pre>
383
384
h2. Formatação Textile
385
386
O Redmine suporta formatação textile. Para detalhes, consulte: "Syntaxe Textile":http://en.wikipedia.org/wiki/Textile_%28markup_language%29
387
388
Formatação adicional textile suportada:
389
* *<notextile>%</notextile>{background:lightgreen}Fundo verde%* exibe %{background:lightgreen}Fundo verde%