Version 1 (modified by 15 years ago) ( diff ) | ,
---|
Trac ссылки
En-version: TracLinks
TracLinks (Trac-ссылки) — одна из важнейших функций Trac, поскольку они допускают легкое добавление гиперссылок между различными сущностями в системе, такими как тикеты, отчеты, правки (changesets), страницы Wiki, этапы (milestones), и исходные файлы, в общем, везде где используется Wiki-форматирование.
TracLinks обычно имеют форму type:id (где id представляет номер, имя или путь объекта), однако чаще используется краткая форма записи.
Где, используются Trac-ссылки
Вы можете использовать Trac-ссылки в:
- Исходных кодах (Subversion), комментариях к коммитам
- Wiki-страницах
- Полных описаниях тикетов, отчетов и этапов
и любые другие текстовые поля, явно поддерживающие Wiki-форматирование.
Примеры:
- Tickets (Тикеты): #1 or ticket:1
- Ticket comments (Комментарии к тикетам): comment:ticket:1:2
- Reports (Отчеты): {1} or report:1
- Changesets (Правки): [1] or changeset:1
- Revision log (Лог хранилища): r1:3, [1:3] or log:@1:3, log:trunk@1:3
- Diffs (Сравнения) (требуют 0.10): diff:@1:3, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default or diff:trunk/trac@3538//sandbox/vc-refactoring@3539
- Wiki pages: CamelCase or wiki:CamelCase
- Parent page: [..]
- Milestones (Этапы): milestone:1.0
- Attachment: attachment:ticket:944:attachment.1073.diff
- Files (Файлы): source:trunk/COPYING
- Конкретная редакция (правка) файла: source:/trunk/COPYING@200
- Конкретная строка правки файла: source:/trunk/COPYING@200#L25
Покажут:
- Tickets (Тикеты): #1 or ticket:1
- Ticket comments: comment:ticket:1:2
- Reports (Отчеты): {1} or report:1
- Changesets (Правки): [1] or changeset:1
- Revision log (Лог хранилища): r1:3, [1:3] или log:@1:3, log:trunk@1:3
- Diffs (Сравнения): (требуют 0.10): diff:@1:3, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default или diff:trunk/trac@3538//sandbox/vc-refactoring@3539
- Wiki pages: CamelCase or wiki:CamelCase
- Родительская статья: ..
- Milestones (Этапы): milestone:1.0
- Attachment: attachment:ticket:944:attachment.1073.diff
- Files (Файлы): source:trunk/COPYING
- Конкретная редакция (правка) файла: source:/trunk/COPYING@200
- Конкретная строка правки файла: source:/trunk/COPYING@200#L25
Внимание: Форма записи wiki:CamelCase используется нечасто, но может быть удобной для ссылок на страницы, имена которых не следуют правилам WikiPageNames, то есть состоят из одиночных слов, неалфавитных символов и т.д. См. WikiPageNames для более полной информации.
Ссылки с использованием полного синтаксиса могут быть использованы также для указания названия ссылки вручную, например:
[ticket:1 Это ссылка на карточку номер 1].
Отобразится:
Это ссылка на карточку номер 1.
Если альтернативный текст для ссылке не прописан, будет показан только идентификатор ссылки (часть после двоеточия):
[ticket:1]
Отобразится: 1
wiki
— тип по умолчанию для подробной нотации ссылок, если часть "namespace" (тип ссылки) опущена (с версии 0.10).
[SandBox the sandbox]
Отобразится: the sandbox
Trac-ссылки — это очень простая идея, но позволяет легко создать актуальную сколь угодно сложную связную информационную структуру. На практике такой синтаксис является интуитивно простым в использовании, и мы (разработчики) находим "ссылки с названиями" (link trail) неплохим инструментов для облегчения понимания того, что происходит в проекте, и почему были сделаны конкретные изменения.
Дополнительное использование Trac-ссылок
Относительные связи
Для того, чтобы создать ссылку на некоторый "якорь" в статье, используйте '#':
[#Relativelinks relative links]
Отобразится:
Примечание: когда вы перемещаете мышь над названием абзаца, '¶' символ будет отображен. Это ссылка в этой на этот абзац и можете использовать его, чтобы скопировать #...
часть относительной ссылки на якорь.
Для создания ссылки на SubWiki-статью просто используйте '/':
WikiPage/SubWikiPage или ./SubWikiPage
Для создания ссылки с SubWiki-статьи на родительскую, просто используйте '..':
[..]
Для ссылки с SubWiki-статьи на соседнюю по уровню статью, используйте '../':
[../Sibling см. следующего "Брата"]
(Изменения с 0.11) Заметьте, что в Trac 0.10, использовавшем например `newticket могло работать для ссылки на /newticket верхнего уровня URL, но теперь в 0.11, останется на том же уровне (wiki namespace — пространство имен) и ссылается на страницу "брата". Смотри #Server-relativelinks по новому синтаксису.
source: links
По умолчанию ссылки source:/some/path открывают браузер репозитория, если путь указывает на каталог. Иначе открывается просмотр истории изменений файла. Есть возможность ссылаться прямо на заданную ревизию файла: source:/some/file#123 или сразу на последнюю ревизию: source:/some/file#latest
Где используются TracLinks
Вы можете использовать их в:
- Сообщениях коммитов (в Subversion)
- Страницах Wiki
- Полных описаниях карточек, отчётах и этапах
а также в любом другом текстовом поле, для которого указана поддержка WikiFormatting.
Запрет автоматической генерации ссылок TracLinks
Во избежание обработки TracLink как ссылок вы можете предварять их символом '!' (знак восклицания). Например:
!НеНадоСсылок. ![42] никуда не ссылается.
Покажет:
НеНадоСсылок. [42] никуда не ссылается.
See also: WikiFormatting, TracWiki
See also (russian): TracTermsRu
Статья на основе TracLinksRu