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_textile.html 18KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366
  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 { font:80% Verdana,Tahoma,Arial,sans-serif; }
  8. h1, h2, h3, h4 { font-family: Trebuchet MS,Georgia,"Times New Roman",serif; }
  9. pre, code { font-size:120%; }
  10. pre code { font-size:100%; }
  11. pre {
  12. margin: 1em 1em 1em 1.6em;
  13. padding: 2px;
  14. background-color: #fafafa;
  15. border: 1px solid #dadada;
  16. width:95%;
  17. overflow-x: auto;
  18. }
  19. a.new { color: #b73535; }
  20. .syntaxhl .line-numbers { padding: 2px 4px 2px 4px; background-color: #eee; margin:0 }
  21. .syntaxhl .comment { color:#666; }
  22. .syntaxhl .class { color:#B06; font-weight:bold }
  23. .syntaxhl .delimiter { color:black }
  24. .syntaxhl .function { color:#06B; font-weight:bold }
  25. .syntaxhl .inline { background: #eee }
  26. .syntaxhl .inline .inline-delimiter { font-weight: bold; color: #888 }
  27. .syntaxhl .instance-variable { color:#33B }
  28. .syntaxhl .reserved { color:#080; font-weight:bold }
  29. .syntaxhl .string { background-color:#fff0f0; color: #D20; }
  30. .syntaxhl .string .delimiter { color:#710 }
  31. </style>
  32. </head>
  33. <body>
  34. <h1><a name="1" class="wiki-page"></a>Форматирование Wiki</h1>
  35. <h2><a name="2" class="wiki-page"></a>Ссылки</h2>
  36. <h3><a name="3" class="wiki-page"></a>Ссылки Redmine</h3>
  37. <p>Redmine allows hyperlinking between resources (issues, changesets, wiki pages...) from anywhere wiki formatting is used.</p>
  38. <ul>
  39. <li>Ссылка на задачу: <strong>#124</strong>
  40. (
  41. <del><a href="#" class="issue"
  42. title="bulk edit doesn't change the category or fixed version properties (Closed)">#124</a></del>
  43. - ссылка зачёркнута, если задача закрыта)
  44. </li>
  45. <li>Link to an issue note: <strong>#124-6</strong>, or <strong>#124#note-6</strong></li>
  46. </ul>
  47. <p>Wiki ссылки:</p>
  48. <ul>
  49. <li><strong>[[Руководство]]</strong> выводит ссылку на страницу с названием 'Руководство': <a href="#"
  50. class="wiki-page">Руководство</a>
  51. </li>
  52. <li><strong>[[Руководство#дальнейшее-чтение]]</strong> направляет на метку "дальнейшее-чтение". Заголовкам
  53. автоматически
  54. метки, таким образом, вы можете на них ссылаться: <a href="#" class="wiki-page">Руководство</a></li>
  55. <li><strong>[[Руководство|Руководство пользователя]]</strong> выводит ссылку на саму страницу, но с другим текстом:
  56. <a href="#" class="wiki-page">Руководство пользователя</a>
  57. </li>
  58. </ul>
  59. <p>Также вы можете ссылаться на wiki:</p>
  60. <ul>
  61. <li><strong>[[sandbox:Некоторая страница]]</strong> выводит ссылку на страницу с названием 'Некоторая страница' wiki
  62. проекта Sandbox
  63. </li>
  64. <li><strong>[[sandbox:]]</strong> выводит ссылку на главную страницу wiki проекта Sandbox</li>
  65. </ul>
  66. <p>Ссылки на wiki окрашены в красный, если страница ещё не создана, пример: <a href="#" class="wiki-page new">Несуществующая
  67. страница</a>.</p>
  68. <p>ССылки на другие ресурсы:</p>
  69. <ul>
  70. <li>Документы:
  71. <ul>
  72. <li><strong>document#17</strong> (ссылка на документ с id 17)</li>
  73. <li><strong>document:Приветствие</strong> (ссылка на документ с названием "Приветствие")</li>
  74. <li><strong>document:"Некоторый документ"</strong> (двойные кавычки использоются в случае, когда название
  75. документа содержит пробелы)
  76. </li>
  77. <li><strong>sandbox:document:"Приветствие"</strong> (ссылка на документ с названием "Приветствие" в проекте
  78. "sandbox")
  79. </li>
  80. </ul></li>
  81. </ul>
  82. <ul>
  83. <li>Этапы:
  84. <ul>
  85. <li><strong>version#3</strong> (ссылка на этап с id 3)</li>
  86. <li><strong>version:1.0.0</strong> (ссылка на этап с названием "1.0.0")</li>
  87. <li><strong>version:"1.0 beta 2"</strong> (двойные кавычки использоются в случае, когда название
  88. этапа содержит пробелы)
  89. </li>
  90. <li><strong>sandbox:version:1.0.0</strong> (ссылка на этап "1.0.0" проекта "sandbox")</li>
  91. </ul></li>
  92. </ul>
  93. <ul>
  94. <li>Вложения:
  95. <ul>
  96. <li><strong>attachment:file.zip</strong> (ссылка на вложение текущего объекта с именем file.zip)</li>
  97. <li>Сейчас можно ссылаться только на вложения текущего объекта (если вы просматриваете задачу, то возможно
  98. ссылаться только на вложения этой задачи)
  99. </li>
  100. </ul></li>
  101. </ul>
  102. <ul>
  103. <li>Changesets:
  104. <ul>
  105. <li><strong>r758</strong> (link to a changeset)</li>
  106. <li><strong>commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash)</li>
  107. <li><strong>svn1|r758</strong> (link to a changeset of a specific repository, for projects with multiple repositories)</li>
  108. <li><strong>commit:hg|c6f4d0fd</strong> (link to a changeset with a non-numeric hash of a specific repository)</li>
  109. <li><strong>sandbox:r758</strong> (link to a changeset of another project)</li>
  110. <li><strong>sandbox:commit:c6f4d0fd</strong> (link to a changeset with a non-numeric hash of another project)</li>
  111. </ul></li>
  112. </ul>
  113. <ul>
  114. <li>Файлы хранилища:
  115. <ul>
  116. <li><strong>source:some/file</strong> (ссылка на файл /some/file, расположенный в хранилище проекта)
  117. </li>
  118. <li><strong>source:some/file@52</strong> (ссылка на 52 ревизию файла)</li>
  119. <li><strong>source:some/file#L120</strong> (ссылка на 120 строку файла)</li>
  120. <li><strong>source:some/file@52#L120</strong> (ссылка на 120 строку в 52 ревизии файла)</li>
  121. <li><strong>source:"some file@52#L120"</strong> (используйте use double quotes when the URL contains spaces</li>
  122. <li><strong>export:some/file</strong> (ссылка на загрузку файла)</li>
  123. <li><strong>source:svn1|some/file</strong> (link to a file of a specific repository, for projects with multiple repositories)</li>
  124. <li><strong>sandbox:source:some/file</strong> (ссылка на файл /some/file, расположенный в хранилище проекта
  125. "sandbox")
  126. </li>
  127. <li><strong>sandbox:export:some/file</strong> (ссылка на загрузку файла)</li>
  128. </ul></li>
  129. </ul>
  130. <ul>
  131. <li>Forums:
  132. <ul>
  133. <li><strong>forum#1</strong> (link to forum with id 1</li>
  134. <li><strong>forum:Support</strong> (link to forum named Support)</li>
  135. <li><strong>forum:"Technical Support"</strong> (use double quotes if forum name contains spaces)</li>
  136. </ul></li>
  137. </ul>
  138. <ul>
  139. <li>Сообщения форума:
  140. <ul>
  141. <li><strong>message#1218</strong> (ссылка на сообщение с id 1218)</li>
  142. </ul></li>
  143. </ul>
  144. <ul>
  145. <li>Проекты:
  146. <ul>
  147. <li><strong>project#3</strong> (ссылка на проект с id 3)</li>
  148. <li><strong>project:someproject</strong> (ссылка на проект "someproject")</li>
  149. <li><strong>project:"Some Project"</strong> (use double quotes for project name containing spaces)</li>
  150. </ul></li>
  151. </ul>
  152. <ul>
  153. <li>News:
  154. <ul>
  155. <li><strong>news#2</strong> (link to news item with id 2)</li>
  156. <li><strong>news:Greetings</strong> (link to news item named "Greetings")</li>
  157. <li><strong>news:"First Release"</strong> (use double quotes if news item name contains spaces)</li>
  158. </ul></li>
  159. </ul>
  160. <p>Исключения:</p>
  161. <ul>
  162. <li>Вы можете отменить обработку ссылок с помощью восклицательного знака перед ссылкой: !http://foo.bar</li>
  163. </ul>
  164. <h3><a name="4" class="wiki-page"></a>Внешние ссылки</h3>
  165. <p>HTTP и почтовые адреса автоматически транслируются в ссылки:</p>
  166. <pre>
  167. http://www.redmine.org, someone@foo.bar
  168. </pre>
  169. <p>выводится: <a class="external" href="http://www.redmine.org">http://www.redmine.org</a>, <a
  170. href="mailto:someone@foo.bar" class="email">someone@foo.bar</a></p>
  171. <p>Если же вы хотите, чтобы отобразился текст вместо адреса URL, вы можете испольовать стандартный синтаксис
  172. форматирования текста:</p>
  173. <pre>
  174. "Сайт Redmine":http://www.redmine.org
  175. </pre>
  176. <p>выводится: <a href="http://www.redmine.org" class="external">Сайт Redmine</a></p>
  177. <h2><a name="5" class="wiki-page"></a>Форматирование текста</h2>
  178. <p>Для таких вещей, как заголовки, выделение, таблицы и списки, Redmine поддерживает синтакс Textile. Обратитесь за
  179. руководством к странице <a class="external"
  180. href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)</a>
  181. . Несколько примеров приведены ниже, Но сам текстовый процессор способен на гораздо большее.</p>
  182. <h3><a name="6" class="wiki-page"></a>Стиль шрифта</h3>
  183. <pre>
  184. * *выделенный*
  185. * _наклонный_
  186. * _*выделенный наклонный*_
  187. * +подчёркнутый+
  188. * -зачёркнутый-
  189. </pre>
  190. <p>Выводится:</p>
  191. <ul>
  192. <li><strong>выделенный</strong></li>
  193. <li><em>наклонный</em></li>
  194. <li><em><strong>выделенный наклонный</strong></em></li>
  195. <li><ins>подчёркнутый</ins></li>
  196. <li><del>зачёркнутый</del></li>
  197. </ul>
  198. <h3><a name="7" class="wiki-page"></a>Вставка изображений</h3>
  199. <ul>
  200. <li><strong>!url_изображения!</strong> выводит изображение, расположенное по адресу url_изображения (синтакс textile)</li>
  201. <li><strong>!&gt;url_изображения!</strong> выводит изображение, выровненное по правому краю</li>
  202. <li>Прикреплённое к wiki-странице изображение можно отобразить в тексте, используя имя файла:
  203. <strong>!вложенное_изображение.png!</strong>
  204. </li>
  205. </ul>
  206. <h3><a name="8" class="wiki-page"></a>Заголовки</h3>
  207. <pre>
  208. h1. Заголовок
  209. h2. Подзаголовок
  210. h3. Подзаголовок подзаголовка
  211. </pre>
  212. <p>Redmine присваивает якорь каждому заголовку, поэтому вы можете легко сослаться на любой, указав в тексте "#Заголовок",
  213. "#Подзаголовок" и т.д.</p>
  214. <h3><a name="9" class="wiki-page"></a>Параграфы</h3>
  215. <pre>
  216. p&gt;. выровненный по правому краю
  217. p=. выровненный по центру
  218. </pre>
  219. <p style="text-align:center;">Это - выровненный по центру параграф.</p>
  220. <h3><a name="10" class="wiki-page"></a>Цитаты</h3>
  221. <p>Начните параграф с <strong>bq.</strong></p>
  222. <pre>
  223. bq. Rails - это полноценный, многоуровневый фреймворк для построения веб-приложений, использующих базы данных,
  224. который основан на архитектуре Модель-Представление-Контроллер (Model-View-Controller, MVC).
  225. </pre>
  226. <p>Выводится:</p>
  227. <blockquote>
  228. <p>Rails - это полноценный, многоуровневый фреймворк для построения веб-приложений, использующих базы данных,
  229. который основан на архитектуре Модель-Представление-Контроллер (Model-View-Controller, MVC).</p>
  230. </blockquote>
  231. <h3><a name="11" class="wiki-page"></a>Содержание</h3>
  232. <pre>
  233. {{Содержание}} =&gt; содержание, выровненное по левому краю
  234. {{&gt;Содержание}} =&gt; содержание, выровненное по правому краю
  235. </pre>
  236. <h3><a name="14" class="wiki-page"></a>Horizontal Rule</h3>
  237. <pre>
  238. ---
  239. </pre>
  240. <h2><a name="12" class="wiki-page"></a>Макросы</h2>
  241. <p>В Redmine существуют следующие встроенные макросы:</p>
  242. <p>
  243. <dl>
  244. <dt><code>hello_world</code></dt>
  245. <dd><p>Некоторый макрос.</p></dd>
  246. <dt><code>macro_list</code></dt>
  247. <dd><p>Выводит список доступных макросов с описаниями, если они имеются.</p></dd>
  248. <dt><code>child_pages</code></dt>
  249. <dd><p>Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:</p>
  250. <pre><code>{{child_pages}} -- can be used from a wiki page only
  251. {{child_pages(depth=2)}} -- display 2 levels nesting only</code></pre></dd>
  252. <dt><code>include</code></dt>
  253. <dd><p>Вставить wiki страницу. Пример:</p>
  254. <pre><code>{{include(Foo)}}</code></pre>
  255. <p>or to include a page of a specific project wiki:</p>
  256. <pre><code>{{include(projectname:Foo)}}</code></pre></dd>
  257. <dt><code>collapse</code></dt>
  258. <dd><p>Inserts of collapsed block of text. Example:</p>
  259. <pre><code>{{collapse(View details...)
  260. This is a block of text that is collapsed by default.
  261. It can be expanded by clicking a link.
  262. }}</code></pre></dd>
  263. <dt><code>thumbnail</code></dt>
  264. <dd><p>Displays a clickable thumbnail of an attached image. Examples:</p>
  265. <pre>{{thumbnail(image.png)}}
  266. {{thumbnail(image.png, size=300, title=Thumbnail)}}</pre></dd>
  267. </dl>
  268. </p>
  269. <h2><a name="13" class="wiki-page"></a>Подсветка кода</h2>
  270. <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>
  271. <p>Вы можете включить подсветку кода используя данный синтаксис:</p>
  272. <pre>
  273. &lt;pre&gt;&lt;code class="ruby"&gt;
  274. Поместите свой код сюда.
  275. &lt;/code&gt;&lt;/pre&gt;
  276. </pre>
  277. <p>Пример:</p>
  278. <pre><code class="ruby syntaxhl"><span class="line-numbers"> 1</span> <span class="comment"># The Greeter class</span>
  279. <span class="line-numbers"> 2</span> <span class="reserved">class</span> <span class="class">Greeter</span>
  280. <span class="line-numbers"> 3</span> <span class="reserved">def</span> <span class="function">initialize</span>(name)
  281. <span class="line-numbers"> 4</span> <span class="instance-variable">@name</span> = name.capitalize
  282. <span class="line-numbers"> 5</span> <span class="reserved">end</span>
  283. <span class="line-numbers"> 6</span>
  284. <span class="line-numbers"> 7</span> <span class="reserved">def</span> <span class="function">salute</span>
  285. <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>
  286. <span class="line-numbers"> 9</span> <span class="reserved">end</span>
  287. <span class="line-numbers"><strong>10</strong></span> <span class="reserved">end</span></code>
  288. </pre>
  289. </body>
  290. </html>