Project

General

Profile

RedmineTextFormattingRus » History » Version 7

Lucy Yevseyeva, 2011-09-03 15:14

1 7 Lucy Yevseyeva
h1. Оформление текстов
2 1 Vladimir Vasilkin
3
{{>TOC}}
4
5 7 Lucy Yevseyeva
Для таких вещей как заголовки, выделение текста, таблицы, списки и т.п. Redmine поддерживает[1] парсер "Textile":http://textile.thresholdstate.com.
6 1 Vladimir Vasilkin
7 7 Lucy Yevseyeva
h2. Строчные элементы
8 1 Vladimir Vasilkin
9 7 Lucy Yevseyeva
h3. Внешние ссылки
10 1 Vladimir Vasilkin
11 7 Lucy Yevseyeva
Адреса http(s), ftp и mail автоматически преобразуются в "кликабельные" ссылки:
12 1 Vladimir Vasilkin
13 7 Lucy Yevseyeva
p(. *http://www.redmine.org*:  http://www.redmine.org
14 1 Vladimir Vasilkin
15 7 Lucy Yevseyeva
p(. *someone@foo.bar*: someone@foo.bar.
16 1 Vladimir Vasilkin
17 7 Lucy Yevseyeva
Для размещения в ссылке произвольного текста используйте следующую разметку:
18 1 Vladimir Vasilkin
19 7 Lucy Yevseyeva
p(. *"Главная страница проекта Redmine":http://www.redmine.org*: "Главная страница проекта Redmine":http://www.redmine.org.
20 1 Vladimir Vasilkin
21 7 Lucy Yevseyeva
h3. Акронимы
22 1 Vladimir Vasilkin
23 7 Lucy Yevseyeva
Ненавязчиво пояснить аббревиатуры в тексте можно следующим образом[2]:
24 1 Vladimir Vasilkin
25 7 Lucy Yevseyeva
p(. *JPL(Jean-Philippe Lang)*: JPL(Jean-Philippe Lang).
26 1 Vladimir Vasilkin
27 7 Lucy Yevseyeva
h3. Стили шрифтов
28 3 Vladimir Vasilkin
29 7 Lucy Yevseyeva
p(. *_italic_*: _курсив_
30 1 Vladimir Vasilkin
31 7 Lucy Yevseyeva
p(. **_bold italic_**: *_жирный курсив_*
32 1 Vladimir Vasilkin
33 7 Lucy Yevseyeva
p(. *+underline+*: +подчеркнутый+
34 1 Vladimir Vasilkin
35 7 Lucy Yevseyeva
p(. *-strike-through-*: -перечеркнутый-
36 1 Vladimir Vasilkin
37 7 Lucy Yevseyeva
p(. *Plain ^superscript^*: ^Верхний^ индекс
38
39
p(. *Plain ~subscript~*: ~Нижний~ индекс
40
41
p(. *inline @monospace@*: @моноширинный@ шрифт
42
43
p(. *??cite??*: ??цитата??
44
45
p(. *%span%*: %диапазон%
46
47 1 Vladimir Vasilkin
h3. Изображения
48
49 7 Lucy Yevseyeva
Внешние:
50 1 Vladimir Vasilkin
51 7 Lucy Yevseyeva
p(. *!image_url!* -- встраивает в текст изображение, находящееся по внешнему адресу image_url.
52 1 Vladimir Vasilkin
53 7 Lucy Yevseyeva
p(. *!>image_url!* -- изображение выровнено по правому краю, текст обтекает изображение по левому краю.
54
55
Прикрепленные:
56
57
p(. *!attached_image.png!* -- встраивает в текст изображение attached_image.png, прикрепленное к странице (см. [[RedmineTextFormattingRus#attach|предупреждение]]).
58
59
Примеры:
60
* *!i0003.gif!* изображение, причем текст будет продолжен после изображения !i0003.gif! вот так
61 1 Vladimir Vasilkin
* *!>i0003.gif!* изображение отображается справа от текста !>i0003.gif!
62
пример изображения справа от текста
63
опять справа от текста
64
еще справа от текста
65
и тут картинка справа от текста
66
а тут текст слева от картинки
67
68 7 Lucy Yevseyeva
h2. Блочные элементы
69 1 Vladimir Vasilkin
70 7 Lucy Yevseyeva
Для корректной обработки textile-разметки рекомендуется помещать блочные элементы (p, h, bq, fn) в самое начало строки и отделять их от остального текста пустыми строками.
71 1 Vladimir Vasilkin
72
h3. Заголовки
73
74 7 Lucy Yevseyeva
p(. *hn.* Заголовок n-ного уровня, где _n_ принимает значение от 1 до 6.
75 1 Vladimir Vasilkin
76 7 Lucy Yevseyeva
h3. Абзацы
77 1 Vladimir Vasilkin
78 7 Lucy Yevseyeva
p. *p.* Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
79 1 Vladimir Vasilkin
80 7 Lucy Yevseyeva
p(. *p(.* Отступ слева в 1em. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
81 1 Vladimir Vasilkin
82 7 Lucy Yevseyeva
p((. *p((.* Отступ слева в 2em. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
83
Отступ сохраняется для всех следующих без пробела строк.
84 1 Vladimir Vasilkin
85 7 Lucy Yevseyeva
p>. *p>.* Выравнивание по правому краю. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
86 1 Vladimir Vasilkin
87 7 Lucy Yevseyeva
p<. *p<.* Выравнивание по левому краю (по умолчанию).
88 1 Vladimir Vasilkin
89 7 Lucy Yevseyeva
p)))>. *p)))>.* Выравнивание по правому краю с отступом справа в 3em. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
90
_Выравнивание и отступ также сохраняется для всего следующего через перенос строки (@<br>@)
91
 текста._
92 1 Vladimir Vasilkin
93 7 Lucy Yevseyeva
_Выравнивание сбрасывается с введением пустой строки между выровненным блочным элементом и остальным текстом._
94 1 Vladimir Vasilkin
95 7 Lucy Yevseyeva
p=. *p=.* Выравнивание по центру. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
96 1 Vladimir Vasilkin
97 7 Lucy Yevseyeva
p<>. *p<>.* Выравнивание по левому и правому краю. Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
98 1 Vladimir Vasilkin
99 7 Lucy Yevseyeva
h3. Pre-форматирование
100 1 Vladimir Vasilkin
101 7 Lucy Yevseyeva
> Внутри выделенного *тэгами* блока текст не будет преобразован [[RedmineTextFormattingRus#Разметка Textile|Парсером]].
102 1 Vladimir Vasilkin
103 7 Lucy Yevseyeva
Чтобы избежать преобразования textile-разметки в html-код используйте тэги @&#60;pre>&#60;/pre>@.
104 1 Vladimir Vasilkin
105 7 Lucy Yevseyeva
<pre><pre>Внутри выделенного *тэгами* блока текст не будет преобразован [[RedmineTextFormattingRus#Разметка Textile|Парсером]].</pre></pre>
106 1 Vladimir Vasilkin
107 7 Lucy Yevseyeva
h3. Цитаты
108 1 Vladimir Vasilkin
109 7 Lucy Yevseyeva
> *&#62;* "Ruby on Rails" — программный каркас, написанный на языке программирования Ruby. Ruby on Rails предоставляет архитектурный образец Model-View-Controller (модель-представление-контроллер) для веб-приложений, а также обеспечивает их интеграцию с веб-сервером и сервером базы данных.
110
 или
111 1 Vladimir Vasilkin
112 7 Lucy Yevseyeva
bq.:http://ru.wikipedia.org/wiki/Ruby_on_Rails *bq.:http://ru.wikipedia.org/wiki/Ruby_on_Rails* "Ruby on Rails" — программный каркас, написанный на языке программирования Ruby. Ruby on Rails предоставляет архитектурный образец Model-View-Controller (модель-представление-контроллер) для веб-приложений, а также обеспечивает их интеграцию с веб-сервером и сервером базы данных.
113 1 Vladimir Vasilkin
114 7 Lucy Yevseyeva
>> *&#62;&#62;* Синтаксис textile-ссылки @:http://ru.wikipedia.org/wiki/Ruby_on_Rails@ преобразуется в атрибут @cite="http://ru.wikipedia.org/wiki/Ruby_on_Rails"@.
115 1 Vladimir Vasilkin
116 7 Lucy Yevseyeva
>>> Вдруг кому пригодится.
117 1 Vladimir Vasilkin
118 7 Lucy Yevseyeva
h3. Списки
119 1 Vladimir Vasilkin
120 7 Lucy Yevseyeva
Обратите внимание на то, как работает вложенность элементов при вставке пустой строки между ними.
121
Вложенность сохраняется при наличие отступа у последующего элемента списка и сбрасывается - без отступа.
122 1 Vladimir Vasilkin
123 7 Lucy Yevseyeva
Разметка для ненумерованного списка
124
<pre>* Item 1
125 1 Vladimir Vasilkin
* Item 2
126 7 Lucy Yevseyeva
** Item 2.1
127
128
 ** Item 2.1.1
129
*** Item 2.1.2
130
** Item 2.2
131 1 Vladimir Vasilkin
* Item 3
132
133 7 Lucy Yevseyeva
** Item 0
134
</pre>
135
отображается как:
136 1 Vladimir Vasilkin
* Item 1
137
* Item 2
138 7 Lucy Yevseyeva
** Item 2.1
139
140
 ** Item 2.1.1
141
*** Item 2.1.2
142
** Item 2.2
143 1 Vladimir Vasilkin
* Item 3
144
145 7 Lucy Yevseyeva
** Item 0
146 1 Vladimir Vasilkin
147 7 Lucy Yevseyeva
Разметка для нумерованного списка
148
<pre># Item 1
149 1 Vladimir Vasilkin
# Item 2
150
151 7 Lucy Yevseyeva
 ## Item 2.1
152 1 Vladimir Vasilkin
153 7 Lucy Yevseyeva
  ## Item 2.1.1
154
## Item 2.2
155
# Item 3
156
157
# Item 0
158
</pre>
159
отображается как:
160 1 Vladimir Vasilkin
# Item 1
161
# Item 2
162 7 Lucy Yevseyeva
163
 ## Item 2.1
164
165
  ## Item 2.1.1
166
## Item 2.2
167 1 Vladimir Vasilkin
# Item 3
168
169 7 Lucy Yevseyeva
# Item 0
170 1 Vladimir Vasilkin
171
h3. Таблицы
172
173 7 Lucy Yevseyeva
Любое количество пустых символов будет заменено одним пробелом, поэтому для удобства разметки можно использовать текстовый редактор и табуляцию.
174
175 1 Vladimir Vasilkin
<pre>
176 7 Lucy Yevseyeva
|_.UserID|_.Name|_.Group|_. attribute list |
177
|\3=.IT               |<. align left|
178
|1|Artur Pirozhkov |/2.Users |>. align right|
179
|2|Vasya Rogov        |=. center |
180
|3|John Smith |Admin
181
               (root)|^. valign top |
182
|4|-          |Nobody
183
               (anonymous)|~. valign bottom|
184
185 1 Vladimir Vasilkin
</pre>
186
187 7 Lucy Yevseyeva
Отображается как:
188
|_.UserID|_.Name|_.Group|_. attribute list |
189
|\3=.IT               |<. align left|
190
|1|Artur Pirozhkov |/2.Users |>. align right|
191
|2|Vasya Rogov        |=. center |
192
|3|John Smith |Admin[3]
193
(root)|^. valign top |
194
|4|-          |Nobody
195
               (anonymous)|~. valign bottom|
196 1 Vladimir Vasilkin
197 7 Lucy Yevseyeva
h3. Сноски
198 1 Vladimir Vasilkin
199 7 Lucy Yevseyeva
Сноска:
200 1 Vladimir Vasilkin
201 7 Lucy Yevseyeva
fn21. *fn21.* Поясняющий текст.
202 1 Vladimir Vasilkin
203 7 Lucy Yevseyeva
Ссылка на сноску[4]:
204 1 Vladimir Vasilkin
205 7 Lucy Yevseyeva
p(. *Поясняемый текст&#91;21]*: Поясняемый текст[21]
206
207
h2. Атрибуты
208
209
h3. Идентификаторы
210
211
p(. *p(#id).* -- присваивает абзацу идентификатор id.
212
213
Пример: 
214
215
p((#id). Данный абзац имеет идентификатор id, что может быть использовано, например, для создания [[RedmineTextFormattingRus#id|ссылки]] на него.
216
217
h3. Классы css
218
219
p(. *p(class).* -- присваивает абзацу класс class.
220
221
Пример:
222
223
p((ruby syntaxhl). Данный абзац содержит фразу, оформленную в стиле %(fu)ruby функции.%
224
225
h2. Ссылки на объекты
226
227
Чтобы предотвратить преобразование redmine-разметки в ссылку поставьте перед ней восклицательный знак.
228
229
h3. Задачи
230
231
p(. *!#124*: #124 -- ссылка перечеркнута, если задача закрыта.
232
233
h3. Редакции
234
235
p(. *!r758*: r758
236
237
h3. Коммиты 
238
239
p(. *commit:c6f4d0fd*: commit:c6f4d0fd
240
241
h3. Wiki-страницы
242
243
Ссылка отображается красной, если страницы не существует: [[Nonexistent page]].
244
245
p(. *&#91;&#91;Guide&#93;&#93;*: [[Guide]]
246
247
p(. *&#91;&#91;Guide&#124;User manual&#93;&#93;*: [[Guide|User manual]] -- ссылка с произвольным текстом.
248
249
p(. *&#91;&#91;Guide#User-guide&#124;User guide&#93;&#93;*: [[Guide#User-guide|User guide]] -- ссылка на определенный заголовок страницы.
250
_После символа # в названии заголовка ставятся дефисы вместо пробелов._
251
252
p(. *&#91;&#91;someproject:some-page&#93;&#93;* -- ссылка на wiki-страницу из другого проекта.
253
254
p(. *&#91;&#91;someproject:&#93;&#93;* -- ссылка на главную страницу Wiki другого проекта.
255
256
h3. Документы
257
258
p(. *!document#17* -- ссылка на документ по идентификатору.
259
260
p(. *!document:somedocument* -- ссылка на документ по названию.
261
262
p(. *!document:"Some document"* -- название заключается в двойные кавычки, если в нем есть пробелы.
263
264
p(. *!document:some_project:"Some document"* -- ссылка по названию на доукумент в другом проекте.
265
266
h3. Версии
267
268
p(. *!version#3* -- ссылка на версию по идентификатору.
269
270
p(. *!version:1.0.0* -- ссылка на версию по названию.
271
272
p(. *!version:"1.0 beta 2"* -- название заключается в двойные кавычки, если в нем есть пробелы.
273
274
h3. Проекты
275
276
p(. *project#4* или *!project:someid* -- ссылка на проект по числовому или символьному идентификатору.
277
278
p(. *!project:someproject* - ссылка на проект по названию.
279
280
p(. *!project:"Some project"* - название заключается в двойные кавычки, если в нем есть пробелы.
281
282
h3. Вложения
283
  
284
p(. *!attachment:i0003.gif*: attachment:i0003.gif -- ссылка на файл, прикрепленный к данной странице.
285
286
p((#attach). _*Важно*_: ссылки на прикрепленные файлы действуют только на той странице, к которой они прикреплены.
287
288
h3. Репозиторий
289
290
p(. *!source:some/file* -- ссылка на файл репозитория.
291
292
p(. *!source:some/file@52* -- ссылка на редакцию файла репозитория.
293
294
p(. *!source:some/file#L120* -- ссылка на строку файла репозитория.
295
296
p(. *!source:some/file@52#L120* -- комбинация разметки.
297
298
p(. *!source:"some file@52#L120"* -- двойные кавычки используются, если в URL присутствуют пробелы.
299
300
p(. *!export:some/file* -- ссылка на скачивание файла.
301
302
h2. E-mail ссылки
303
304
В ссылке на e-mail адрес можно указать тему, текст письма и адреса для отправки копий.
305
306
p(. *"Email webmaster and admin"&#58;mailto&#58;webmaster&#64;foo.bar?cc=admin&#64;foo.bar*: "Email webmaster and admin":mailto:webmaster@foo.bar?cc=admin@foo.bar -- указание адреса для отправки копии.
307
308
p(. *"Email someone for help"&#58;mailto&#58;someone&#64;foo.bar?subject=Website%20Help*: "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help -- указание темы письма.
309
310
p(. *"Email someone for help"&#58;mailto&#58;someone&#64;foo.bar?subject=Website%20Help&body=My%20problem%20is%20*: "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20 -- указание текста письма.
311
312
p(. _*Важно_:* вместо пробелов в ссылку следует вставлять код %20.
313
314
h2. Макросы
315
316
Список доступных макросов и их описание (по-английски) вызывается макросом *&#123;{macro_list}}*.
317
318 1 Vladimir Vasilkin
{{>TOC}}
319
320 7 Lucy Yevseyeva
h3. Содержание
321 1 Vladimir Vasilkin
322 7 Lucy Yevseyeva
*&#123;{TOC}}* -- отображает содержание страницы, которое формируется автоматически на основе [[RedmineTextFormattingRus#Заголовки|заголовков]].
323
*&#123;{>TOC}}* -- выравнивание блока содержания по правому краю:
324 1 Vladimir Vasilkin
325 7 Lucy Yevseyeva
h3. Дочерние страницы
326 1 Vladimir Vasilkin
327 7 Lucy Yevseyeva
*&#123;{child_pages}}* -- выводит список ссылок на все "дочерние страницы":http://www.redmine.org/projects/redmine/wiki/RedmineWikis#Creating-sub-pages-parentchild-relationships (англ.) данной страницы.
328
*&#123;{child_pages(Foo)}}* -- выводит список ссылок для указанной в скобках wiki-страницы [[Foo]].
329
*&#123;{child_pages(Foo, parent=1)}}* -- начинает список со ссылки на родительскую страницу.
330 1 Vladimir Vasilkin
331 7 Lucy Yevseyeva
Пример последнего макроса для данной страницы:
332
{{child_pages(parent=1)}}
333 1 Vladimir Vasilkin
334 7 Lucy Yevseyeva
h3. Включение текста
335
336
*&#123;{include(Foo)}}* -- включает в данном месте текста содержимое страницы [[Foo]] без каких-либо специальных обозначений.
337
338
Пример:
339
340
{{include(Foo)}}
341
Если включаемой страницы не существует или у пользователя нет к ней доступа, будет выведено сообщение об ошибке.
342
343
h2. Подсветка кода
344
345
Подсветка кода реализована на "CodeRay":http://coderay.rubychan.de/ - скоростной библиотеке, написанной на Ruby. Она поддерживает синтаксис C, C++, CSS, Delphi, Diff, Groovy, HTML, Java, Javascript, JSON, Nitro-XHTML, PHP, Python, RHTML, Ruby, Scheme, SQL, XML и YAML.
346
347
Чтобы подсветить код, используйте следующую разметку:
348
349
<pre><code><pre><code class="ruby">
350
  Place your code here.
351
</code></pre>
352
</code></pre>
353
354
Пример:
355
356
<pre><code class="ruby">
357
# The Greeter class
358
class Greeter
359
  def initialize(name)
360
    @name = name.capitalize
361
  end
362
 
363
  def salute
364
    puts "Hello #{@name}!"
365
  end
366
end
367
</code></pre>
368
369
h2. Заключение
370
371
Простейшие возможности разметки доступны через кнопки над полем ввода.
372
Историю изменений wiki-страницы можно посмотреть, нажав ссылку "История " вверху справа.
373
В качестве примера всех перечисленных вариантов разметки можно рассмотреть исходный код данной статьи.
374
375
fn1. Синтаксис Textile поддерживается в Redmine не полностью. В частности, не преобразуются спецсимволы, например, (с) в &copy;, -- в &mdash; и т.п., а также не поддерживается разметка: атрибута {color:red} и блоков bq.., bc. и pre.
376
377
fn2. К сожалению, не работает для кириллицы: ИС(Информационные Системы)
378
379
fn3. Перенос строки в тексте преобразуется парсером в @<br>@.
380
381
fn4. Ссылка не обрабатывается если отделяется от поясняемой фразы: например [4] или "другой пример"[4].