Project

General

Profile

RusRedmineTextFormatting » History » Version 8

Lucy Yevseyeva, 2014-06-21 15:22

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