wiki_syntax_detailed.html

Denis Savitskiy, 2011-10-20 17:08

Download (15.9 KB)

 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
2
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
3
<head>
4
    <title>Форматирование Wiki Redmine</title>
5
    <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
6
    <style type="text/css">
7
        body {
8
            font: 80% Verdana, Tahoma, Arial, sans-serif;
9
        }
10

11
        h1, h2, h3, h4 {
12
            font-family: Trebuchet MS, Georgia, "Times New Roman", serif;
13
        }
14

15
        pre, code {
16
            font-size: 120%;
17
        }
18

19
        pre code {
20
            font-size: 100%;
21
        }
22

23
        pre {
24
            margin: 1em 1em 1em 1.6em;
25
            padding: 2px;
26
            background-color: #fafafa;
27
            border: 1px solid #dadada;
28
            width: 95%;
29
            overflow-x: auto;
30
        }
31

32
        a.new {
33
            color: #b73535;
34
        }
35

36
        .CodeRay .c {
37
            color: #666;
38
        }
39

40
        .CodeRay .cl {
41
            color: #B06;
42
            font-weight: bold
43
        }
44

45
        .CodeRay .dl {
46
            color: black
47
        }
48

49
        .CodeRay .fu {
50
            color: #06B;
51
            font-weight: bold
52
        }
53

54
        .CodeRay .il {
55
            background: #eee
56
        }
57

58
        .CodeRay .il .idl {
59
            font-weight: bold;
60
            color: #888
61
        }
62

63
        .CodeRay .iv {
64
            color: #33B
65
        }
66

67
        .CodeRay .r {
68
            color: #080;
69
            font-weight: bold
70
        }
71

72
        .CodeRay .s {
73
            background-color: #fff0f0
74
        }
75

76
        .CodeRay .s  .dl {
77
            color: #710
78
        }
79
    </style>
80
</head>
81

    
82
<body>
83
<h1><a name="1" class="wiki-page"></a>Форматирование Wiki</h1>
84

    
85
<h2><a name="2" class="wiki-page"></a>Ссылки</h2>
86

    
87
<h3><a name="3" class="wiki-page"></a>Ссылки Redmine</h3>
88

    
89
<p>Redmine допускает гиперссылки между задачами, изменениями и wiki страницами отовсюду, где используется wiki
90
    форматирование.</p>
91
<ul>
92
    <li>Ссылка на задачу: <strong>#124</strong>
93
        (
94
        <del><a href="#" class="issue"
95
                title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>
96
        - ссылка зачёркнута, если задача закрыта)
97
    </li>
98
    <li>Ссылка на изменение: <strong>r758</strong> (выводится <a href="#" class="changeset"
99
                                                                 title="Search engine now only searches objects the user is allowed to view.">r758</a>)
100
    </li>
101
    <li>Ссылка на изменение с нечисловым хэшем: <strong>commit:c6f4d0fd</strong> (выводится <a href="#"
102
                                                                                               class="changeset">c6f4d0fd</a>).
103
    </li>
104
    <li>Ссылка на изменение в другом проекте: <strong>sandbox:r758</strong> (выводится <a href="#" class="changeset"
105
                                                                                          title="Search engine now only searches objects the user is allowed to view.">sandbox:r758</a>)
106
    </li>
107
    <li>Ссылка на изменение с нечисловым хэшем: <strong>sandbox:c6f4d0fd</strong> (выводится <a href="#"
108
                                                                                                class="changeset">sandbox:c6f4d0fd</a>).
109
    </li>
110
</ul>
111

    
112
<p>Wiki ссылки:</p>
113

    
114
<ul>
115
    <li><strong>[[Руководство]]</strong> выводит ссылку на страницу с названием 'Руководство': <a href="#"
116
                                                                                                  class="wiki-page">Руководство</a>
117
    </li>
