Форматування вікі сторінок (Markdown)
Лінки(посилання)
Redmine лінки(посилання)
Redmine дозволяє гіперпосилання між ресурсами (завданнями, змінами, вікі-сторінками ...) з будь-якого місця, де використовується вікі-форматування.
- Посилання на завдання: #124 (Відображає
#124, посилання закресленим, якщо завдання закрите)
- Link to an issue including tracker name and subject: ##124 (displays Bug #124: bulk edit doesn't change the category or fixed version properties)
- Посилання на примітку до завдання: #124-6, or #124#note-6
Вікі посилання:
- [[Керівництво користувача]] відображає посилання на сторінку під назвою 'Керівництво користувача': Керівництво користувача
- [[Guide#further-reading]] приведе вас до якоря "further-reading". Заголовкам автоматично призначаються якоря так, що Ви можете звернутися до них: Guide
- [[#further-reading]] link to the anchor "further-reading" of the current page: #further-reading
- [[Guide|User manual]] відображає посилання на ту ж саму сторінку, але з іншим текстом: User manual
Ви також можете посилатися на сторінки з вікі іншого проекту:
- [[sandbox:some page]] відображає посилання на сторінку з назвою 'Some page' з вікі Sandbox
- [[sandbox:]] відображає посилання на головну сторінку вікі Sandbox
Вікі посилання відображаються червоним кольором, якщо сторінка ще не існує: Неіснуюча сторінка.
Посилання на інші ресурси:
- Документи:
- 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)
- На даний момент можливо посилатись тільки на вкладення з поточного об'єкту (якщо ви працюєте з завданням, ви можете посилатись тільки на вкладення поточного завдання)
- Зміни:
- r758 (посилання на зміни)
- commit:c6f4d0fd (посилання на зміни з нечисловим хешем)
- svn1|r758 (посилання на зміни вказаного сховища(репозиторія), для проектів з декількома сховищами(репозиторіями))
- commit:hg|c6f4d0fd (посилання на зміни з нечисловим хешем вказаного репозиторія)
- sandbox:r758 (посилання на зміни іншого проекту)
- sandbox:commit:c6f4d0fd (посилання на зміни з нечисловим іншого проекту)
- Файли у сховищах(репозиторіях):
- source:some/file (посилання на файл за шляхом /some/file у сховищі проекту)
- source:some/file@52 (посилання на file з ревізії 52)
- source:some/file#L120 (посилання на рядок 120 з file)
- source:some/file@52#L120 (посилання на рядок 120 з file ревізії 52)
- source:"some file@52#L120" (використовуте подвійні лапки у випадках, коли URL містить пропуски
- export:some/file (примусове завантаження файлу file)
- source:svn1|some/file (посилання на file вказаного сховища, для проектів в яких використовується декілька сховищь)
- sandbox:source:some/file (посилання на файл за шляхом /some/file з сховища проекту "sandbox")
- sandbox:export:some/file (примусове завантаження файлу file)
- Форуми:
- forum#1 (посилання на форум з id 1
- forum:Support (посилання на форум з назвою Support)
- forum:"Технічна підтримка" (використовуте подвійні лапки у випадках, коли назва форуму містить пропуски)
- Повідомленя на форумах:
- message#1218 (посилання на повідомлення з id 1218)
- Проекти:
- project#3 (посилання на проект з id 3)
- project:some-project (посилання на проект з назвою або ідентифікатором "some-project")
- project:"Some Project" (використовуте подвійні лапки у випадках, коли назва проекту містить пропуски))
- Новини:
- news#2 (посилання на новину з id 2)
- news:Greetings (посилання на новину з заголовком "Greetings")
- news:"First Release" (використовуте подвійні лапки у випадках, коли назва новини містить пропуски)
- Users:
- user#2 (link to user with id 2)
- user:jsmith (Link to user with login jsmith)
- @jsmith (Link to user with login jsmith)
Запобігання перетворенню(escaping):
- Ви можете запобігти, щоб Redmine перетворював посилання, поставивши перед посиланням знак оклику: !
Зовнішні посилання
URLs (starting with: www, http, https, ftp, ftps, sftp and sftps) and email addresses are automatically turned into clickable links:
http://www.redmine.org, someone@foo.bar
відображаються як: http://www.redmine.org, someone@foo.bar
Якщо ви хочете, відобразити текст замість URL, ви можете використовувати стандартний markdown синтаксис:
[Redmine web site](http://www.redmine.org)
відображається як: Redmine web site
Форматування тексту
Для таких речей як: заголовки, жирний текст, таблиці, списки, Redmine підтримує Markdown синтаксис. Перегляньте http://daringfireball.net/projects/markdown/syntax для отримання інформації як цим користуватись. Нижче наводиться декілька прикладів, але можливості Markdown набагато більщі ніж у наведених прикладах.
Стиль шрифту
* **Жирний**
* *Курсив*
* ***Жирний курсив***
* ~~Закреслений~~
Відображення:
- Жирний
- Курсив
- Жирний курсив
Закреслений
Вбудовані(inline) зображення
- ![](image_url) виводить зображення, розташоване за адресою image_url (markdown синтаксис)
- ![](attached_image) зображення яке додане до вашої сторінки вікі, може бути відображено, з використанням ім'я файлу
Заголовоки
# Заголовок
## Підзаголовок
### Підзаголовок
Redmine призначає якір кожному з цих заголовків, таким чином, ви можете посилатись на них з "#Заголовок", "#Підзаголовок" і так далі.
Цитати
Почніть параграф з >
> Redmine — серверний веб-додаток з відкритим кодом для управління проектами та відстежування помилок. До системи входить календар-планувальник та діаграми Ганта
для візуального представлення ходу робіт за проектом та строків виконання.
Відображається:
Redmine — серверний веб-додаток з відкритим кодом для управління проектами та відстежування помилок. До системи входить календар-планувальник та діаграми Ганта для візуального представлення ходу робіт за проектом та строків виконання.
Таблиці змісту сторінки
{{toc}} => left aligned toc
{{>toc}} => right aligned toc
Горизонтальна лінія
---
Макроси
Redmine має наступні вбудовані макроси:
hello_world
Приклад макросу.
macro_list
Відображає список всіх доступних макросів, в тому числі опис, якщо такий є.
child_pages
Відображає список дочірніх сторінок. Без аргументів, він відображає дочірні сторінки поточної сторінки вікі. Приклад:
{{child_pages}} -- може бути використаний тільки на вікі-сторінці
{{child_pages(depth=2)}} -- відображає тільки 2 рівня вкладень
include
Вставити вікі-сторінку. Приклад:
{{include(Foo)}}
або вставити сторінку з конкретного проекту вікі:
{{include(projectname:Foo)}}
collapse
Втавте блок тексту, який має з'являтись при натисканні на "Детальніше...". Приклад:
{{collapse(Детальніше...)
Це блок тексту прихований по замовчуванню.
Його можливо показати натиснувши на посилання
}}
thumbnail
Відображає інтерактивні мініатюри вкладеного зображення. Приклади:
{{thumbnail(image.png)}}
{{thumbnail(image.png, size=300, title=Thumbnail)}}
Підсвітка синтаксису коду
Default code highlightment relies on Rouge, a syntax highlighting library written in pure Ruby. It supports many commonly used languages such as c, cpp (c++), csharp (c#, cs), css, diff (patch, udiff), go (golang), groovy, html, java, javascript (js), kotlin, objective_c (objc), perl (pl), php, python (py), r, ruby (rb), sass, scala, shell (bash, zsh, ksh, sh), sql, swift, xml and yaml (yml) languages, where the names inside parentheses are aliases. Please refer to https://www.redmine.org/projects/redmine/wiki/RedmineCodeHighlightingLanguages for the full list of supported languages.
Ви можете виділити підсвіткою код в будь-якому місці, яке підтримує вікі-форматування, використовуючи наступний синтаксис (зверніть увагу, що назва мови або псевдонім не чутливі до регістру):
``` ruby
Place your code here.
```
Приклад:
# The Greeter class
class Greeter
def initialize(name)
@name = name.capitalize
end
def salute
puts "Hello #{@name}!"
end
end