Chris@1464
|
1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
|
Chris@1464
|
2 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
|
Chris@1464
|
3 <head>
|
Chris@1464
|
4 <title>Форматирование Wiki Redmine</title>
|
Chris@1464
|
5 <meta http-equiv="content-type" content="text/html; charset=utf-8" />
|
Chris@1464
|
6 <style type="text/css">
|
Chris@1464
|
7 body { font:80% Verdana,Tahoma,Arial,sans-serif; }
|
Chris@1464
|
8 h1, h2, h3, h4 { font-family: Trebuchet MS,Georgia,"Times New Roman",serif; }
|
Chris@1464
|
9 pre, code { font-size:120%; }
|
Chris@1464
|
10 pre code { font-size:100%; }
|
Chris@1464
|
11 pre {
|
Chris@1464
|
12 margin: 1em 1em 1em 1.6em;
|
Chris@1464
|
13 padding: 2px;
|
Chris@1464
|
14 background-color: #fafafa;
|
Chris@1464
|
15 border: 1px solid #dadada;
|
Chris@1464
|
16 width:95%;
|
Chris@1464
|
17 overflow-x: auto;
|
Chris@1464
|
18 }
|
Chris@1464
|
19 a.new { color: #b73535; }
|
Chris@1464
|
20
|
Chris@1464
|
21 .syntaxhl .line-numbers { padding: 2px 4px 2px 4px; background-color: #eee; margin:0 }
|
Chris@1464
|
22 .syntaxhl .comment { color:#666; }
|
Chris@1464
|
23
|
Chris@1464
|
24 .syntaxhl .class { color:#B06; font-weight:bold }
|
Chris@1464
|
25 .syntaxhl .delimiter { color:black }
|
Chris@1464
|
26 .syntaxhl .function { color:#06B; font-weight:bold }
|
Chris@1464
|
27
|
Chris@1464
|
28 .syntaxhl .inline { background: #eee }
|
Chris@1464
|
29 .syntaxhl .inline .inline-delimiter { font-weight: bold; color: #888 }
|
Chris@1464
|
30
|
Chris@1464
|
31 .syntaxhl .instance-variable { color:#33B }
|
Chris@1464
|
32 .syntaxhl .reserved { color:#080; font-weight:bold }
|
Chris@1464
|
33
|
Chris@1464
|
34 .syntaxhl .string { background-color:#fff0f0; color: #D20; }
|
Chris@1464
|
35 .syntaxhl .string .delimiter { color:#710 }
|
Chris@1464
|
36
|
Chris@1464
|
37 </style>
|
Chris@1464
|
38 </head>
|
Chris@1464
|
39
|
Chris@1464
|
40 <body>
|
Chris@1464
|
41 <h1><a name="1" class="wiki-page"></a>Форматирование Wiki</h1>
|
Chris@1464
|
42
|
Chris@1464
|
43 <h2><a name="2" class="wiki-page"></a>Ссылки</h2>
|
Chris@1464
|
44
|
Chris@1464
|
45 <h3><a name="3" class="wiki-page"></a>Ссылки Redmine</h3>
|
Chris@1464
|
46
|
Chris@1464
|
47 <p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
|
Chris@1464
|
48 <ul>
|
Chris@1464
|
49 <li>Ссылка на задачу: <strong>#124</strong>
|
Chris@1464
|
50 (
|
Chris@1464
|
51 <del><a href="#" class="issue"
|
Chris@1464
|
52 title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>
|
Chris@1464
|
53 - ссылка зачёркнута, если задача закрыта)
|
Chris@1464
|
54 </li>
|
Chris@1464
|
55 <li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
|
Chris@1464
|
56 </ul>
|
Chris@1464
|
57
|
Chris@1464
|
58 <p>Wiki ссылки:</p>
|
Chris@1464
|
59
|
Chris@1464
|
60 <ul>
|
Chris@1464
|
61 <li><strong>[[Руководство]]</strong> выводит ссылку на страницу с названием 'Руководство': <a href="#"
|
Chris@1464
|
62 class="wiki-page">Руководство</a>
|
Chris@1464
|
63 </li>
|
Chris@1464
|
64 <li><strong>[[Руководство#дальнейшее-чтение]]</strong> направляет на метку "дальнейшее-чтение". Заголовкам
|
Chris@1464
|
65 автоматически
|
Chris@1464
|
66 метки, таким образом, вы можете на них ссылаться: <a href="#" class="wiki-page">Руководство</a></li>
|
Chris@1464
|
67 <li><strong>[[Руководство|Руководство пользователя]]</strong> выводит ссылку на саму страницу, но с другим текстом:
|
Chris@1464
|
68 <a href="#" class="wiki-page">Руководство пользователя</a>
|
Chris@1464
|
69 </li>
|
Chris@1464
|
70 </ul>
|
Chris@1464
|
71
|
Chris@1464
|
72 <p>Также вы можете ссылаться на wiki:</p>
|
Chris@1464
|
73
|
Chris@1464
|
74 <ul>
|
Chris@1464
|
75 <li><strong>[[sandbox:Некоторая страница]]</strong> выводит ссылку на страницу с названием 'Некоторая страница' wiki
|
Chris@1464
|
76 проекта Sandbox
|
Chris@1464
|
77 </li>
|
Chris@1464
|
78 <li><strong>[[sandbox:]]</strong> выводит ссылку на главную страницу wiki проекта Sandbox</li>
|
Chris@1464
|
79 </ul>
|
Chris@1464
|
80
|
Chris@1464
|
81 <p>Ссылки на wiki окрашены в красный, если страница ещё не создана, пример: <a href="#" class="wiki-page new">Несуществующая
|
Chris@1464
|
82 страница</a>.</p>
|
Chris@1464
|
83
|
Chris@1464
|
84 <p>ССылки на другие ресурсы:</p>
|
Chris@1464
|
85
|
Chris@1464
|
86 <ul>
|
Chris@1464
|
87 <li>Документы:
|
Chris@1464
|
88 <ul>
|
Chris@1464
|
89 <li><strong>document#17</strong> (ссылка на документ с id 17)</li>
|
Chris@1464
|
90 <li><strong>document:Приветствие</strong> (ссылка на документ с названием "Приветствие")</li>
|
Chris@1464
|
91 <li><strong>document:"Некоторый документ"</strong> (двойные кавычки использоются в случае, когда название
|
Chris@1464
|
92 документа содержит пробелы)
|
Chris@1464
|
93 </li>
|
Chris@1464
|
94 <li><strong>sandbox:document:"Приветствие"</strong> (ссылка на документ с названием "Приветствие" в проекте
|
Chris@1464
|
95 "sandbox")
|
Chris@1464
|
96 </li>
|
Chris@1464
|
97 </ul></li>
|
Chris@1464
|
98 </ul>
|
Chris@1464
|
99
|
Chris@1464
|
100 <ul>
|
Chris@1464
|
101 <li>Этапы:
|
Chris@1464
|
102 <ul>
|
Chris@1464
|
103 <li><strong>version#3</strong> (ссылка на этап с id 3)</li>
|
Chris@1464
|
104 <li><strong>version:1.0.0</strong> (ссылка на этап с названием "1.0.0")</li>
|
Chris@1464
|
105 <li><strong>version:"1.0 beta 2"</strong> (двойные кавычки использоются в случае, когда название
|
Chris@1464
|
106 этапа содержит пробелы)
|
Chris@1464
|
107 </li>
|
Chris@1464
|
108 <li><strong>sandbox:version:1.0.0</strong> (ссылка на этап "1.0.0" проекта "sandbox")</li>
|
Chris@1464
|
109 </ul></li>
|
Chris@1464
|
110 </ul>
|
Chris@1464
|
111
|
Chris@1464
|
112 <ul>
|
Chris@1464
|
113 <li>Вложения:
|
Chris@1464
|
114 <ul>
|
Chris@1464
|
115 <li><strong>attachment:file.zip</strong> (ссылка на вложение текущего объекта с именем file.zip)</li>
|
Chris@1464
|
116 <li>Сейчас можно ссылаться только на вложения текущего объекта (если вы просматриваете задачу, то возможно
|
Chris@1464
|
117 ссылаться только на вложения этой задачи)
|
Chris@1464
|
118 </li>
|
Chris@1464
|
119 </ul></li>
|
Chris@1464
|
120 </ul>
|
Chris@1464
|
121
|
Chris@1464
|
122 <ul>
|
Chris@1464
|
123 <li>Changesets:
|
Chris@1464
|
124 <ul>
|
Chris@1464
|
125 <li><strong>r758</strong> (link to a changeset)</li>
|
Chris@1464
|
126 <li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
|
Chris@1464
|
127 <li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
|
Chris@1464
|
128 <li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
|
Chris@1464
|
129 <li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
|
Chris@1464
|
130 <li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
|
Chris@1464
|
131 </ul></li>
|
Chris@1464
|
132 </ul>
|
Chris@1464
|
133
|
Chris@1464
|
134 <ul>
|
Chris@1464
|
135 <li>Файлы хранилища:
|
Chris@1464
|
136 <ul>
|
Chris@1464
|
137 <li><strong>source:some/file</strong> (ссылка на файл /some/file, расположенный в хранилище проекта)
|
Chris@1464
|
138 </li>
|
Chris@1464
|
139 <li><strong>source:some/file@52</strong> (ссылка на 52 ревизию файла)</li>
|
Chris@1464
|
140 <li><strong>source:some/file#L120</strong> (ссылка на 120 строку файла)</li>
|
Chris@1464
|
141 <li><strong>source:some/file@52#L120</strong> (ссылка на 120 строку в 52 ревизии файла)</li>
|
Chris@1464
|
142 <li><strong>source:"some file@52#L120"</strong> (используйте use double quotes when the URL contains spaces</li>
|
Chris@1464
|
143 <li><strong>export:some/file</strong> (ссылка на загрузку файла)</li>
|
Chris@1464
|
144 <li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
|
Chris@1464
|
145 <li><strong>sandbox:source:some/file</strong> (ссылка на файл /some/file, расположенный в хранилище проекта
|
Chris@1464
|
146 "sandbox")
|
Chris@1464
|
147 </li>
|
Chris@1464
|
148 <li><strong>sandbox:export:some/file</strong> (ссылка на загрузку файла)</li>
|
Chris@1464
|
149 </ul></li>
|
Chris@1464
|
150 </ul>
|
Chris@1464
|
151
|
Chris@1464
|
152 <ul>
|
Chris@1464
|
153 <li>Сообщения форума:
|
Chris@1464
|
154 <ul>
|
Chris@1464
|
155 <li><strong>message#1218</strong> (ссылка на сообщение с id 1218)</li>
|
Chris@1464
|
156 </ul></li>
|
Chris@1464
|
157 </ul>
|
Chris@1464
|
158
|
Chris@1464
|
159 <ul>
|
Chris@1464
|
160 <li>Проекты:
|
Chris@1464
|
161 <ul>
|
Chris@1464
|
162 <li><strong>project#3</strong> (ссылка на проект с id 3)</li>
|
Chris@1464
|
163 <li><strong>project:someproject</strong> (ссылка на проект "someproject")</li>
|
Chris@1464
|
164 </ul></li>
|
Chris@1464
|
165 </ul>
|
Chris@1464
|
166
|
Chris@1464
|
167
|
Chris@1464
|
168 <p>Исключения:</p>
|
Chris@1464
|
169
|
Chris@1464
|
170 <ul>
|
Chris@1464
|
171 <li>Вы можете отменить обработку ссылок с помощью восклицательного знака перед ссылкой: !http://foo.bar</li>
|
Chris@1464
|
172 </ul>
|
Chris@1464
|
173
|
Chris@1464
|
174 <h3><a name="4" class="wiki-page"></a>Внешние ссылки</h3>
|
Chris@1464
|
175
|
Chris@1464
|
176 <p>HTTP и почтовые адреса автоматически транслируются в ссылки:</p>
|
Chris@1464
|
177
|
Chris@1464
|
178 <pre>
|
Chris@1464
|
179 http://www.redmine.org, someone@foo.bar
|
Chris@1464
|
180 </pre>
|
Chris@1464
|
181
|
Chris@1464
|
182 <p>выводится: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a
|
Chris@1464
|
183 href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
|
Chris@1464
|
184
|
Chris@1464
|
185 <p>Если же вы хотите, чтобы отобразился текст вместо адреса URL, вы можете испольовать стандартный синтаксис
|
Chris@1464
|
186 форматирования текста:</p>
|
Chris@1464
|
187
|
Chris@1464
|
188 <pre>
|
Chris@1464
|
189 "Сайт Redmine":http://www.redmine.org
|
Chris@1464
|
190 </pre>
|
Chris@1464
|
191
|
Chris@1464
|
192 <p>выводится: <a href="http://www.redmine.org" class="external">Сайт Redmine</a></p>
|
Chris@1464
|
193
|
Chris@1464
|
194
|
Chris@1464
|
195 <h2><a name="5" class="wiki-page"></a>Форматирование текста</h2>
|
Chris@1464
|
196
|
Chris@1464
|
197 <p>Для таких вещей, как заголовки, выделение, таблицы и списки, Redmine поддерживает синтакс Textile. Обратитесь за
|
Chris@1464
|
198 руководством к странице <a class="external"
|
Chris@1464
|
199 href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a>
|
Chris@1464
|
200 . Несколько примеров приведены ниже, Но сам текстовый процессор способен на гораздо большее.</p>
|
Chris@1464
|
201
|
Chris@1464
|
202 <h3><a name="6" class="wiki-page"></a>Стиль шрифта</h3>
|
Chris@1464
|
203
|
Chris@1464
|
204 <pre>
|
Chris@1464
|
205 * *выделенный*
|
Chris@1464
|
206 * _наклонный_
|
Chris@1464
|
207 * _*выделенный наклонный*_
|
Chris@1464
|
208 * +подчёркнутый+
|
Chris@1464
|
209 * -зачёркнутый-
|
Chris@1464
|
210 </pre>
|
Chris@1464
|
211
|
Chris@1464
|
212 <p>Выводится:</p>
|
Chris@1464
|
213
|
Chris@1464
|
214 <ul>
|
Chris@1464
|
215 <li><strong>выделенный</strong></li>
|
Chris@1464
|
216 <li><em>наклонный</em></li>
|
Chris@1464
|
217 <li><em><strong>выделенный наклонный</strong></em></li>
|
Chris@1464
|
218 <li><ins>подчёркнутый</ins></li>
|
Chris@1464
|
219 <li><del>зачёркнутый</del></li>
|
Chris@1464
|
220 </ul>
|
Chris@1464
|
221
|
Chris@1464
|
222 <h3><a name="7" class="wiki-page"></a>Вставка изображений</h3>
|
Chris@1464
|
223
|
Chris@1464
|
224 <ul>
|
Chris@1464
|
225 <li><strong>!url_изображения!</strong> выводит изображение, расположенное по адресу url_изображения (синтакс textile)</li>
|
Chris@1464
|
226 <li><strong>!>url_изображения!</strong> выводит изображение, выровненное по правому краю</li>
|
Chris@1464
|
227 <li>Прикреплённое к wiki-странице изображение можно отобразить в тексте, используя имя файла:
|
Chris@1464
|
228 <strong>!вложенное_изображение.png!</strong>
|
Chris@1464
|
229 </li>
|
Chris@1464
|
230 </ul>
|
Chris@1464
|
231
|
Chris@1464
|
232 <h3><a name="8" class="wiki-page"></a>Заголовки</h3>
|
Chris@1464
|
233
|
Chris@1464
|
234 <pre>
|
Chris@1464
|
235 h1. Заголовок
|
Chris@1464
|
236 h2. Подзаголовок
|
Chris@1464
|
237 h3. Подзаголовок подзаголовка
|
Chris@1464
|
238 </pre>
|
Chris@1464
|
239
|
Chris@1464
|
240 <p>Redmine присваивает якорь каждому заголовку, поэтому вы можете легко сослаться на любой, указав в тексте "#Заголовок",
|
Chris@1464
|
241 "#Подзаголовок" и т.д.</p>
|
Chris@1464
|
242
|
Chris@1464
|
243
|
Chris@1464
|
244 <h3><a name="9" class="wiki-page"></a>Параграфы</h3>
|
Chris@1464
|
245
|
Chris@1464
|
246 <pre>
|
Chris@1464
|
247 p>. выровненный по правому краю
|
Chris@1464
|
248 p=. выровненный по центру
|
Chris@1464
|
249 </pre>
|
Chris@1464
|
250
|
Chris@1464
|
251 <p style="text-align:center;">Это - выровненный по центру параграф.</p>
|
Chris@1464
|
252
|
Chris@1464
|
253
|
Chris@1464
|
254 <h3><a name="10" class="wiki-page"></a>Цитаты</h3>
|
Chris@1464
|
255
|
Chris@1464
|
256 <p>Начните параграф с <strong>bq.</strong></p>
|
Chris@1464
|
257
|
Chris@1464
|
258 <pre>
|
Chris@1464
|
259 bq. Rails - это полноценный, многоуровневый фреймворк для построения веб-приложений, использующих базы данных,
|
Chris@1464
|
260 который основан на архитектуре Модель-Представление-Контроллер (Model-View-Controller, MVC).
|
Chris@1464
|
261 </pre>
|
Chris@1464
|
262
|
Chris@1464
|
263 <p>Выводится:</p>
|
Chris@1464
|
264
|
Chris@1464
|
265 <blockquote>
|
Chris@1464
|
266 <p>Rails - это полноценный, многоуровневый фреймворк для построения веб-приложений, использующих базы данных,
|
Chris@1464
|
267 который основан на архитектуре Модель-Представление-Контроллер (Model-View-Controller, MVC).</p>
|
Chris@1464
|
268 </blockquote>
|
Chris@1464
|
269
|
Chris@1464
|
270
|
Chris@1464
|
271 <h3><a name="11" class="wiki-page"></a>Содержание</h3>
|
Chris@1464
|
272
|
Chris@1464
|
273 <pre>
|
Chris@1464
|
274 {{Содержание}} => содержание, выровненное по левому краю
|
Chris@1464
|
275 {{>Содержание}} => содержание, выровненное по правому краю
|
Chris@1464
|
276 </pre>
|
Chris@1464
|
277
|
Chris@1464
|
278 <h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
|
Chris@1464
|
279
|
Chris@1464
|
280 <pre>
|
Chris@1464
|
281 ---
|
Chris@1464
|
282 </pre>
|
Chris@1464
|
283
|
Chris@1464
|
284 <h2><a name="12" class="wiki-page"></a>Макросы</h2>
|
Chris@1464
|
285
|
Chris@1464
|
286 <p>В Redmine существуют следующие встроенные макросы:</p>
|
Chris@1464
|
287
|
Chris@1464
|
288 <p>
|
Chris@1464
|
289 <dl>
|
Chris@1464
|
290 <dt><code>hello_world</code></dt>
|
Chris@1464
|
291 <dd><p>Некоторый макрос.</p></dd>
|
Chris@1464
|
292 <dt><code>include</code></dt>
|
Chris@1464
|
293 <dd><p>Вставить wiki страницу. Пример:</p>
|
Chris@1464
|
294
|
Chris@1464
|
295 <pre><code>{{include(Foo)}}</code></pre>
|
Chris@1464
|
296 </dd>
|
Chris@1464
|
297 <dt><code>macro_list</code></dt>
|
Chris@1464
|
298 <dd><p>Выводит список доступных макросов с описаниями, если они имеются.</p></dd>
|
Chris@1464
|
299 </dl>
|
Chris@1464
|
300 </p>
|
Chris@1464
|
301
|
Chris@1464
|
302
|
Chris@1464
|
303 <h2><a name="13" class="wiki-page"></a>Подсветка кода</h2>
|
Chris@1464
|
304
|
Chris@1464
|
305 <p>Default code highlightment relies on <a href="http://coderay.rubychan.de/" class="external">CodeRay</a>, a fast syntax highlighting library written completely in Ruby. It currently supports c, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml and yaml languages.</p>
|
Chris@1464
|
306
|
Chris@1464
|
307 <p>Вы можете включить подсветку кода используя данный синтаксис:</p>
|
Chris@1464
|
308
|
Chris@1464
|
309 <pre>
|
Chris@1464
|
310 <pre><code class="ruby">
|
Chris@1464
|
311 Поместите свой код сюда.
|
Chris@1464
|
312 </code></pre>
|
Chris@1464
|
313 </pre>
|
Chris@1464
|
314
|
Chris@1464
|
315 <p>Пример:</p>
|
Chris@1464
|
316
|
Chris@1464
|
317 <pre><code class="ruby syntaxhl"><span class="line-numbers"> 1</span> <span class="comment"># The Greeter class</span>
|
Chris@1464
|
318 <span class="line-numbers"> 2</span> <span class="reserved">class</span> <span class="class">Greeter</span>
|
Chris@1464
|
319 <span class="line-numbers"> 3</span> <span class="reserved">def</span> <span class="function">initialize</span>(name)
|
Chris@1464
|
320 <span class="line-numbers"> 4</span> <span class="instance-variable">@name</span> = name.capitalize
|
Chris@1464
|
321 <span class="line-numbers"> 5</span> <span class="reserved">end</span>
|
Chris@1464
|
322 <span class="line-numbers"> 6</span>
|
Chris@1464
|
323 <span class="line-numbers"> 7</span> <span class="reserved">def</span> <span class="function">salute</span>
|
Chris@1464
|
324 <span class="line-numbers"> 8</span> puts <span class="string"><span class="delimiter">"</span><span class="content">Hello </span><span class="inline"><span class="inline-delimiter">#{</span><span class="instance-variable">@name</span><span class="inline-delimiter">}</span></span><span class="content">!</span><span class="delimiter">"</span></span>
|
Chris@1464
|
325 <span class="line-numbers"> 9</span> <span class="reserved">end</span>
|
Chris@1464
|
326 <span class="line-numbers"><strong>10</strong></span> <span class="reserved">end</span></code>
|
Chris@1464
|
327 </pre>
|
Chris@1464
|
328 </body>
|
Chris@1464
|
329 </html>
|