|
1
|
h1. Wiki синтаксис, подробно описание
|
|
2
|
|
|
3
|
{{>TOC}}
|
|
4
|
|
|
5
|
h1. Връзки
|
|
6
|
|
|
7
|
h2. Вътрешни връзки в Redmine
|
|
8
|
|
|
9
|
*Redmine* позволява създаване на връзки между задачите, ревизиите и Wiki страниците отвсякъде където се прилага Wiki форматиране.
|
|
10
|
|
|
11
|
* Връзка към задача: *!#124* (показва #124, връзката е задраскана, ако задачата е затворена)
|
|
12
|
* Връзка към ревизия : *!r758* (показва r758)
|
|
13
|
* Връзка към ревизия с нецифров код: *commit:c6f4d0fd* (показва c6f4d0fd).
|
|
14
|
|
|
15
|
Wiki връзки:
|
|
16
|
|
|
17
|
* *[[Задачи]]* показва връзка към страница с име 'Задачи': [[Задачи]]
|
|
18
|
* *[[Задачи|Работа със задачи]]* показва връзка към същата страница, но друг текст на връзката: [[Задачи|Работа със задачи]]
|
|
19
|
* *[[Guide#User-guide|Работа със задачи]]* показва връзка към заглавие на глава в страница, но друг текст на връзката: [[Задачи#Задачи|Работа със задачи]]
|
|
20
|
|
|
21
|
Възможни са връзки към страниците от Wiki на друг проект:
|
|
22
|
|
|
23
|
* *[[sandbox:Някаква страница]]* показва връзка към страница, наречена 'Някаква страница' от Wiki на проект Sandbox
|
|
24
|
* *[[sandbox:]]* показва връзка към главната страница на Wiki на Sandbox
|
|
25
|
|
|
26
|
Wiki връзките се показват в червен цвят, ако съответната страница не съществува все още, например: [[Несъществуваща страница]].
|
|
27
|
|
|
28
|
Връзки към други ресурси:
|
|
29
|
|
|
30
|
* Документи:
|
|
31
|
|
|
32
|
* *!document#17* (връзка към документ с идентификатор id 17)
|
|
33
|
* *!document:Greetings* (връзка към документ със заглавие "Greetings")
|
|
34
|
* *!document:"Some document"* (" " могат да се ползват, ако заглавието на документа съдържа интервали)
|
|
35
|
* *!document:some_project:"Some document"* (връзка към документ в друг проект)
|
|
36
|
|
|
37
|
* Версии:
|
|
38
|
|
|
39
|
* *!version#3* (връзка към версия с идентификатор id 3)
|
|
40
|
* *!version:1.0.0* (връзка към версия, наименувана "1.0.0")
|
|
41
|
* *!version:"1.0 beta 2"*
|
|
42
|
|
|
43
|
* Проекти:
|
|
44
|
|
|
45
|
* *project#<id>* (връзка към проект с идентификатор <id>)
|
|
46
|
* *!project:<identifier>*
|
|
47
|
* *!project:<name>*
|
|
48
|
|
|
49
|
* Прикачени файлове:
|
|
50
|
|
|
51
|
* *!attachment:file.zip* (връзка към прикачен файл от текущия обект, наименуван file.zip)
|
|
52
|
* За сега, могат да се правят връзки към прикачени файлове, асоциирани към текущия обект (ако редактирате задача, възможно е да се правите връзки към файлове, прикачени само към тази задача).
|
|
53
|
|
|
54
|
* Файлове в хранилищата
|
|
55
|
|
|
56
|
* *!source:some/file* -- Връзка към файл, който се намира на /some/file в проектното хранилище
|
|
57
|
* *!source:some/file@52* -- Връзка към файл от ревизия 52
|
|
58
|
* *!source:some/file#L120* -- Връзка към 120-ти ред на файла
|
|
59
|
* *!source:some/file@52#L120* -- Връзка към 120-ти ред на файла от ревизия 52
|
|
60
|
* *!source:"some file@52#L120"* -- " " могат да се ползват, когато пътят до файла съдържа интервали
|
|
61
|
* *!export:some/file* -- изисква задължително изтегляне (download) на файла
|
|
62
|
* *!source:repo|some/file* -- Връзка към файл, който се намира на /some/file в проектното хранилище с идентификатор repo
|
|
63
|
* *!sandbox:source:repo|some/file* -- връзка към файл, който се намира на /some/file в проектното хранилище с идентификатор repo на проект sandbox
|
|
64
|
* *!sandbox:export:some/file* -- изисква задължително изтегляне (download) на файла от /some/file в главното хранилище на проект sandbox
|
|
65
|
|
|
66
|
* Форуми
|
|
67
|
|
|
68
|
* *!forum#2* -- (връзка към форум с идентификатор 2)
|
|
69
|
* *!forum:Discussion* -- (връзка към форум с име "Discussion")
|
|
70
|
* *!forum:"Help and more"* -- (кавички се използват при име, съдържащо интервали)
|
|
71
|
|
|
72
|
* Съобщения във форумите
|
|
73
|
|
|
74
|
* *!message#1218* -- (връзка към съобщение с идентификатор 1218)
|
|
75
|
|
|
76
|
* News items
|
|
77
|
|
|
78
|
* *!news#1* (връзка към новина с идентификатор 1)
|
|
79
|
* *!news:Greetings* (връзка към новина с име "Greetings")
|
|
80
|
* *!news:"eCookbook first release !"* (кавички се използват при име, съдържащо интервали)
|
|
81
|
|
|
82
|
Забрана на връзка:
|
|
83
|
|
|
84
|
* Възможно е кодовете на връзките да не се преобразуват в действителни връзки като се сложи пред тях удивителен знак: !
|
|
85
|
|
|
86
|
h2. Външни връзки
|
|
87
|
|
|
88
|
HTTP URL и е-мейл адресите автоматично се превръщат във връзки:
|
|
89
|
* *http://projects.okto7.com* -- Външна връзка към сайта http://projects.okto7.com
|
|
90
|
* *someone@foo.bar* -- Връзка към е-мейл адрес: someone@foo.bar
|
|
91
|
|
|
92
|
HTTP URL и е-мейл адресите могат да ползват друг текст вместо тях самите:
|
|
93
|
* *"Проекти в ОКТО-7":http://projects.okto7.com* -- Външна връзка с различен текст: "Проекти в ОКТО-7":http://projects.okto7.com
|
|
94
|
* *"Е-мейл на администратора":mailto:vcs@okto7.com* -- Е-мейл с различен текст: "Е-мейл на администратора":mailto:vcs@okto7.com
|
|
95
|
|
|
96
|
Могат да бъдат направени и по-сложни е-мейл връзки. Подразбираща се тема (заглавие на е-мейл съобщението), подразбиращо се съдържание и CC информация (Копие до:) могат да бъдат дефинирани. Интервалите във всяко от тези полета трябва да се замени с код %20.
|
|
97
|
* *"Изпратете е-мейл на WEB програмиста и администратора":mailto:webmaster@foo.bar?cc=admin@foo.bar* -- Изпратете е-мейл на WEB програмиста и администратора: "Изпратете е-мейл на WEB програмиста и администратора":mailto:webmaster@foo.bar?cc=admin@foo.bar
|
|
98
|
* *"Email someone for help":mailto:someone@foo.bar?subject=Website%20Help* -- Email link with the subject "Website Help": "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help
|
|
99
|
* *"Email someone for help":mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20* -- Email link with the subject "Website Help" and a default body: "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20
|
|
100
|
|
|
101
|
h2. Форматиране на текст
|
|
102
|
|
|
103
|
За неща като заглавия, курсив, таблици, списъци, Redmine поддържа Textile синтаксис. Виж http://www.textism.com/tools/textile/ за информация по използването на тези възможности. Няколко примера са показано по-долу, но са възмони много повече неща от това.
|
|
104
|
|
|
105
|
h3. Акроним
|
|
106
|
|
|
107
|
<pre>
|
|
108
|
IMC(Ivan Milkov Cenov)
|
|
109
|
</pre>
|
|
110
|
|
|
111
|
Display:
|
|
112
|
|
|
113
|
IMC(Ivan Milkov Cenov)
|
|
114
|
|
|
115
|
h3. Стил на шрифтовете
|
|
116
|
|
|
117
|
<pre><code>* *bold*
|
|
118
|
* _italic_
|
|
119
|
* *_bold italic_*
|
|
120
|
* +underline+
|
|
121
|
* -strike-through-
|
|
122
|
* Plain ^superscript^
|
|
123
|
* Plain ~subscript~
|
|
124
|
* @inline monospace@
|
|
125
|
</code></pre>
|
|
126
|
|
|
127
|
Показва:
|
|
128
|
|
|
129
|
* *bold*
|
|
130
|
* _italic_
|
|
131
|
* *_bold italic_*
|
|
132
|
* +underline+
|
|
133
|
* -strike-through-
|
|
134
|
* Plain ^superscript^
|
|
135
|
* Plain ~subscript~
|
|
136
|
* @inline monospace@
|
|
137
|
|
|
138
|
h3. Изображения в текста
|
|
139
|
|
|
140
|
* *!image_url!* показва изображение, намиращо се на адрес image_url (textile синтаксис)
|
|
141
|
* *!>image_url!* изображение, разположено отдясно на текста
|
|
142
|
|
|
143
|
Изображения, закачени към Wiki страницата, могат да се показват в нея чрез нейното име: *!attached_image.png!*
|
|
144
|
|
|
145
|
h3. Заглавия
|
|
146
|
|
|
147
|
<pre><code>h1. Заглавие
|
|
148
|
h2. Подзаглавие
|
|
149
|
h3. Подзаглавие
|
|
150
|
</code></pre>
|
|
151
|
|
|
152
|
h3. Параграфи
|
|
153
|
|
|
154
|
<pre><code>p. изравнен отляво
|
|
155
|
|
|
156
|
p(. изравнен отляво 1em
|
|
157
|
|
|
158
|
p((. изравнен отляво 2em
|
|
159
|
както и следващата линия
|
|
160
|
|
|
161
|
p>. изравнен отдясно
|
|
162
|
|
|
163
|
p)))>. изравнен отдясно 3em
|
|
164
|
|
|
165
|
p=. Центриран параграф.
|
|
166
|
</code></pre>
|
|
167
|
|
|
168
|
h3. Предефинирани параграфи
|
|
169
|
|
|
170
|
Забрана на Wiki синтаксиса
|
|
171
|
<pre> <pre> *Вашият текст няма да бъде почернен* </pre> </pre>
|
|
172
|
Показва:
|
|
173
|
|
|
174
|
<pre> *Вашият текст няма да бъде почернен* </pre>
|
|
175
|
|
|
176
|
h3. Текстови блокове (Blockquotes)
|
|
177
|
|
|
178
|
Параграфът се стартира с *bq.* или > (а може и двойно: >>)
|
|
179
|
|
|
180
|
<pre><code>bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
|
181
|
To go live, all you need to add is a database and a web server.
|
|
182
|
</code></pre>
|
|
183
|
|
|
184
|
Показва:
|
|
185
|
|
|
186
|
bq. Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern.
|
|
187
|
To go live, all you need to add is a database and a web server.
|
|
188
|
|
|
189
|
>> Rails is a full-stack framework for developing database-backed web applications according to the Model-View-Control pattern. To go live, all you need to add is a database and a web server. (starting with >>)
|
|
190
|
|
|
191
|
h3. Неподредени списъци
|
|
192
|
|
|
193
|
<pre>
|
|
194
|
* Item 1
|
|
195
|
* Item 2
|
|
196
|
** Item 21
|
|
197
|
** Item 22
|
|
198
|
* Item 3
|
|
199
|
</pre>
|
|
200
|
|
|
201
|
показва:
|
|
202
|
|
|
203
|
* Item 1
|
|
204
|
* Item 2
|
|
205
|
** Item 21
|
|
206
|
** Item 22
|
|
207
|
* Item 3
|
|
208
|
|
|
209
|
h3. Подредени списъци
|
|
210
|
|
|
211
|
<pre>
|
|
212
|
# Item 1
|
|
213
|
# Item 2
|
|
214
|
# Item 3
|
|
215
|
## Item 3.1
|
|
216
|
## Item 3.2
|
|
217
|
</pre>
|
|
218
|
|
|
219
|
показва:
|
|
220
|
|
|
221
|
# Item 1
|
|
222
|
# Item 2
|
|
223
|
# Item 3
|
|
224
|
## Item 3.1
|
|
225
|
## Item 3.2
|
|
226
|
|
|
227
|
h3. Таблици
|
|
228
|
|
|
229
|
<pre>
|
|
230
|
|_.UserID|_.Name|_.Group|_. attribute list |
|
|
231
|
|\3=.IT |<. align left|
|
|
232
|
|1|Artur Pirozhkov |/2.Users |>. align right|
|
|
233
|
|2|Vasya Rogov |=. center |
|
|
234
|
|3|John Smith |Admin
|
|
235
|
(root)|^. valign top |
|
|
236
|
|4|- |Nobody
|
|
237
|
(anonymous)|~. valign bottom|
|
|
238
|
</pre>
|
|
239
|
|
|
240
|
показва (поредиците от интервали са заместени от един интервал):
|
|
241
|
|
|
242
|
|_.UserID|_.Name|_.Group|_. attribute list |
|
|
243
|
|\3=.IT |<. align left|
|
|
244
|
|1|Artur Pirozhkov |/2.Users |>. align right|
|
|
245
|
|2|Vasya Rogov |=. center |
|
|
246
|
|3|John Smith |Admin
|
|
247
|
(root)|^. valign top |
|
|
248
|
|4|- |Nobody
|
|
249
|
(anonymous)|~. valign bottom|
|
|
250
|
|
|
251
|
h3. Таблица на съдържанието (TOC)
|
|
252
|
|
|
253
|
<pre><code>{{toc}} => ляво изравнена toc
|
|
254
|
{{>toc}} => дясно изравнена toc
|
|
255
|
</code></pre>
|
|
256
|
|
|
257
|
h3. Елементи на текста.
|
|
258
|
|
|
259
|
h4. Хоризонтален разделител.
|
|
260
|
|
|
261
|
<pre>
|
|
262
|
част 1
|
|
263
|
|
|
264
|
---
|
|
265
|
|
|
266
|
част 2
|
|
267
|
</pre>
|
|
268
|
генерира хоризонтална черта (трябва да има по един празен ред над и под реда с тиретата). Може да се ползва за разделител между две части на страницата:
|
|
269
|
|
|
270
|
част 1
|
|
271
|
|
|
272
|
---
|
|
273
|
|
|
274
|
част 2
|
|
275
|
|
|
276
|
h2. Макроси
|
|
277
|
|
|
278
|
Redmine има вградени следните макроси:
|
|
279
|
|
|
280
|
{{macro_list}}
|
|
281
|
|
|
282
|
h2. Синтактично оцветяване (Code highlighting)
|
|
283
|
|
|
284
|
Синтактичното оцветяване се основава на "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.
|
|
285
|
|
|
286
|
Синтаксис:
|
|
287
|
|
|
288
|
<pre><code><pre><code class="ruby">
|
|
289
|
Поставете вашия код тук.
|
|
290
|
</code></pre>
|
|
291
|
</code></pre>
|
|
292
|
|
|
293
|
Пример:
|
|
294
|
|
|
295
|
<pre><code class="ruby">
|
|
296
|
# The Greeter class
|
|
297
|
class Greeter
|
|
298
|
def initialize(name)
|
|
299
|
@name = name.capitalize
|
|
300
|
end
|
|
301
|
|
|
302
|
def salute
|
|
303
|
puts "Hello #{@name}!"
|
|
304
|
end
|
|
305
|
end
|
|
306
|
</code></pre>
|
|
307
|
|
|
308
|
|
|
309
|
<pre><code class="C">
|
|
310
|
if ((LEDstate & BTLED2_MASK) != 0u) {
|
|
311
|
if (ShortAsymetricPeriodTimerState(LED) == APT_STATE_HIGH) {
|
|
312
|
BTLED2_On();
|
|
313
|
} else {
|
|
314
|
BTLED2_Off();
|
|
315
|
}
|
|
316
|
} else {
|
|
317
|
BTLED2_Off();
|
|
318
|
}
|
|
319
|
</code></pre>
|
|
320
|
|
|
321
|
h2. Допълнителна информация.
|
|
322
|
|
|
323
|
h3. Textile.
|
|
324
|
|
|
325
|
"Textism":http://www.textism.com/tools/textile/index.php - Textile reference and generator
|
|
326
|
"Textile Reference Manual for RedCloth 4":http://redcloth.org/textile
|
|
327
|
"A Textile Reference":http://redcloth.org/hobix.com/textile/ in RedCloth made by _why
|
|
328
|
"CSS Tutorial":http://www.w3schools.com/css/, "W3Schools.com":http://www.w3schools.com/default.asp
|
|
329
|
|
|
330
|
h3. LaTeX/MathJax.
|
|
331
|
|
|
332
|
"MathJax basic tutorial and quick reference":http://meta.math.stackexchange.com/questions/5020/mathjax-basic-tutorial-and-quick-reference
|
|
333
|
"LaTeX/Mathematics":http://en.wikibooks.org/wiki/LaTeX/Mathematics
|