2013-08-08 03:49:00 +00:00
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
< html xmlns = "http://www.w3.org/1999/xhtml" xml:lang = "en" >
< head >
2013-11-23 18:43:46 +00:00
< title > Форматирование Wiki Redmine< / title >
2013-08-08 03:49:00 +00:00
< meta http-equiv = "content-type" content = "text/html; charset=utf-8" / >
< style type = "text/css" >
body { font:80% Verdana,Tahoma,Arial,sans-serif; }
h1, h2, h3, h4 { font-family: Trebuchet MS,Georgia,"Times New Roman",serif; }
pre, code { font-size:120%; }
pre code { font-size:100%; }
pre {
margin: 1em 1em 1em 1.6em;
padding: 2px;
background-color: #fafafa;
2015-08-14 02:47:54 +00:00
border: 1px solid #e2e2e2;
width: auto;
2013-08-08 03:49:00 +00:00
overflow-x: auto;
2015-08-14 02:47:54 +00:00
overflow-y: hidden;
2013-08-08 03:49:00 +00:00
}
a.new { color: #b73535; }
2015-08-14 02:47:54 +00:00
.syntaxhl .class { color:#258; font-weight:bold }
.syntaxhl .comment { color:#385; }
2013-08-08 03:49:00 +00:00
.syntaxhl .delimiter { color:black }
.syntaxhl .function { color:#06B; font-weight:bold }
2015-08-14 02:47:54 +00:00
.syntaxhl .inline { background-color: hsla(0,0%,0%,0.07); color: black }
.syntaxhl .inline-delimiter { font-weight: bold; color: #666 }
2013-08-08 03:49:00 +00:00
.syntaxhl .instance-variable { color:#33B }
2015-08-14 02:47:54 +00:00
.syntaxhl .keyword { color:#939; font-weight:bold }
.syntaxhl .string .content { color: #46a }
.syntaxhl .string .delimiter { color:#46a }
2013-08-08 03:49:00 +00:00
< / style >
< / head >
< body >
2013-11-23 18:43:46 +00:00
< h1 > < a name = "1" class = "wiki-page" > < / a > Форматирование Wiki< / h1 >
2013-08-08 03:49:00 +00:00
2013-11-23 18:43:46 +00:00
< h2 > < a name = "2" class = "wiki-page" > < / a > Ссылки< / h2 >
2013-08-08 03:49:00 +00:00
2013-11-23 18:43:46 +00:00
< h3 > < a name = "3" class = "wiki-page" > < / a > Ссылки Redmine< / h3 >
2013-08-08 03:49:00 +00:00
2016-01-30 05:51:26 +00:00
< p > Redmine допускает гиперссылки между ресурсами (задачи, версии, wiki-страницы) отовсюду в wiki-формате.< / p >
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > Ссылка на задачу: < strong > #124< / strong >
(
< del > < a href = "#" class = "issue"
2016-01-30 05:51:26 +00:00
title="крупное редактирование не меняет категорию и свойства исправленной версии (Закрыто)">#124< / a > < / del >
2013-11-23 18:43:46 +00:00
- ссылка зачёркнута, если задача закрыта)
< / li >
2016-01-30 05:51:26 +00:00
< li > Ссылка на задачу: < strong > #124-6< / strong > , или < strong > #124#note-6< / strong > < / li >
2013-08-08 03:49:00 +00:00
< / ul >
2013-11-23 18:43:46 +00:00
< p > Wiki ссылки:< / p >
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > < strong > [[Руководство]]< / strong > выводит ссылку на страницу с названием 'Руководство': < a href = "#"
class="wiki-page">Руководство< / a >
< / li >
< li > < strong > [[Руководство#дальнейшее-чтение]]< / strong > направляет на метку "дальнейшее-чтение". Заголовкам
автоматически
метки, таким образом, вы можете на них ссылаться: < a href = "#" class = "wiki-page" > Руководство< / a > < / li >
< li > < strong > [[Руководство|Руководство пользователя]]< / strong > выводит ссылку на саму страницу, но с другим текстом:
< a href = "#" class = "wiki-page" > Руководство пользователя< / a >
< / li >
2013-08-08 03:49:00 +00:00
< / ul >
2013-11-23 18:43:46 +00:00
< p > Также вы можете ссылаться на wiki:< / p >
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > < strong > [[sandbox:Некоторая страница]]< / strong > выводит ссылку на страницу с названием 'Некоторая страница' wiki
проекта Sandbox
< / li >
< li > < strong > [[sandbox:]]< / strong > выводит ссылку на главную страницу wiki проекта Sandbox< / li >
2013-08-08 03:49:00 +00:00
< / ul >
2013-11-23 18:43:46 +00:00
< p > Ссылки на wiki окрашены в красный, если страница ещё не создана, пример: < a href = "#" class = "wiki-page new" > Несуществующая
страница< / a > .< / p >
2013-08-08 03:49:00 +00:00
2013-11-23 18:43:46 +00:00
< p > ССылки на другие ресурсы:< / p >
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > Документы:
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > < strong > document#17< / strong > (ссылка на документ с id 17)< / li >
< li > < strong > document:Приветствие< / strong > (ссылка на документ с названием "Приветствие")< / li >
< li > < strong > document:"Некоторый документ"< / strong > (двойные кавычки использоются в случае, когда название
документа содержит пробелы)
< / li >
< li > < strong > sandbox:document:"Приветствие"< / strong > (ссылка на документ с названием "Приветствие" в проекте
"sandbox")
< / li >
2013-08-08 03:49:00 +00:00
< / ul > < / li >
< / ul >
< ul >
2013-11-23 18:43:46 +00:00
< li > Этапы:
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > < strong > version#3< / strong > (ссылка на этап с id 3)< / li >
< li > < strong > version:1.0.0< / strong > (ссылка на этап с названием "1.0.0")< / li >
< li > < strong > version:"1.0 beta 2"< / strong > (двойные кавычки использоются в случае, когда название
этапа содержит пробелы)
< / li >
< li > < strong > sandbox:version:1.0.0< / strong > (ссылка на этап "1.0.0" проекта "sandbox")< / li >
2013-08-08 03:49:00 +00:00
< / ul > < / li >
< / ul >
< ul >
2013-11-23 18:43:46 +00:00
< li > Вложения:
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > < strong > attachment:file.zip< / strong > (ссылка на вложение текущего объекта с именем file.zip)< / li >
< li > Сейчас можно ссылаться только на вложения текущего объекта (если вы просматриваете задачу, то возможно
ссылаться только на вложения этой задачи)
< / li >
2013-08-08 03:49:00 +00:00
< / ul > < / li >
< / ul >
< ul >
2016-01-30 05:51:26 +00:00
< li > Версии:
2013-08-08 03:49:00 +00:00
< ul >
2016-01-30 05:51:26 +00:00
< li > < strong > r758< / strong > (ссылка на версию)< / li >
< li > < strong > commit:c6f4d0fd< / strong > (ссылка неа версию с нецифровым хешем)< / li >
< li > < strong > svn1|r758< / strong > (ссылка на версию специфичного хранилища, для проектов лежащих в нескольких хранилищах)< / li >
< li > < strong > commit:hg|c6f4d0fd< / strong > (ссылка на версию с нецифровым хешем в специфичном хранилище)< / li >
< li > < strong > sandbox:r758< / strong > (ссылка на версию в другом проекте)< / li >
< li > < strong > sandbox:commit:c6f4d0fd< / strong > (ссылка на версию с нецифровым хешем в другом проекте)< / li >
2013-08-08 03:49:00 +00:00
< / ul > < / li >
< / ul >
< ul >
2013-11-23 18:43:46 +00:00
< li > Файлы хранилища:
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > < strong > source:some/file< / strong > (ссылка на файл /some/file, расположенный в хранилище проекта)
< / li >
< li > < strong > source:some/file@52< / strong > (ссылка на 52 ревизию файла)< / li >
< li > < strong > source:some/file#L120< / strong > (ссылка на 120 строку файла)< / li >
< li > < strong > source:some/file@52#L120< / strong > (ссылка на 120 строку в 52 ревизии файла)< / li >
2016-01-30 05:51:26 +00:00
< li > < strong > source:"some file@52#L120"< / strong > (используйте кавычки, если в ссылке есть пробелы)< / li >
2013-11-23 18:43:46 +00:00
< li > < strong > export:some/file< / strong > (ссылка на загрузку файла)< / li >
2016-01-30 05:51:26 +00:00
< li > < strong > source:svn1|some/file< / strong > (ссылка на версию специфичного хранилища, для проектов лежащих в нескольких хранилищах)< / li >
2013-11-23 18:43:46 +00:00
< li > < strong > sandbox:source:some/file< / strong > (ссылка на файл /some/file, расположенный в хранилище проекта
"sandbox")
< / li >
< li > < strong > sandbox:export:some/file< / strong > (ссылка на загрузку файла)< / li >
2013-08-08 03:49:00 +00:00
< / ul > < / li >
< / ul >
2014-12-24 12:27:45 +00:00
< ul >
2016-01-30 05:51:38 +00:00
< li > Форумы:
2015-06-21 16:38:29 +00:00
< ul >
2016-01-30 05:51:38 +00:00
< li > < strong > forum#1< / strong > (ссылка на форум с id 1)< / li >
< li > < strong > forum:Support< / strong > (ссылка на форум "Support")< / li >
< li > < strong > forum:"Technical Support"< / strong > (используйте кавычки, если в названии есть пробелы)< / li >
2014-12-24 12:27:45 +00:00
< / ul > < / li >
< / ul >
2015-06-21 16:38:29 +00:00
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > Сообщения форума:
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > < strong > message#1218< / strong > (ссылка на сообщение с id 1218)< / li >
2013-08-08 03:49:00 +00:00
< / ul > < / li >
< / ul >
< ul >
2013-11-23 18:43:46 +00:00
< li > Проекты:
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > < strong > project#3< / strong > (ссылка на проект с id 3)< / li >
< li > < strong > project:someproject< / strong > (ссылка на проект "someproject")< / li >
2016-01-30 05:51:38 +00:00
< li > < strong > project:"Some Project"< / strong > (используйте кавычки, если в названии есть пробелы)< / li >
2014-12-24 12:27:45 +00:00
< / ul > < / li >
< / ul >
< ul >
2016-01-30 05:51:38 +00:00
< li > Новости:
2015-06-21 16:38:29 +00:00
< ul >
2016-01-30 05:51:38 +00:00
< li > < strong > news#2< / strong > (ссылка на новость с id 2)< / li >
< li > < strong > news:Greetings< / strong > (ссылка на новость "Greetings")< / li >
< li > < strong > news:"First Release"< / strong > (используйте кавычки, если в названии есть пробелы)< / li >
2013-08-08 03:49:00 +00:00
< / ul > < / li >
< / ul >
2013-11-23 18:43:46 +00:00
< p > Исключения:< / p >
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > Вы можете отменить обработку ссылок с помощью восклицательного знака перед ссылкой: !http://foo.bar< / li >
2013-08-08 03:49:00 +00:00
< / ul >
2013-11-23 18:43:46 +00:00
< h3 > < a name = "4" class = "wiki-page" > < / a > Внешние ссылки< / h3 >
2013-08-08 03:49:00 +00:00
2013-11-23 18:43:46 +00:00
< p > HTTP и почтовые адреса автоматически транслируются в ссылки:< / p >
2013-08-08 03:49:00 +00:00
< pre >
http://www.redmine.org, someone@foo.bar
< / pre >
2013-11-23 18:43:46 +00:00
< 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 >
2013-08-08 03:49:00 +00:00
2013-11-23 18:43:46 +00:00
< p > Если же вы хотите, чтобы отобразился текст вместо адреса URL, вы можете испольовать стандартный синтаксис
форматирования текста:< / p >
2013-08-08 03:49:00 +00:00
< pre >
2013-11-23 18:43:46 +00:00
"Сайт Redmine":http://www.redmine.org
2013-08-08 03:49:00 +00:00
< / pre >
2013-11-23 18:43:46 +00:00
< p > выводится: < a href = "http://www.redmine.org" class = "external" > Сайт Redmine< / a > < / p >
2013-08-08 03:49:00 +00:00
2013-11-23 18:43:46 +00:00
< h2 > < a name = "5" class = "wiki-page" > < / a > Форматирование текста< / h2 >
2013-08-08 03:49:00 +00:00
2013-11-23 18:43:46 +00:00
< p > Для таких вещей, как заголовки, выделение, таблицы и списки, Redmine поддерживает синтакс Textile. Обратитесь за
руководством к странице < a class = "external"
href="http://en.wikipedia.org/wiki/Textile_%28markup_language%29">http://en.wikipedia.org/wiki/Textile_(markup_language)< / a >
. Несколько примеров приведены ниже, Н о сам текстовый процессор способен на гораздо большее.< / p >
2013-08-08 03:49:00 +00:00
2013-11-23 18:43:46 +00:00
< h3 > < a name = "6" class = "wiki-page" > < / a > Стиль шрифта< / h3 >
2013-08-08 03:49:00 +00:00
< pre >
2013-11-23 18:43:46 +00:00
* *выделенный*
* _на кло нный_
* _*выделенный наклонный*_
* +подчёркнутый+
* -зачёркнутый-
2013-08-08 03:49:00 +00:00
< / pre >
2013-11-23 18:43:46 +00:00
< p > Выводится:< / p >
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > < strong > выделенный< / strong > < / li >
< li > < em > наклонный< / em > < / li >
< li > < em > < strong > выделенный наклонный< / strong > < / em > < / li >
< li > < ins > подчёркнутый< / ins > < / li >
< li > < del > зачёркнутый< / del > < / li >
2013-08-08 03:49:00 +00:00
< / ul >
2013-11-23 18:43:46 +00:00
< h3 > < a name = "7" class = "wiki-page" > < / a > Вставка изображений< / h3 >
2013-08-08 03:49:00 +00:00
< ul >
2013-11-23 18:43:46 +00:00
< li > < strong > !url_изо б р а же ния!< / strong > выводит изображение, расположенное по адресу url_изо б р а же ния (синтакс textile)< / li >
2013-11-25 05:23:09 +00:00
< li > < strong > !> url_изо б р а же ния!< / strong > выводит изображение, выровненное по правому краю< / li >
2013-11-23 18:43:46 +00:00
< li > Прикреплённое к wiki-странице изображение можно отобразить в тексте, используя имя файла:
< strong > !вло же нно е _изо б р а же ние .png!< / strong >
< / li >
2013-08-08 03:49:00 +00:00
< / ul >
2013-11-23 18:43:46 +00:00
< h3 > < a name = "8" class = "wiki-page" > < / a > Заголовки< / h3 >
2013-08-08 03:49:00 +00:00
< pre >
2013-11-23 18:43:46 +00:00
h1. Заголовок
h2. Подзаголовок
h3. Подзаголовок подзаголовка
2013-08-08 03:49:00 +00:00
< / pre >
2013-11-23 18:43:46 +00:00
< p > Redmine присваивает якорь каждому заголовку, поэтому вы можете легко сослаться на любой, указав в тексте "#Заголовок",
"#Подзаголовок" и т.д.< / p >
2013-08-08 03:49:00 +00:00
2013-11-23 18:43:46 +00:00
< h3 > < a name = "9" class = "wiki-page" > < / a > Параграфы< / h3 >
2013-08-08 03:49:00 +00:00
< pre >
2013-11-25 05:23:09 +00:00
p> . выровненный по правому краю
2013-11-23 18:43:46 +00:00
p=. выровненный по центру
2013-08-08 03:49:00 +00:00
< / pre >
2013-11-23 18:43:46 +00:00
< p style = "text-align:center;" > Это - выровненный по центру параграф.< / p >
2013-08-08 03:49:00 +00:00
2013-11-23 18:43:46 +00:00
< h3 > < a name = "10" class = "wiki-page" > < / a > Цитаты< / h3 >
2013-08-08 03:49:00 +00:00
2013-11-23 18:43:46 +00:00
< p > Начните параграф с < strong > bq.< / strong > < / p >
2013-08-08 03:49:00 +00:00
< pre >
2013-11-23 18:43:46 +00:00
bq. Rails - это полноценный, многоуровневый фреймворк для построения веб-приложений, использующих базы данных,
который основан на архитектуре Модель-Представление-Контроллер (Model-View-Controller, MVC).
2013-08-08 03:49:00 +00:00
< / pre >
2013-11-23 18:43:46 +00:00
< p > Выводится:< / p >
2013-08-08 03:49:00 +00:00
< blockquote >
2013-11-23 18:43:46 +00:00
< p > Rails - это полноценный, многоуровневый фреймворк для построения веб-приложений, использующих базы данных,
который основан на архитектуре Модель-Представление-Контроллер (Model-View-Controller, MVC).< / p >
2013-08-08 03:49:00 +00:00
< / blockquote >
2013-11-23 18:43:46 +00:00
< h3 > < a name = "11" class = "wiki-page" > < / a > Содержание< / h3 >
2013-08-08 03:49:00 +00:00
< pre >
2013-11-25 05:23:09 +00:00
{{Содержание}} => содержание, выровненное по левому краю
{{> Содержание}} => содержание, выровненное по правому краю
2013-08-08 03:49:00 +00:00
< / pre >
< h3 > < a name = "14" class = "wiki-page" > < / a > Horizontal Rule< / h3 >
< pre >
---
< / pre >
2013-11-23 18:43:46 +00:00
< h2 > < a name = "12" class = "wiki-page" > < / a > Макросы< / h2 >
2013-08-08 03:49:00 +00:00
2013-11-23 18:43:46 +00:00
< p > В Redmine существуют следующие встроенные макросы:< / p >
2013-08-08 03:49:00 +00:00
2014-09-11 21:25:37 +00:00
< p >
< dl >
< dt > < code > hello_world< / code > < / dt >
< dd > < p > Некоторый макрос.< / p > < / dd >
< dt > < code > macro_list< / code > < / dt >
< dd > < p > Выводит список доступных макросов с описаниями, если они имеются.< / p > < / dd >
< dt > < code > child_pages< / code > < / dt >
2016-01-30 05:51:26 +00:00
< dd > < p > Вывод списка дочерних страниц. Без аргументов выводится список дочерних страниц для текущей wiki-страницы. Пример:< / p >
< pre > < code > {{child_pages}} -- можно использователь только на wiki-странице
{{child_pages(depth=2)}} -- вывести только 2 уровня вложенности< / code > < / pre > < / dd >
2014-09-11 21:25:37 +00:00
< dt > < code > include< / code > < / dt >
2016-01-30 05:51:26 +00:00
< dd > < p > Вставить wiki-страницу. Пример:< / p >
2015-03-15 10:02:00 +00:00
< pre > < code > {{include(Foo)}}< / code > < / pre >
2016-01-30 05:51:26 +00:00
< p > или вставить сраницу wiki конкретного проекта:< / p >
2015-03-15 10:02:00 +00:00
< pre > < code > {{include(projectname:Foo)}}< / code > < / pre > < / dd >
2014-09-11 21:25:37 +00:00
< dt > < code > collapse< / code > < / dt >
2016-01-30 05:51:26 +00:00
< dd > < p > Вставить скрываемый текст. Пример:< / p >
< pre > < code > {{collapse(Читать дальше...)
Этот блок текста по умолчанию скрыт.
Он расскроется, если нажать на ссылку.
2014-09-11 21:25:37 +00:00
}}< / code > < / pre > < / dd >
< dt > < code > thumbnail< / code > < / dt >
2016-01-30 05:51:26 +00:00
< dd > < p > Отображет кликабельный эскиз приложенной картинки. Пример:< / p >
2014-09-11 21:25:37 +00:00
< pre > {{thumbnail(image.png)}}
2016-01-30 05:51:26 +00:00
{{thumbnail(image.png, size=300, title=Эскиз)}}< / pre > < / dd >
2014-09-11 21:25:37 +00:00
< / dl >
< / p >
2013-08-08 03:49:00 +00:00
2013-11-23 18:43:46 +00:00
< h2 > < a name = "13" class = "wiki-page" > < / a > Подсветка кода< / h2 >
2013-08-08 03:49:00 +00:00
2016-01-30 06:24:43 +00:00
< p > По умолчанию за подсветку код отвечает < a href = "http://coderay.rubychan.de/" class = "external" > CodeRay< / a > , и для лучшей производительности библиотеки написаны на Ruby. Сейчас поддерживаются c, clojure, cpp (c++, cplusplus), css, delphi (pascal), diff (patch), erb (eruby, rhtml), go, groovy, haml, html (xhtml), java, javascript (ecmascript, ecma_script, java_script, js), json, lua, php, python, ruby (irb), sass, sql, taskpaper, text (plain, plaintext), xml and yaml (yml) языки.< / p >
2013-08-08 03:49:00 +00:00
2016-01-30 06:24:43 +00:00
< p > Вы можете подсветить код в любом месте, где поддерживается wiki-форматирование (название языка не зависит от регистра):< / p >
2013-08-08 03:49:00 +00:00
< pre >
< pre> < code class="ruby">
2013-11-23 18:43:46 +00:00
Поместите свой код сюда.
2013-08-08 03:49:00 +00:00
< /code> < /pre>
< / pre >
2013-11-23 18:43:46 +00:00
< p > Пример:< / p >
2013-08-08 03:49:00 +00:00
2015-08-14 02:47:54 +00:00
< pre > < code class = "ruby syntaxhl" > < span class = "CodeRay" > < span class = "comment" > # The Greeter class< / span >
< span class = "keyword" > class< / span > < span class = "class" > Greeter< / span >
< span class = "keyword" > def< / span > < span class = "function" > initialize< / span > (name)
< span class = "instance-variable" > @name< / span > = name.capitalize
< span class = "keyword" > end< / span >
< span class = "keyword" > def< / span > < span class = "function" > salute< / 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 >
< span class = "keyword" > end< / span >
< span class = "keyword" > end< / span > < / span > < / code >
2013-08-08 03:49:00 +00:00
< / pre >
< / body >
< / html >