Redmine

[[RusGuide|Руководство]]

h1. Форматирование текста в Redmine

{{>toc}}

h2. Ссылки

h3. Redmine ссылки

Redmine позволяет гиперссылок между вопросами, изменений и вики-страниц из любого вики-форматирование используется.

* Ссылка на задачу: *!#5* (отображается #5 , ссылка может быть зачеркнутой, если задача закрыта)

* Ссылка на набор изменений: *!r758* (отображается r758)

* Ссылка на набор изменений с ненумерованных хэшем: *commit:c6f4d0fd* (отображается c6f4d0fd). Добавлено в r1236.

Вики-ссылки:

* *[[Руководство пользователя]]* отображается ссылка на страницу с именем "Руководство пользователя": [[Руководство пользователя]]

* *[[Руководство пользователя|Особое руководство пользователя]]* отображает ссылку на ту же страницу, но с другим текстом: [[Руководство пользователя|Особое руководство пользователя]]

* *[[Руководство пользователя#Форматирование текста в Redmine|Особое руководство пользователя]]* показывает ссылку на заголовок на тойже странице с другим текстом: [[Руководство пользователя#Форматирование текста в Redmine|Особое руководство пользователя]]

Вы можете также ссылаться на страницы вики другого проекта:

* *[[sandbox:some page]]* отображается ссылка на страницу с именем "some page" из вики проекта sandbox 

* *[[sandbox:]]* отображается ссылка на главную страницу вики проекта sandbox 

Вики-ссылки отображаются красным цветом, если страница еще не существует, например: [[несуществующая страница]].

Ссылки на другие ресурсы:

* Документы:

* *!document#17* (ссылка на документ с идентификатором 17)

* *!document:Greetings* (ссылка на документ с названием "Greetings")

* *!document:"Some document"* (двойные кавычки можно использовать, когда название документа содержит пробелы)

* *!document:some_project:"Some document"* (ссылка на документ в другом проекте)

* Версии:

* *!version#3* (ссылка на версию с идентификатором 3)

* *!version:1.0.0* (ссылка на версию под названием "1.0.0")

* *!version:"1.0 beta 2"*

* Проекты:

* *project#<id>* (ссылка на проект с <id>)

* *!project:<identifier>*

* *!project:<name>*

* Вложения:

* *!attachment:file.zip* (ссылка на вложение текущего объекта с именем file.zip)

* Пока, можно ссылаться на вложеня в текущем объекта(если вы редактируете задачу, можно ссылаться на вложения только данной задачи)

* Хранилище файлов

* *!source:где-нибудь/файл* - Ссылка на файл, расположенный в "/где-нибудь/файл" в репозитории проекта

* *!source:где-нибудь/файл@52* - Ссылка на файл ревизии 52

* *!source:где-нибудь/файл#L120* - Ссылка на линию 120 из файла

* *!source:где-нибудь/файл@52#L120* - Ссылка на линии 120 из файла ревизии 52

* *!source:"где-нибудь файл@52#L120"* - Двойные кавычки могут быть использованы если URL содержит пробелы

* *!export:где-нибудь/файл* - Ссылка на загрузку указанного файла

Экранирование:

Вы можете предотвратить обрабатку ссылок Redmine-ом, если поставить перед ними восклицательный знак: !

Например:

<pre>

!document#17

</pre>

h3. Внешние ссылки

HTTP URL-адреса и адреса электронной почты автоматически преобразуется в активные ссылки:

* *http://www.redmine.org* - Внешняя ссылка на сайт Redmine: http://www.redmine.org

* *someone@foo.bar* - Ссылка на адрес электронной почты: someone@foo.bar

Взамен HTTP URL-адресам и адресам электронной почты можно также использовать другой текст, чем саму ссылку:

* *"Redmine веб-сайт":http://www.redmine.org* - Внешние ссылки с другим текстом: "Redmine веб-сайт":http://www.redmine.org

* *"Email someone":mailto:someone@foo.bar* - Ссылка на адрес электронной почты с другим текстом: "Email someone":mailto:someone@foo.bar

Более сложные инструкции для отправки электронной почты могут быть добавлены к ссылке на электронную почту. Могут быть переопределены тема, содержание и адреса для копий письма. Обратите внимание, что пробелы в любом из этих полей должны быть заменены на %20.

* *"Email webmaster and admin":mailto:webmaster@foo.bar?cc=admin@foo.bar* - Письмо вебмастеру, копия администратору: "Email webmaster and admin":mailto:webmaster@foo.bar?cc=admin@foo.bar

* *"Email someone for help":mailto:someone@foo.bar?subject=Website%20Help*- отправить письмо на тему "Website Help": "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help

* *"Email someone for help":mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20* - отправить письмо на тему "Website Hel", с нужным содержанием: "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20

h2. Форматирование текста

Для таких вещей, как заголовки, жирное выделение, таблицы, списки, Redmine поддерживает синтаксис Textile. См. http://www.textism.com/tools/textile/ для справке об использованию этих возможностей. Несколько примеров приведены ниже, но движок обладает большими возможностями.

h3. Аббревиатура

<pre>

JPL(Jean-Philippe Lang)

</pre>

Выглядит:

JPL(Jean-Philippe Lang)

h3. Стиль шрифта

<pre><code>* *жирным*

* _курсивом_

* *_жирным курсивом_*

* +подчеркивание+

* -зачеркивание-

* Верхний ^индекс^

* Нижний ~индекс~

</code></pre>

Выглядит:

 * *жирным*

 * _курсивом_

 * *_жирным курсивом_*

 * +подчеркивание+

 * -зачеркивание-

 * Верхний ^индекс^

 * Нижний ~индекс~

h3. Встроенные изображения

* *!image_url!* отображает изображение, привязанное к странице текущего объекта

* *!>image_url!* изображение, выравненное по правому краю

Если у вас есть изображение, связанное с вашей вики-страницей, его можно показать используя имя файла: *!attached_image.png!*

h3. Заголовки

<pre><code>h1. Заголовок

h2. Подзаголовок 

h3. Подзаголовок 

</code></pre>

h3. Параграфы

<pre><code>p>. Этот параграф выровнен по правому краю

p=.  Этот параграф выровнен по центру

</code></pre>

Выглядит: 

p>. Этот параграф выровнен по правому краю

p=.  Этот параграф выровнен по центру

h3. Предопределенный

Чтобы избежать принудительного форматирования необходиом использовать синтаксис:

<pre> <pre> *Ваш текст не станет жирным* </pre> </pre>

Выглядит:

<pre> *Ваш текст не станет жирным* </pre>

h3. Цитаты

Начните параграф с *bq.*

<pre><code>bq. Redmine is a flexible project management web application. Written using Ruby on Rails framework, it is cross-platform and cross-database.

</code></pre>

Выглядит:

bq. Redmine is a flexible project management web application. Written using Ruby on Rails framework, it is cross-platform and cross-database.

h3. Маркированный список

<pre>

* Пункт 1

* Пункт 2

** Пункт 21

*** Пункт 211

*** Пункт 212

** Пункт 22

* Пункт 3

</pre>

Выглядит: 

* Пункт 1

* Пункт 2

** Пункт 21

*** Пункт 211

*** Пункт 212

** Пункт 22

* Пункт 3

h3. Упорядоченные списки

<pre>

# Пункт 1

# Пункт 2

## Пункт 2.1

### Пункт 2.1.1

### Пункт 2.1.2

## Пункт 2.2

# Пункт 3

</pre>

Выглядит:

# Пункт 1

# Пункт 2

## Пункт 2.1

### Пункт 2.1.1

### Пункт 2.1.2

## Пункт 2.2

# Пункт 3

h3. Таблицы

<pre>

|_.UserID|_.Name|_.Group|

|\3=.IT|

|1|Artur Pirozhkov|/2.Users|

|2|Vasya Rogov|

|3|John Smith|Admin|

</pre>

Выглядит:

|_.UserID|_.Name|_.Group|

|\3=.IT|

|1|Artur Pirozhkov|/2.Users|

|2|Vasya Rogov|

|3|John Smith|Admin|

h3. Содержание

<pre><code>{{toc}} => выровнено по левому краю

{{>toc}} => выровнено по правому краю

</code></pre>

h3. Макрос

Redmine имеет следующие встроенные макросы:

{{macro_list}}

h3. Подсветка кода

Подсветку кода основывается на "CodeRay":http://coderay.rubychan.de/ , быстро работающая библиотека по подсветки синтаксиса  написана полностью на Ruby. В настоящее время она поддерживает синтаксис C, C + +, CSS, Delphi, Diff, Groovy, HTML, Java, JavaScript, JSON, нитро-XHTML, PHP, Python, RHTML, Ruby, Scheme, SQL, XML и YAML кода.

Вы можете выделить код в вики-страницы, используя следующий синтаксис:

<pre><code><pre><code class="ruby">

  Здесь ваш код

</code></pre>

</code></pre>

Пример:

<pre><code class="ruby">

# The Greeter class

class Greeter

  def initialize(name)

    @name = name.capitalize

  end

  def salute

    puts "Hello #{@name}!"

  end

end

</code></pre>