You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

wiki_syntax_detailed_markdown.html 20KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320
  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>Redmine - форматування вікі сторінок (Markdown)</title>
  5. <meta http-equiv="content-type" content="text/html; charset=utf-8" />
  6. <link rel="stylesheet" type="text/css" href="../wiki_syntax_detailed.css" />
  7. </head>
  8. <body>
  9. <h1><a name="1" class="wiki-page"></a>Форматування вікі сторінок (Markdown)</h1>
  10. <h2><a name="2" class="wiki-page"></a>Лінки(посилання)</h2>
  11. <h3><a name="3" class="wiki-page"></a>Redmine лінки(посилання)</h3>
  12. <p>Redmine дозволяє гіперпосилання між ресурсами (завданнями, змінами, вікі-сторінками ...) з будь-якого місця, де використовується вікі-форматування.</p>
  13. <ul>
  14. <li>Посилання на завдання: <strong>#124</strong> (Відображає <del><a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>, посилання закресленим, якщо завдання закрите)</li>
  15. <li>Link to an issue including tracker name and subject: <strong>##124</strong> (displays <a href="#" class="issue" title="bulk edit doesn't change the category or fixed version properties (New)">Bug #124</a>: bulk edit doesn't change the category or fixed version properties)</li>
  16. <li>Посилання на примітку до завдання: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
  17. <li>Link to an issue note within the same issue: <strong>#note-6</strong></li>
  18. </ul>
  19. <p>Вікі посилання:</p>
  20. <ul>
  21. <li><strong>[[Керівництво користувача]]</strong> відображає посилання на сторінку під назвою 'Керівництво користувача': <a href="#" class="wiki-page">Керівництво користувача</a></li>
  22. <li><strong>[[Guide#further-reading]]</strong> приведе вас до якоря "further-reading". Заголовкам автоматично призначаються якоря так, що Ви можете звернутися до них: <a href="#" class="wiki-page">Guide</a></li>
  23. <li><strong>[[#further-reading]]</strong> link to the anchor "further-reading" of the current page: <a href="#" class="wiki-page">#further-reading</a></li>
  24. <li><strong>[[Guide|User manual]]</strong> відображає посилання на ту ж саму сторінку, але з іншим текстом: <a href="#" class="wiki-page">User manual</a></li>
  25. </ul>
  26. <p>Ви також можете посилатися на сторінки з вікі іншого проекту:</p>
  27. <ul>
  28. <li><strong>[[sandbox:some page]]</strong> відображає посилання на сторінку з назвою 'Some page' з вікі Sandbox</li>
  29. <li><strong>[[sandbox:]]</strong> відображає посилання на головну сторінку вікі Sandbox</li>
  30. </ul>
  31. <p>Вікі посилання відображаються червоним кольором, якщо сторінка ще не існує: <a href="#" class="wiki-page new">Неіснуюча сторінка</a>.</p>
  32. <p>Посилання на інші ресурси:</p>
  33. <ul>
  34. <li>Документи:
  35. <ul>
  36. <li><strong>document#17</strong> (посилання на документ з id 17)</li>
  37. <li><strong>document:Привітання</strong> (посилання на документ з заголовком "Привітання")</li>
  38. <li><strong>document:"Деякий документ"</strong> (подвійні лапки можна використовувати, якщо заголовок документа містить пропуски)</li>
  39. <li><strong>sandbox:document:"Деякий документ"</strong> (посилання на документ з заголовком "Деякий документ" з іншого проекту "sandbox")</li>
  40. </ul>
  41. </li>
  42. </ul>
  43. <ul>
  44. <li>Версії:
  45. <ul>
  46. <li><strong>version#3</strong> (посилання на версію з id 3)</li>
  47. <li><strong>version:1.0.0</strong> (посилання на версію з назвою "1.0.0")</li>
  48. <li><strong>version:"1.0 beta 2"</strong></li>
  49. <li><strong>sandbox:version:1.0.0</strong> (посилання на версію "1.0.0" з проекту "sandbox")</li>
  50. </ul>
  51. </li>
  52. </ul>
  53. <ul>
  54. <li>Вкладенні файли:
  55. <ul>
  56. <li><strong>attachment:file.zip</strong> (посилання на вкладенний файл з ім'ям file.zip)</li>
  57. <li>На даний момент можливо посилатись тільки на вкладення з поточного об'єкту (якщо ви працюєте з завданням, ви можете посилатись тільки на вкладення поточного завдання)</li>
  58. </ul>
  59. </li>
  60. </ul>
  61. <ul>
  62. <li>Зміни:
  63. <ul>
  64. <li><strong>r758</strong> (посилання на зміни)</li>
  65. <li><strong>commit:c6f4d0fd</strong> (посилання на зміни з нечисловим хешем)</li>
  66. <li><strong>svn1|r758</strong> (посилання на зміни вказаного сховища(репозиторія), для проектів з декількома сховищами(репозиторіями))</li>
  67. <li><strong>commit:hg|c6f4d0fd</strong> (посилання на зміни з нечисловим хешем вказаного репозиторія)</li>
  68. <li><strong>sandbox:r758</strong> (посилання на зміни іншого проекту)</li>
  69. <li><strong>sandbox:commit:c6f4d0fd</strong> (посилання на зміни з нечисловим іншого проекту)</li>
  70. </ul>
  71. </li>
  72. </ul>
  73. <ul>
  74. <li>Файли у сховищах(репозиторіях):
  75. <ul>
  76. <li><strong>source:some/file</strong> (посилання на файл за шляхом /some/file у сховищі проекту)</li>
  77. <li><strong>source:some/file@52</strong> (посилання на file з ревізії 52)</li>
  78. <li><strong>source:some/file#L120</strong> (посилання на рядок 120 з file)</li>
  79. <li><strong>source:some/file@52#L120</strong> (посилання на рядок 120 з file ревізії 52)</li>
  80. <li><strong>source:"some file@52#L120"</strong> (використовуте подвійні лапки у випадках, коли URL містить пропуски</li>
  81. <li><strong>export:some/file</strong> (примусове завантаження файлу file)</li>
  82. <li><strong>source:svn1|some/file</strong> (посилання на file вказаного сховища, для проектів в яких використовується декілька сховищь)</li>
  83. <li><strong>sandbox:source:some/file</strong> (посилання на файл за шляхом /some/file з сховища проекту "sandbox")</li>
  84. <li><strong>sandbox:export:some/file</strong> (примусове завантаження файлу file)</li>
  85. </ul>
  86. </li>
  87. </ul>
  88. <ul>
  89. <li>Форуми:
  90. <ul>
  91. <li><strong>forum#1</strong> (посилання на форум з id 1</li>
  92. <li><strong>forum:Support</strong> (посилання на форум з назвою Support)</li>
  93. <li><strong>forum:"Технічна підтримка"</strong> (використовуте подвійні лапки у випадках, коли назва форуму містить пропуски)</li>
  94. </ul>
  95. </li>
  96. </ul>
  97. <ul>
  98. <li>Повідомленя на форумах:
  99. <ul>
  100. <li><strong>message#1218</strong> (посилання на повідомлення з id 1218)</li>
  101. </ul>
  102. </li>
  103. </ul>
  104. <ul>
  105. <li>Проекти:
  106. <ul>
  107. <li><strong>project#3</strong> (посилання на проект з id 3)</li>
  108. <li><strong>project:some-project</strong> (посилання на проект з назвою або ідентифікатором "some-project")</li>
  109. <li><strong>project:"Some Project"</strong> (використовуте подвійні лапки у випадках, коли назва проекту містить пропуски))</li>
  110. </ul>
  111. </li>
  112. </ul>
  113. <ul>
  114. <li>Новини:
  115. <ul>
  116. <li><strong>news#2</strong> (посилання на новину з id 2)</li>
  117. <li><strong>news:Greetings</strong> (посилання на новину з заголовком "Greetings")</li>
  118. <li><strong>news:"First Release"</strong> (використовуте подвійні лапки у випадках, коли назва новини містить пропуски)</li>
  119. </ul>
  120. </li>
  121. </ul>
  122. <ul>
  123. <li>Users:
  124. <ul>
  125. <li><strong>user#2</strong> (link to user with id 2)</li>
  126. <li><strong>user:jsmith</strong> (Link to user with login jsmith)</li>
  127. <li><strong>@jsmith</strong> (Link to user with login jsmith)</li>
  128. </ul>
  129. </li>
  130. </ul>
  131. <p>Запобігання перетворенню(escaping):</p>
  132. <ul>
  133. <li>Ви можете запобігти, щоб Redmine перетворював посилання, поставивши перед посиланням знак оклику: !</li>
  134. </ul>
  135. <h3><a name="4" class="wiki-page"></a>Зовнішні посилання</h3>
  136. <p>URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:</p>
  137. <pre>
  138. http://www.redmine.org, someone@foo.bar
  139. </pre>
  140. <p>відображаються як: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
  141. <p>Якщо ви хочете, відобразити текст замість URL, ви можете використовувати стандартний markdown синтаксис:</p>
  142. <pre>
  143. [Redmine web site](http://www.redmine.org)
  144. </pre>
  145. <p>відображається як: <a href="http://www.redmine.org" class="external">Redmine web site</a></p>
  146. <h2><a name="5" class="wiki-page"></a>Форматування тексту</h2>
  147. <p>Для таких речей як: заголовки, жирний текст, таблиці, списки, Redmine підтримує Markdown синтаксис. Перегляньте <a class="external" href="http://daringfireball.net/projects/markdown/syntax">http://daringfireball.net/projects/markdown/syntax</a> для отримання інформації як цим користуватись. Нижче наводиться декілька прикладів, але можливості Markdown набагато більщі ніж у наведених прикладах.</p>
  148. <h3><a name="6" class="wiki-page"></a>Стиль шрифту</h3>
  149. <pre>
  150. * **Жирний**
  151. * *Курсив*
  152. * ***Жирний курсив***
  153. * ~~Закреслений~~
  154. </pre>
  155. <p>Відображення:</p>
  156. <ul>
  157. <li><strong>Жирний</strong></li>
  158. <li><em>Курсив</em></li>
  159. <li><em><strong>Жирний курсив</strong></em></li>
  160. <li><del>Закреслений</del></li>
  161. </ul>
  162. <h3><a name="7" class="wiki-page"></a>Вбудовані(inline) зображення</h3>
  163. <ul>
  164. <li><strong>![](image_url)</strong> виводить зображення, розташоване за адресою image_url (markdown синтаксис)</li>
  165. <li><strong>![](attached_image)</strong> зображення яке додане до вашої сторінки вікі, може бути відображено, з використанням ім'я файлу</li>
  166. <li>Images in your computer's clipboard can be pasted directly using Ctrl-v or Command-v.</li>
  167. <li>Image files can be dragged onto the text area in order to be uploaded and embedded.</li>
  168. </ul>
  169. <h3><a name="8" class="wiki-page"></a>Заголовоки</h3>
  170. <pre>
  171. # Заголовок
  172. ## Підзаголовок
  173. ### Підзаголовок
  174. </pre>
  175. <p>Redmine призначає якір кожному з цих заголовків, таким чином, ви можете посилатись на них з "#Заголовок", "#Підзаголовок" і так далі.</p>
  176. <h3><a name="10" class="wiki-page"></a>Цитати</h3>
  177. <p>Почніть параграф з <strong>&gt;</strong></p>
  178. <pre>
  179. &gt; Redmine — серверний веб-додаток з відкритим кодом для управління проектами та відстежування помилок. До системи входить календар-планувальник та діаграми Ганта
  180. для візуального представлення ходу робіт за проектом та строків виконання.
  181. </pre>
  182. <p>Відображається:</p>
  183. <blockquote>
  184. <p>Redmine — серверний веб-додаток з відкритим кодом для управління проектами та відстежування помилок. До системи входить календар-планувальник та діаграми Ганта</br> для візуального представлення ходу робіт за проектом та строків виконання.</p>
  185. </blockquote>
  186. <h3><a name="11" class="wiki-page"></a>Таблиці змісту сторінки</h3>
  187. <pre>
  188. {{toc}} =&gt; left aligned toc
  189. {{&gt;toc}} =&gt; right aligned toc
  190. </pre>
  191. <h3><a name="14" class="wiki-page"></a>Горизонтальна лінія</h3>
  192. <pre>
  193. ---
  194. </pre>
  195. <h2><a name="12" class="wiki-page"></a>Макроси</h2>
  196. <p>Redmine має наступні вбудовані макроси:</p>
  197. <p>
  198. <dl>
  199. <dt><code>hello_world</code></dt>
  200. <dd><p>Приклад макросу.</p></dd>
  201. <dt><code>macro_list</code></dt>
  202. <dd><p>Відображає список всіх доступних макросів, в тому числі опис, якщо такий є.</p></dd>
  203. <dt><code>child_pages</code></dt>
  204. <dd><p>Відображає список дочірніх сторінок. Без аргументів, він відображає дочірні сторінки поточної сторінки вікі. Приклад:</p>
  205. <pre><code>{{child_pages}} -- може бути використаний тільки на вікі-сторінці
  206. {{child_pages(depth=2)}} -- відображає тільки 2 рівня вкладень</code></pre></dd>
  207. <dt><code>include</code></dt>
  208. <dd><p>Вставити вікі-сторінку. Приклад:</p>
  209. <pre><code>{{include(Foo)}}</code></pre>
  210. <p>або вставити сторінку з конкретного проекту вікі:</p>
  211. <pre><code>{{include(projectname:Foo)}}</code></pre></dd>
  212. <dt><code>collapse</code></dt>
  213. <dd><p>Втавте блок тексту, який має з'являтись при натисканні на "Детальніше...". Приклад:</p>
  214. <pre><code>{{collapse(Детальніше...)
  215. Це блок тексту прихований по замовчуванню.
  216. Його можливо показати натиснувши на посилання
  217. }}</code></pre></dd>
  218. <dt><code>thumbnail</code></dt>
  219. <dd><p>Відображає інтерактивні мініатюри вкладеного зображення. Приклади:</p>
  220. <pre>{{thumbnail(image.png)}}
  221. {{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
  222. <dt><code>issue</code></dt>
  223. <dd><p>Inserts a link to an issue with flexible text. Examples:</p>
  224. <pre>{{issue(123)}} -- Issue #123: Enhance macro capabilities
  225. {{issue(123, project=true)}} -- Andromeda - Issue #123:Enhance macro capabilities
  226. {{issue(123, tracker=false)}} -- #123: Enhance macro capabilities
  227. {{issue(123, subject=false, project=true)}} -- Andromeda - Issue #123</pre></dd>
  228. </dl>
  229. </p>
  230. <h2><a name="13" class="wiki-page"></a>Підсвітка синтаксису коду</h2>
  231. <p>Default code highlightment relies on <a href="http://rouge.jneen.net/" class="external">Rouge</a>, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as <strong>c</strong>, <strong>cpp</strong> (c++), <strong>csharp</strong> (c#, cs), <strong>css</strong>, <strong>diff</strong> (patch, udiff), <strong>go</strong> (golang), <strong>groovy</strong>, <strong>html</strong>, <strong>java</strong>, <strong>javascript</strong> (js), <strong>kotlin</strong>, <strong>objective_c</strong> (objc), <strong>perl</strong> (pl), <strong>php</strong>, <strong>python</strong> (py), <strong>r</strong>, <strong>ruby</strong> (rb), <strong>sass</strong>, <strong>scala</strong>, <strong>shell</strong> (bash, zsh, ksh, sh), <strong>sql</strong>, <strong>swift</strong>, <strong>xml</strong> and <strong>yaml</strong> (yml) languages, where the names inside parentheses are aliases. Please refer to <a href="https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages" class="external">https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages</a> for the full list of supported languages.</p>
  232. <p>Ви можете виділити підсвіткою код в будь-якому місці, яке підтримує вікі-форматування, використовуючи наступний синтаксис (зверніть увагу, що назва мови або псевдонім не чутливі до регістру):</p>
  233. <pre>
  234. ``` ruby
  235. Place your code here.
  236. ```
  237. </pre>
  238. <p>Приклад:</p>
  239. <pre><code class="ruby syntaxhl"><span class="c1"># The Greeter class</span>
  240. <span class="k">class</span> <span class="nc">Greeter</span>
  241. <span class="k">def</span> <span class="nf">initialize</span><span class="p">(</span><span class="nb">name</span><span class="p">)</span>
  242. <span class="vi">@name</span> <span class="o">=</span> <span class="nb">name</span><span class="p">.</span><span class="nf">capitalize</span>
  243. <span class="k">end</span>
  244. <span class="k">def</span> <span class="nf">salute</span>
  245. <span class="nb">puts</span> <span class="s2">"Hello </span><span class="si">#{</span><span class="vi">@name</span><span class="si">}</span><span class="s2">!"</span>
  246. <span class="k">end</span>
  247. <span class="k">end</span>
  248. </code></pre>
  249. </body>
  250. </html>