118
    <li><strong>[[Руководство#дальнейшее-чтение]]</strong> направляет на метку "дальнейшее-чтение". Заголовкам
119
        автоматически
120
        метки, таким образом, вы можете на них ссылаться: <a href="#" class="wiki-page">Руководство</a></li>
121
    <li><strong>[[Руководство|Руководство пользователя]]</strong> выводит ссылку на саму страницу, но с другим текстом:
122
        <a href="#" class="wiki-page">Руководство пользователя</a>
123
    </li>
124
</ul>
125

    
126
<p>Также вы можете ссылаться на wiki:</p>
127

    
128
<ul>
129
    <li><strong>[[sandbox:Некоторая страница]]</strong> выводит ссылку на страницу с названием 'Некоторая страница' wiki
130
        проекта Sandbox
131
    </li>
132
    <li><strong>[[sandbox:]]</strong> выводит ссылку на главную страницу wiki проекта Sandbox</li>
133
</ul>
134

    
135
<p>Ссылки на wiki окрашены в красный, если страница ещё не создана, пример: <a href="#" class="wiki-page new">Несуществующая
136
    страница</a>.</p>
137

    
138
<p>ССылки на другие ресурсы:</p>
139

    
140
<ul>
141
    <li>Документы:
142
        <ul>
143
            <li><strong>document#17</strong> (ссылка на документ с id 17)</li>
144
            <li><strong>document:Приветствие</strong> (ссылка на документ с названием "Приветствие")</li>
145
            <li><strong>document:"Некоторый документ"</strong> (двойные кавычки использоются в случае, когда название
146
                документа содержит пробелы)
147
            </li>
148
            <li><strong>sandbox:document:"Приветствие"</strong> (ссылка на документ с названием "Приветствие" в проекте
149
                "sandbox")
150
            </li>
151
        </ul>
152
    </li>
153
</ul>
154

    
155
<ul>
156
    <li>Этапы:
157
        <ul>
158
            <li><strong>version#3</strong> (ссылка на этап с id 3)</li>
159
            <li><strong>version:1.0.0</strong> (ссылка на этап с названием "1.0.0")</li>
160
            <li><strong>version:"1.0 beta 2"</strong> (двойные кавычки использоются в случае, когда название
161
                этапа содержит пробелы)
162
            </li>
163
            <li><strong>sandbox:version:1.0.0</strong> (ссылка на этап "1.0.0" проекта "sandbox")</li>
164
        </ul>
165
    </li>
166
</ul>
167

    
168
<ul>
169
    <li>Вложения:
170
        <ul>
171
            <li><strong>attachment:file.zip</strong> (ссылка на вложение текущего объекта с именем file.zip)</li>
172
            <li>Сейчас можно ссылаться только на вложения текущего объекта (если вы просматриваете задачу, то возможно
173
                ссылаться только на вложения этой задачи)
174
            </li>
175
        </ul>
176
    </li>
177
</ul>
178

    
179
<ul>
180
    <li>Файлы хранилища:
181
        <ul>
182
            <li><strong>source:some/file</strong> (ссылка на файл /some/file, расположенный в хранилище проекта)
183
            </li>
184
            <li><strong>source:some/file@52</strong> (ссылка на 52 ревизию файла)</li>
185
            <li><strong>source:some/file#L120</strong> (ссылка на 120 строку файла)</li>
186
            <li><strong>source:some/file@52#L120</strong> (ссылка на 120 строку в 52 ревизии файла)</li>
187
            <li><strong>source:"some file@52#L120"</strong> (используйте use double quotes when the URL contains spaces
188
            </li>
189
            <li><strong>export:some/file</strong> (ссылка на загрузку файла)</li>
190
            <li><strong>sandbox:source:some/file</strong> (ссылка на файл /some/file, расположенный в хранилище проекта
191
                "sandbox")
192
            </li>
193
            <li><strong>sandbox:export:some/file</strong> (ссылка на загрузку файла)</li>
194
        </ul>
195
    </li>
196
</ul>
197

    
198
<ul>
199
    <li>Сообщения форума:
200
        <ul>
201
            <li><strong>message#1218</strong> (ссылка на сообщение с id 1218)</li>
202
        </ul>
203
    </li>
204
</ul>
205

    
206
<ul>
207
    <li>Проекты:
208
        <ul>
209
            <li><strong>project#3</strong> (ссылка на проект с id 3)</li>
210
            <li><strong>project:someproject</strong> (ссылка на проект "someproject")</li>
211
        </ul>
212
    </li>
213
</ul>
214

    
215

    
216
<p>Исключения:</p>
217

    
218
<ul>
219
    <li>Вы можете отменить обработку ссылок с помощью восклицательного знака перед ссылкой: !http://foo.bar</li>
220
</ul>
221

    
222

    
223
<h3><a name="4" class="wiki-page"></a>Внешние ссылки</h3>
224

    
225
<p>HTTP и почтовые адреса автоматически транслируются в ссылки:</p>
226

    
227
<pre>
228
http://www.redmine.org, someone@foo.bar
229
</pre>
230

    
231
<p>выводится: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a
232
        href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
233

    
234
<p>Если же вы хотите, чтобы отобразился текст вместо адреса URL, вы можете испольовать стандартный синтаксис
235
    форматирования текста:</p>
236

    
237
<pre>
238
"Сайт Redmine":http://www.redmine.org
239
</pre>
240

    
241
<p>выводится: <a href="http://www.redmine.org" class="external">Сайт Redmine</a></p>
242

    
243

    
244
<h2><a name="5" class="wiki-page"></a>Форматирование текста</h2>
245

    
246

    
247
<p>Для таких вещей, как заголовки, выделение, таблицы и списки, Redmine поддерживает синтакс Textile. Обратитесь за
248
    руководством к странице <a class="external"
249
                               href="http://www.textism.com/tools/textile/">http://www.textism.com/tools/textile/</a>
250
    . Несколько примеров приведены ниже, Но сам текстовый процессор способен на гораздо большее.</p>
251

    
252
<h3><a name="6" class="wiki-page"></a>Стиль шрифта</h3>
253

    
254
<pre>
255
* *выделенный*
256
* _наклонный_
257
* _*выделенный наклонный*_
258
* +подчёркнутый+
259
* -зачёркнутый-
260
</pre>
261

    
262
<p>Выводится:</p>
263

    
264
<ul>
265
    <li><strong>выделенный</strong></li>
266
    <li><em>наклонный</em></li>
267
    <li><em>*выделенный наклонный*</em></li>
268
    <li>
269
        <ins>подчёркнутый</ins>
270
    </li>
271
    <li>
272
        <del>зачёркнутый</del>
273
    </li>
274
</ul>
275

    
276
<h3><a name="7" class="wiki-page"></a>Вставка изображений</h3>
277

    
278
<ul>
279
    <li><strong>!url_изображения!</strong> выводит изображение, расположенное по адресу url_изображения (синтакс textile)</li>
280
    <li><strong>!>url_изображения!</strong> выводит изображение, выровненное по правому краю</li>
281
    <li>Прикреплённое к wiki-странице изображение можно отобразить в тексте, используя имя файла:
282
        <strong>!вложенное_изображение.png!</strong>
283
    </li>
284
</ul>
285

    
286
<h3><a name="8" class="wiki-page"></a>Заголовки</h3>
287

    
288
<pre>
289
h1. Заголовок
290
h2. Подзаголовок
291
h3. Подзаголовок подзаголовка
292
</pre>
293

    
294
<p>Redmine присваивает якорь каждому заголовку, поэтому вы можете легко сослаться на любой, указав в тексте "#Заголовок",
295
    "#Подзаголовок" и т.д.</p>
296

    
297

    
298
<h3><a name="9" class="wiki-page"></a>Параграфы</h3>
299

    
300
<pre>
301
p>. выровненный по правому краю
302
p=. выровненный по центру
303
</pre>
304

    
305
<p style="text-align:center;">Это - выровненный по центру параграф.</p>
306

    
307

    
308
<h3><a name="10" class="wiki-page"></a>Цитаты</h3>
309

    
310
<p>Начните параграф с <strong>bq.</strong></p>
311

    
312
<pre>
313
bq. Rails - это полноценный, многоуровневый фреймворк для построения веб-приложений, использующих базы данных,
314
    который основан на архитектуре Модель-Представление-Контроллер (Model-View-Controller, MVC).
315
</pre>
316

    
317
<p>Выводится:</p>
318

    
319
<blockquote>
320
    <p>Rails - это полноценный, многоуровневый фреймворк для построения веб-приложений, использующих базы данных,
321
    который основан на архитектуре Модель-Представление-Контроллер (Model-View-Controller, MVC).</p>
322
</blockquote>
323

    
324

    
325
<h3><a name="11" class="wiki-page"></a>Содержание</h3>
326

    
327
<pre>
328
{{Содержание}} => содержание, выровненное по левому краю
329
{{>Содержание}} => содержание, выровненное по правому краю
330
</pre>
331

    
332
<h2><a name="12" class="wiki-page"></a>Макросы</h2>
333

    
334
<p>В Redmine существуют следующие встроенные макросы:</p>
335

    
336
<p>
337
<dl>
338
    <dt><code>hello_world</code></dt>
339
    <dd><p>Некоторый макрос.</p></dd>
340
    <dt><code>include</code></dt>
341
    <dd><p>Вставить wiki страницу. Пример:</p>
342

    
343
        <pre><code>{{include(Foo)}}</code></pre>
344
    </dd>
345
    <dt><code>macro_list</code></dt>
346
    <dd><p>Выводит список доступных макросов с описаниями, если они имеются.</p></dd>
347
</dl>
348
</p>
349

    
350

    
351
<h2><a name="13" class="wiki-page"></a>Подсветка кода</h2>
352

    
353
<p>Подсветка кода основана на <a href="http://coderay.rubychan.de/" class="external">CodeRay</a>, библиотеке
354
    быстрой подсветки синтаксиса, которая полностью написана на Ruby. В данный момент она поддерживает языки:
355
    c, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml и yaml.</p>
356

    
357
<p>Вы можете включить подсветку кода используя данный синтаксис:</p>
358

    
359
<pre>
360
&lt;pre&gt;&lt;code class="ruby"&gt;
361
  Поместите свой код сюда.
362
&lt;/code&gt;&lt;/pre&gt;
363
</pre>
364

    
365
<p>Пример:</p>
366

    
367
<pre><code class="ruby CodeRay"><span class="no"> 1</span> <span class="c"># The Greeter class</span>
368
    <span class="no"> 2</span> <span class="r">class</span> <span class="cl">Greeter</span>
369
    <span class="no"> 3</span> <span class="r">def</span> <span class="fu">initialize</span>(name)
370
    <span class="no"> 4</span> <span class="iv">@name</span> = name.capitalize
371
    <span class="no"> 5</span> <span class="r">end</span>
372
    <span class="no"> 6</span>
373
    <span class="no"> 7</span> <span class="r">def</span> <span class="fu">salute</span>
374
    <span class="no"> 8</span> puts <span class="s"><span class="dl">"</span><span class="k">Hello </span><span
375
            class="il"><span class="idl">#{</span><span class="iv">@name</span><span class="idl">}</span></span><span
376
            class="k">!</span><span class="dl">"</span></span>
377
    <span class="no"> 9</span> <span class="r">end</span>
378
    <span class="no"><strong>10</strong></span> <span class="r">end</span>
379
</code>
380
</pre>
381
</body>
382
</html>