Форматирование Wiki

Ссылки

Ссылки Redmine

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

• Ссылка на задачу: #124 ( #124 - ссылка зачёркнута, если задача закрыта)
• Ссылка на изменение: r758 (выводится r758)
• Ссылка на изменение с нечисловым хэшем: commit:c6f4d0fd (выводится c6f4d0fd).
• Ссылка на изменение в другом проекте: sandbox:r758 (выводится sandbox:r758)
• Ссылка на изменение с нечисловым хэшем: sandbox:c6f4d0fd (выводится sandbox:c6f4d0fd).

Wiki ссылки:

• [[Руководство]] выводит ссылку на страницу с названием 'Руководство': Руководство
• [[Руководство#дальнейшее-чтение]] направляет на метку "дальнейшее-чтение". Заголовкам автоматически метки, таким образом, вы можете на них ссылаться: Руководство
• [[Руководство|Руководство пользователя]] выводит ссылку на саму страницу, но с другим текстом: Руководство пользователя

Также вы можете ссылаться на wiki:

• [[sandbox:Некоторая страница]] выводит ссылку на страницу с названием 'Некоторая страница' wiki проекта Sandbox
• [[sandbox:]] выводит ссылку на главную страницу wiki проекта Sandbox

Ссылки на wiki окрашены в красный, если страница ещё не создана, пример: Несуществующая страница.

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

• Документы:
  • document#17 (ссылка на документ с id 17)
  • document:Приветствие (ссылка на документ с названием "Приветствие")
  • document:"Некоторый документ" (двойные кавычки использоются в случае, когда название документа содержит пробелы)
  • sandbox:document:"Приветствие" (ссылка на документ с названием "Приветствие" в проекте "sandbox")

• Этапы:
  • version#3 (ссылка на этап с id 3)
  • version:1.0.0 (ссылка на этап с названием "1.0.0")
  • version:"1.0 beta 2" (двойные кавычки использоются в случае, когда название этапа содержит пробелы)
  • sandbox:version:1.0.0 (ссылка на этап "1.0.0" проекта "sandbox")

• Вложения:
  • attachment:file.zip (ссылка на вложение текущего объекта с именем file.zip)
  • Сейчас можно ссылаться только на вложения текущего объекта (если вы просматриваете задачу, то возможно ссылаться только на вложения этой задачи)

• Файлы хранилища:
  • source:some/file (ссылка на файл /some/file, расположенный в хранилище проекта)
  • source:some/file@52 (ссылка на 52 ревизию файла)
  • source:some/file#L120 (ссылка на 120 строку файла)
  • source:some/file@52#L120 (ссылка на 120 строку в 52 ревизии файла)
  • source:"some file@52#L120" (используйте use double quotes when the URL contains spaces
  • export:some/file (ссылка на загрузку файла)
  • sandbox:source:some/file (ссылка на файл /some/file, расположенный в хранилище проекта "sandbox")
  • sandbox:export:some/file (ссылка на загрузку файла)

• Сообщения форума:
  • message#1218 (ссылка на сообщение с id 1218)

• Проекты:
  • project#3 (ссылка на проект с id 3)
  • project:someproject (ссылка на проект "someproject")

Исключения:

• Вы можете отменить обработку ссылок с помощью восклицательного знака перед ссылкой: !http://foo.bar

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

HTTP и почтовые адреса автоматически транслируются в ссылки:

http://www.redmine.org, someone@foo.bar

выводится: http://www.redmine.org, someone@foo.bar

Если же вы хотите, чтобы отобразился текст вместо адреса URL, вы можете испольовать стандартный синтаксис форматирования текста:

"Сайт Redmine":http://www.redmine.org

выводится: Сайт Redmine

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

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

Стиль шрифта

* *выделенный*
* _наклонный_
* _*выделенный наклонный*_
* +подчёркнутый+
* -зачёркнутый-

Выводится:

• выделенный
• наклонный
• *выделенный наклонный*
• подчёркнутый
• зачёркнутый

Вставка изображений

• !url_изображения! выводит изображение, расположенное по адресу url_изображения (синтакс textile)
• !>url_изображения! выводит изображение, выровненное по правому краю
• Прикреплённое к wiki-странице изображение можно отобразить в тексте, используя имя файла: !вложенное_изображение.png!

Заголовки

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

Redmine присваивает якорь каждому заголовку, поэтому вы можете легко сослаться на любой, указав в тексте "#Заголовок", "#Подзаголовок" и т.д.

Параграфы

p>. выровненный по правому краю
p=. выровненный по центру

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

Цитаты

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

bq. Rails - это полноценный, многоуровневый фреймворк для построения веб-приложений, использующих базы данных,
    который основан на архитектуре Модель-Представление-Контроллер (Model-View-Controller, MVC).

Выводится:

Rails - это полноценный, многоуровневый фреймворк для построения веб-приложений, использующих базы данных, который основан на архитектуре Модель-Представление-Контроллер (Model-View-Controller, MVC).

Содержание

{{Содержание}} => содержание, выровненное по левому краю
{{>Содержание}} => содержание, выровненное по правому краю

Макросы

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

hello_world

Некоторый макрос.

include

Вставить wiki страницу. Пример:

{{include(Foo)}}

macro_list

Выводит список доступных макросов с описаниями, если они имеются.

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

Подсветка кода основана на CodeRay, библиотеке быстрой подсветки синтаксиса, которая полностью написана на Ruby. В данный момент она поддерживает языки: c, cpp, css, delphi, groovy, html, java, javascript, json, php, python, rhtml, ruby, scheme, sql, xml и yaml.

Вы можете включить подсветку кода используя данный синтаксис:

<pre><code class="ruby">
  Поместите свой код сюда.
</code></pre>

Пример:

 1 # The Greeter class
     2 class Greeter
     3 def initialize(name)
     4 @name = name.capitalize
     5 end
     6
     7 def salute
     8 puts "Hello #{@name}!"
     9 end
    10 end