RusRedmineTextFormatting » History » Version 2

« Previous - Version 2/78 (diff) - Next » - Current version
Denis Savitskiy, 2011-06-30 15:59


Руководство

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

Ссылки

Redmine ссылки

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

  • Ссылка на задачу: #5 (отображается #5 , ссылка может быть зачеркнутой, если задача закрыта)
  • Ссылка на набор изменений (ревизию): r758 (отображается r758)
  • Ссылка на набор изменений с ненумерованных хэшем: commit:c6f4d0fd (отображается c6f4d0fd). Добавлено в r1236.

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

  • [[Руководство пользователя]] отображается ссылка на страницу с именем "Руководство пользователя": Руководство пользователя
  • [[Руководство пользователя|Особое руководство пользователя]] отображает ссылку на ту же страницу, но с другим текстом: Особое руководство пользователя
  • [[Руководство пользователя#Форматирование текста в 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-ом, если поставить перед ними восклицательный знак: !
Например:

!document#17

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

HTTP URL-адреса и адреса электронной почты автоматически преобразуется в активные ссылки:
  • http://www.redmine.org - Внешняя ссылка на сайт Redmine: http://www.redmine.org
  • someone@foo.bar - Ссылка на адрес электронной почты:
Взамен HTTP URL-адресам и адресам электронной почты можно также использовать другой текст, чем саму ссылку:
  • "Redmine веб-сайт":http://www.redmine.org - Внешние ссылки с другим текстом: Redmine веб-сайт
  • "Email someone":mailto:someone@foo.bar - Ссылка на адрес электронной почты с другим текстом: Email someone
Более сложные инструкции для отправки электронной почты могут быть добавлены к ссылке на электронную почту. Могут быть переопределены: тема, содержание и адреса для копий письма. Обратите внимание, что пробелы в любом из этих полей должны быть заменены на %20.
  • "Email webmaster and admin":mailto:webmaster@foo.bar?cc=admin@foo.bar - Письмо вебмастеру, копия администратору: Email webmaster and admin
  • "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help- отправить письмо на тему "Website Help": Email someone for help
  • "Email someone for help":mailto:someone@foo.bar?subject=Website%20Help&body=My%20problem%20is%20 - отправить письмо на тему "Website Hel", с нужным содержанием: Email someone for help

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

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

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

JPL(Jean-Philippe Lang)

Выглядит:

JPL

Стиль шрифта

* *жирным*
* _курсивом_
* *_жирным курсивом_*
* +подчеркивание+
* -зачеркивание-
* Верхний ^индекс^
* Нижний ~индекс~

Выглядит:

  • жирным
  • курсивом
  • жирным курсивом
  • подчеркивание
  • зачеркивание
  • Верхний индекс
  • Нижний индекс

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

  • !image_url! отображает изображение, привязанное к странице текущего объекта
  • !>image_url! изображение, выравненное по правому краю

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

Заголовки

h1. Заголовок
h2. Подзаголовок 
h3. Подзаголовок 

Параграфы

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

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

Выглядит:

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

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

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

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

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

Выглядит:

 *Ваш текст не станет жирным* 

Цитаты

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

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

Выглядит:

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

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

* Пункт 1
* Пункт 2
** Пункт 2.1
*** Пункт 2.1.1
*** Пункт 2.1.2
** Пункт 2.2
* Пункт 3

Выглядит:

  • Пункт 1
  • Пункт 2
    • Пункт 2.1
      • Пункт 2.1.1
      • Пункт 2.1.2
    • Пункт 2.2
  • Пункт 3

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

# Пункт 1
# Пункт 2
## Пункт 2.1
### Пункт 2.1.1
### Пункт 2.1.2
## Пункт 2.2
# Пункт 3

Выглядит:

  1. Пункт 1
  2. Пункт 2
    1. Пункт 2.1
      1. Пункт 2.1.1
      2. Пункт 2.1.2
    2. Пункт 2.2
  3. Пункт 3

Таблицы

|_.UserID|_.Name|_.Group|
|\3=.IT|
|1|Artur Pirozhkov|/2.Users|
|2|Vasya Rogov|
|3|John Smith|Admin|

Выглядит:

UserID Name Group
IT
1 Artur Pirozhkov Users
2 Vasya Rogov
3 John Smith Admin

Содержание

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

Макрос

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

hello_world

Sample macro.

macro_list

Displays a list of all available macros, including description if available.

child_pages

Displays a list of child pages. With no argument, it displays the child pages of the current wiki page. Examples:

!{{child_pages}} -- can be used from a wiki page only
!{{child_pages(depth=2)}} -- display 2 levels nesting only
include

Include a wiki page. Example:

!{{include(Foo)}}

or to include a page of a specific project wiki:

!{{include(projectname:Foo)}}
collapse

Inserts of collapsed block of text. Example:

{{collapse(View details...)
This is a block of text that is collapsed by default.
It can be expanded by clicking a link.
}}
thumbnail

Displays a clickable thumbnail of an attached image. Examples:

{{thumbnail(image.png)}}
{{thumbnail(image.png, size=300, title=Thumbnail)}}
sample_macro

Sample macro

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

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

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

<pre><code class="ruby">
  Здесь ваш код
</code></pre>

Пример:

# The Greeter class
class Greeter
  def initialize(name)
    @name = name.capitalize
  end

  def salute
    puts "Hello #{@name}!" 
  end
end

i0003.gif (50 KB) Lucy Yevseyeva, 2011-09-09 13:56

scm_diff.png (52.3 KB) Lucy Yevseyeva, 2014-06-21 19:57