Changes between Version 1 and Version 2 of TracLinks


Игнорировать:
Время:
29 мар. 2007 г., 17:21:04 (19 лет назад)
Автор:
Alexey Derkachev
Комментарий:

--

Обозначения:

Без изменений
Добавлено
Удалено
Изменено

  • TracLinks

    v1 v2  
    1 = Trac Links =
    2 [[TracGuideToc]]
     1= Трек Ссылки =
     2TracLinks фундаментальная особенность Трека, они позволяют легко ссылаться между объектами в системе, на такие как заявки, отчёты, изменения, страницы Wiki, вехи и различные файлы используя WikiFormatting.
    33
    4 TracLinks are a fundamental feature of Trac, because they allow easy hyperlinking between the various entities in the system—such as tickets, reports, changesets, Wiki pages, milestones, and source files—from anywhere WikiFormatting is used.
     4TracLinks в основном представляет форму в виде '''type:id''' (где ''id'' это число, имя или путь к объекту), хотя часто используется короткая нотация.
    55
    6 TracLinks are generally of the form '''type:id''' (where ''id'' represents the
    7 number, name or path of the item) though some frequently used kinds of items
    8 also have short-hand notations.
     6Несколько примеров:
     7 * Заявка: '''!#1''' или '''!ticket:1'''
     8 * Коментарий к заявке: '''!comment:ticket:1:2'''
     9 * Отчёт: '''!{1}''' или '''!report:1'''
     10 * Изменения: '''!r1''', '''![1]''', '''!changeset:1''' или (ограниченно) '''![1/trunk]''', '''!changeset:1/trunk'''
     11 * Лог ревизий: '''!r1:3''', '''![1:3]''' или '''!log:@1:3''', '''!log:trunk@1:3'''
     12 * Отличия (требует [milestone:0.10 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'''
     13 * Страницы Wiki: '''!CamelCase''' или '''!wiki:CamelCase'''
     14 * Вехи: '''!milestone:1.0'''
     15 * Вложения: '''!attachment:ticket:944:attachment.1073.diff'''
     16 * Файлы: '''!source:trunk/COPYING'''
     17 * Файл с заданной ревизией: '''!source:/trunk/COPYING@200'''
     18 * Линия в заданном файле: '''!source:/trunk/COPYING@200#L25'''
     19Будут отображать:
     20 * Заявки: #1 or ticket:1
     21 * Комментарии к заявке: comment:ticket:1:2
     22 * Отчеты: {1} или report:1
     23 * Изменения: r1, [1], changeset:1, или (restricted) [1/trunk], changeset:1/trunk
     24 * Лог ревизий: r1:3, [1:3] или log:@1:3, log:trunk@1:3
     25 * Отличия (requires [milestone:0.10 0.10]): diff:@20:30, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default или diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539
     26 * Страницы Wiki: CamelCase или wiki:CamelCase
     27 * Вехи: milestone:1.0
     28 * Вложения: attachment:ticket:944:attachment.1073.diff
     29 * Файлы: source:trunk/COPYING
     30 * Файл с заданной ревизией: source:/trunk/COPYING@200
     31 * Линия в заданном файле с заданной ревизией: source:/trunk/COPYING@200#L25
     32
     33'''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
     34pages whose names do not follow WikiPageNames rules, i.e., single words,
     35non-alphabetic characters, etc. See WikiPageNames for more about features specific
     36to links to Wiki page names.
     37
     38Trac links using the full (non-shorthand) notation can also be given a custom
     39link title like this:
     40
     41{{{
     42[ticket:1 This is a link to ticket number one].
     43}}}
     44
     45Display: [ticket:1 This is a link to ticket number one].
     46
     47If the title is be omitted, only the id (the part after the colon) is displayed:
     48
     49{{{
     50[ticket:1]
     51}}}
     52
     53Display: [ticket:1]
     54
     55`wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''):
     56
     57{{{
     58[SandBox the sandbox]
     59}}}
     60
     61Display: [SandBox the sandbox]
     62
     63TracLinks are a very simple idea, but actually allow quite a complex network of information. In practice, it's very intuitive and simple to use, and we've found the "link trail" extremely helpful to better understand what's happening in a project or why a particular change was made.
     64
     65The following sections describe the individual link types in detail, as well as several notes advanced usage of links.
     66
     67== attachment: links ==
     68
     69The link syntax for attachments is as follows:
     70 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
     71 * !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page
     72 * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753
     73
     74== source: links ==
     75
     76The default behavior for a source:/some/path link is to open the directory browser
     77if the path points to a directory and otherwise open the log view.
     78It's also possible to link directly to a specific revision of a file like this: source:/some/file@123
     79or like this to link to the latest revision: source:/some/file@latest.
     80If the revision is specified, one can even link to a specific line number: source:/some/file@123#L10
     81
     82== search: and query: links ==
     83
     84See TracSearch#SearchLinks and TracQuery#UsingTracLinks
     85
     86== !SubWiki links ==
     87To create a SubWiki link to a SubWiki-page just use a '/':
     88{{{
     89 [wiki:WikiPage/SubWikiPage].
     90}}}
     91
     92== InterWiki links ==
     93
     94Other prefixes can be defined freely and made to point to resources in other Web applications. The definition of those prefixes as well as the URLs of the corresponding Web applications is defined in a special Wiki page, the InterMapTxt page. Note that while this could be used to create links to other Trac environments, there's a more specialized way to register other Trac environments which offers greater flexibility.
     95
     96== InterTrac links ==
     97
     98Any of the above form of Trac links could be written in one Trac environment and actually refer to resources present in another Trac environment, provided the Trac link is prefixed by the name of that other Trac environment followed by a colon. That other Trac environment must be registered. See InterTrac for details.
     99
     100
     101== Server-relative links ==
     102
     103It is often useful to be able to link to objects on your server that have no built-in
     104Trac linking mechanism, such as static resources, a `/register` page, etc. This
     105can be achieved by simply using either an absolute path from the server root,
     106or a relative link from the URL of the current page:
     107
     108{{{
     109[../newticket newticket]
     110[/ home]
     111}}}
     112
     113Display: [../newticket newticket] [/ home]
     114
     115== Quoting space in TracLinks ==
     116
     117Immediately after a TracLinks prefix, targets containing space characters should
     118be enclosed in a pair of quotes or double quotes.
     119Examples:
     120 * !wiki:"The whitespace convention"
     121 * !attachment:'the file.txt' or
     122 * !attachment:"the file.txt"
     123 * !attachment:"ticket:123:the file.txt"
    9124
    10125== Where to use TracLinks ==
    … …  
    17132and any other text fields explicitly marked as supporting WikiFormatting.
    18133
    19 == Overview ==
    20 
    21 ||= Wiki Markup =||= Display =||
    22 {{{#!td
    23  Wiki pages :: `CamelCase` or `wiki:CamelCase`
    24  Parent page :: `[..]`
    25  Tickets :: `#1` or `ticket:1`
    26  Ticket comments :: `comment:1:ticket:2`
    27  Reports :: `{1}` or `report:1`
    28  Changesets :: `r1`, `[1]`, `changeset:1` or (restricted) `[1/trunk]`, `changeset:1/trunk`
    29  Revision log :: `r1:3`, `[1:3]` or `log:@1:3`, `log:trunk@1:3`, `[2:5/trunk]`
    30  Diffs :: `diff:@1:3`, `diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default`
    31           or `diff:trunk/trac@3538//sandbox/vc-refactoring@3539`
    32  Milestones :: `milestone:1.0`
    33  Attachment :: `attachment:example.tgz` (for current page attachment), `attachment:attachment.1073.diff:ticket:944` (absolute path)
    34  Files :: `source:trunk/COPYING`
    35  A specific file revision :: `source:/trunk/COPYING@200`
    36  A particular line of a specific file revision :: `source:/trunk/COPYING@200#L25`
    37 }}}
    38 {{{#!td
    39  Wiki pages :: CamelCase or wiki:CamelCase
    40  Parent page :: [..]
    41  Tickets :: #1 or ticket:1
    42  Ticket comments :: comment:1:ticket:2
    43  Reports :: {1} or report:1
    44  Changesets :: r1, [1], changeset:1 or (restricted) [1/trunk], changeset:1/trunk
    45  Revision log :: r1:3, [1:3] or log:@1:3, log:trunk@1:3, [2:5/trunk]
    46  Diffs :: diff:@1:3, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default
    47           or diff:trunk/trac@3538//sandbox/vc-refactoring@3539
    48  Milestones :: milestone:1.0
    49  Attachment :: attachment:example.tgz (for current page attachment), attachment:attachment.1073.diff:ticket:944 (absolute path)
    50  Files :: source:trunk/COPYING
    51  A specific file revision :: source:/trunk/COPYING@200
    52  A particular line of a specific file revision :: source:/trunk/COPYING@200#L25
    53 }}}
    54 
    55 '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to
    56 pages whose names do not follow WikiPageNames rules, i.e., single words,
    57 non-alphabetic characters, etc. See WikiPageNames for more about features specific
    58 to links to Wiki page names.
    59 
    60 
    61 {{{#!table class=""
    62 |||| Trac links using the full (non-shorthand) notation can also be given a custom link title like this: ||
    63 {{{#!td
    64 {{{
    65 [ticket:1 This is a link to ticket number one] or
    66 [[ticket:1|This is another link to ticket number one]].
    67 }}}
    68 }}}
    69 {{{#!td
    70 [ticket:1 This is a link to ticket number one] or
    71 [[ticket:1|This is another link to ticket number one]].
    72 }}}
    73 |--------------------------------------------------------------------------------------
    74 |||| If the title is omitted, only the id (the part after the colon) is displayed:  ||
    75 {{{#!td
    76 {{{
    77 [ticket:1] or [[ticket:2]]
    78 }}}
    79 }}}
    80 {{{#!td
    81 [ticket:1] or [[ticket:2]]
    82 }}}
    83 |--------------------------------------------------------------------------------------
    84 |||| `wiki` is the default if the namespace part of a full link is omitted:  ||
    85 {{{#!td
    86 {{{
    87 [SandBox the sandbox] or
    88 [[SandBox|the sandbox]]
    89 }}}
    90 }}}
    91 {{{#!td
    92 [SandBox the sandbox] or
    93 [[SandBox|the sandbox]]
    94 }}}
    95 |--------------------------------------------------------------------------------------
    96 |||| The short form ''realm:target'' can also be wrapped within a <...> pair, [[br]] which allow for arbitrary characters (i.e. anything but >)  ||
    97 {{{#!td
    98 {{{
    99 <wiki:Strange(page@!)>
    100 }}}
    101 }}}
    102 {{{#!td
    103 <wiki:Strange(page@!)>
    104 }}}
    105 }}}
    106 
    107 TracLinks are a very simple idea, but actually allow quite a complex network of information. In practice, it's very intuitive and simple to use, and we've found the "link trail" extremely helpful to better understand what's happening in a project or why a particular change was made.
    108 
    109 
    110 == Advanced use of TracLinks ==
    111 
    112 === Relative links ===
    113 
    114 To create a link to a specific anchor in a page, use '#':
    115 {{{
    116  [#Relativelinks relative links] or [[#Relativelinks|relative links]]
    117 }}}
    118 Displays:
    119   [#Relativelinks relative links] or [[#Relativelinks|relative links]]
    120 
    121 Hint: when you move your mouse over the title of a section, a '¶' character will be displayed. This is a link to that specific section and you can use this to copy the `#...` part inside a relative link to an anchor.
    122 
    123 To create a link to a [trac:SubWiki SubWiki]-page just use a '/':
    124 {{{
    125  WikiPage/SubWikiPage or ./SubWikiPage
    126 }}}
    127 
    128 To link from a [trac:SubWiki SubWiki] page to a parent, simply use a '..':
    129 {{{
    130   [..] or [[..]]
    131 }}}
    132   [..] or [[..]]
    133 
    134 To link from a [trac:SubWiki SubWiki] page to a [=#sibling sibling] page, use a '../':
    135 {{{
    136   [../Sibling see next sibling] or [[../Sibling|see next sibling]]
    137 }}}
    138   [../Sibling see next sibling] or [[../Sibling|see next sibling]]
    139 
    140 But in practice you often won't need to add the `../` prefix to link to a sibling page.
    141 For resolving the location of a wiki link, it's the target page closest in the hierarchy
    142 to the page where the link is written which will be selected. So for example, within
    143 a sub-hierarchy, a sibling page will be targeted in preference to a toplevel page.
    144 This makes it easy to copy or move pages to a sub-hierarchy by [[WikiNewPage#renaming|renaming]] without having to adapt the links.
    145 
    146 In order to link explicitly to a [=#toplevel toplevel] Wiki page,
    147 use the `wiki:/` prefix.
    148 Be careful **not** to use the `/` prefix alone, as this corresponds to the
    149 [#Server-relativelinks] syntax and with such a link you will lack the `/wiki/`
    150 part in the resulting URL.
    151 
    152 ''(Changed in 0.11)'' Note that in Trac 0.10, using e.g. `[../newticket]`  may have worked for linking to the `/newticket` top-level URL, but since 0.11, such a link will stay in the wiki namespace and therefore link to a sibling page.
    153 See [#Server-relativelinks] for the new syntax.
    154 
    155 === InterWiki links ===
    156 
    157 Other prefixes can be defined freely and made to point to resources in other Web applications. The definition of those prefixes as well as the URLs of the corresponding Web applications is defined in a special Wiki page, the InterMapTxt page. Note that while this could be used to create links to other Trac environments, there's a more specialized way to register other Trac environments which offers greater flexibility.
    158 
    159 === InterTrac links ===
    160 
    161 This can be seen as a kind of InterWiki link specialized for targeting other Trac projects.
    162 
    163 Any type of Trac link can be written in one Trac environment and actually refer to resources in another Trac environment. All that is required is to prefix the Trac link with the name of the other Trac environment followed by a colon. The other Trac environment must be registered on the InterTrac page.
    164 
    165 A distinctive advantage of InterTrac links over InterWiki links is that the shorthand form of Trac links (e.g. `{}`, `r`, `#`) can also be used. For example if T was set as an alias for Trac, links to Trac tickets can be written #T234, links to Trac changesets can be written [trac 1508].
    166 See InterTrac for the complete details.
    167 
    168 === Server-relative links ===
    169 
    170 It is often useful to be able to link to objects in your project that
    171 have no built-in Trac linking mechanism, such as static resources, `newticket`,
    172 a shared `/register` page on the server, etc.
    173 
    174 To link to resources inside the project, use either an absolute path from the project root,
    175 or a relative link from the URL of the current page (''Changed in 0.11''):
    176 
    177 {{{
    178 [/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
    179 [/ home] or [[/|home]]
    180 }}}
    181 
    182 Display: [/newticket Create a new ticket] or [[//newticket|Create a new ticket]]
    183 [/ home] or [[/|home]]
    184 
    185 To link to another location on the server (possibly outside the project but on the same host), use the `//` prefix (''Changed in 0.11''):
    186 
    187 {{{
    188 [//register Register Here] or [[//register|Register Here]]
    189 }}}
    190 
    191 Display: [//register Register Here] or [[//register|Register Here]]
    192 
    193 === Quoting space in TracLinks ===
    194 
    195 Immediately after a TracLinks prefix, targets containing space characters should
    196 be enclosed in a pair of quotes or double quotes.
    197 Examples:
    198  * !wiki:"The whitespace convention"
    199  * !attachment:'the file.txt' or
    200  * !attachment:"the file.txt"
    201  * !attachment:"the file.txt:ticket:123"
    202 
    203 Note that by using [trac:WikiCreole] style links, it's quite natural to write links containing spaces:
    204  * ![[The whitespace convention]]
    205  * ![[attachment:the file.txt]]
    206 
    207 === Escaping Links ===
     134== Escaping Links ==
    208135
    209136To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark).
    … …  
    217144 ![42] is not a link either.
    218145
    219 
    220 === Parameterized Trac links ===
    221 
    222 Many Trac resources have more than one way to be rendered, depending on some extra parameters. For example, a Wiki page can accept a `version` or a `format` parameter, a report can make use of dynamic variables, etc.
    223 
    224 Trac links can support an arbitrary set of parameters, written in the same way as they would be for the corresponding URL. Some examples:
    225  - `wiki:WikiStart?format=txt`
    226  - `ticket:1?version=1`
    227  - `[/newticket?component=module1 create a ticket for module1]`
    228  - `[/newticket?summary=Add+short+description+here create a ticket with URL with spaces]`
    229 
    230 
    231 == TracLinks Reference ==
    232 The following sections describe the individual link types in detail, as well as notes on advanced usage of links.
    233 
    234 === attachment: links ===
    235 
    236 The link syntax for attachments is as follows:
    237  * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object
    238  * !attachment:the_file.txt:wiki:MyPage creates a link to the attachment the_file.txt of the !MyPage wiki page
    239  * !attachment:the_file.txt:ticket:753 creates a link to the attachment the_file.txt of the ticket 753
    240 
    241 Note that the older way, putting the filename at the end, is still supported: !attachment:ticket:753:the_file.txt.
    242 
    243 If you'd like to create a direct link to the content of the attached file instead of a link to the attachment page, simply use `raw-attachment:` instead of `attachment:`.
    244 
    245 This can be useful for pointing directly to an HTML document, for example. Note that for this use case, you'd have to allow the web browser to render the content by setting `[attachment] render_unsafe_content = yes` (see TracIni#attachment-section). Caveat: only do that in environments for which you're 100% confident you can trust the people who are able to attach files, as otherwise this would open up your site to [wikipedia:Cross-site_scripting cross-site scripting] attacks.
    246 
    247 See also [#export:links].
    248 
    249 === comment: links ===
    250 
    251 When you're inside a given ticket, you can simply write e.g. !comment:3 to link to the third change comment.
    252 It is possible to link to a comment of a specific ticket from anywhere using one of the following syntax:
    253  - `comment:3:ticket:123`
    254  - `ticket:123#comment:3` (note that you can't write `#123#!comment:3`!)
    255 It is also possible to link to the ticket's description using one of the following syntax:
    256  - `comment:description` (within the ticket)
    257  - `comment:description:ticket:123`
    258  - `ticket:123#comment:description`
    259 
    260 === query: links ===
    261 
    262 See TracQuery#UsingTracLinks and [#ticket:links].
    263 
    264 === search: links ===
    265 
    266 See TracSearch#SearchLinks
    267 
    268 === ticket: links ===
    269  ''alias:'' `bug:`
    270 
    271 Besides the obvious `ticket:id` form, it is also possible to specify a list of tickets or even a range of tickets instead of the `id`. This generates a link to a custom query view containing this fixed set of tickets.
    272 
    273 Example:
    274  - `ticket:5000-6000`
    275  - `ticket:1,150`
    276 
    277 ''(since Trac 0.11)''
    278 
    279 === timeline: links ===
    280 
    281 Links to the timeline can be created by specifying a date in the ISO:8601 format. The date can be optionally followed by a time specification. The time is interpreted as being UTC time, but alternatively you can specify your local time, followed by your timezone if you don't want to compute the UTC time.
    282 
    283 Examples:
    284  - `timeline:2008-01-29`
    285  - `timeline:2008-01-29T15:48`
    286  - `timeline:2008-01-29T15:48Z`
    287  - `timeline:2008-01-29T16:48+01`
    288 
    289 ''(since Trac 0.11)''
    290 
    291 === wiki: links ===
    292 
    293 See WikiPageNames and [#QuotingspaceinTracLinks quoting space in TracLinks] above.
    294 
    295 === Version Control related links ===
    296 ==== source: links ====
    297  ''aliases:'' `browser:`, `repos:`
    298 
    299 The default behavior for a source:/some/path link is to open the browser in that directory directory
    300 if the path points to a directory or to show the latest content of the file.
    301 
    302 It's also possible to link directly to a specific revision of a file like this:
    303  - `source:/some/file@123` - link to the file's revision 123
    304  - `source:/some/file@head` - link explicitly to the latest revision of the file
    305 
    306 If the revision is specified, one can even link to a specific line number:
    307  - `source:/some/file@123#L10`
    308  - `source:/tag/0.10@head#L10`
    309 
    310 Finally, one can also highlight an arbitrary set of lines:
    311  - `source:/some/file@123:10-20,100,103#L99` - highlight lines 10 to 20, and lines 100 and 103.
    312    ''(since 0.11)''
    313 
    314 Note that in presence of multiple repositories, the name of the repository is simply integrated in the path you specify for `source:` (e.g. `source:reponame/trunk/README`). ''(since 0.12)''
    315 
    316 ==== export: links ====
    317 
    318 To force the download of a file in the repository, as opposed to displaying it in the browser, use the `export` link.  Several forms are available:
    319  * `export:/some/file` - get the HEAD revision of the specified file
    320  * `export:123:/some/file` - get revision 123 of the specified file
    321  * `export:/some/file@123` - get revision 123 of the specified file
    322 
    323 This can be very useful for displaying XML or HTML documentation with correct stylesheets and images, in case that has been checked in into the repository. Note that for this use case, you'd have to allow the web browser to render the content by setting `[browser] render_unsafe_content = yes` (see TracIni#browser-section), otherwise Trac will force the files to be downloaded as attachments for security concerns.
    324 
    325 If the path is to a directory in the repository instead of a specific file, the source browser will be used to display the directory (identical to the result of `source:/some/dir`).
    326 
    327 ==== log: links ====
    328 
    329 The `log:` links are used to display revision ranges. In its simplest form, it can link to the latest revisions of the specified path, but it can also support displaying an arbitrary set of revisions.
    330  - `log:/` - the latest revisions starting at the root of the repository
    331  - `log:/trunk/tools` - the latest revisions in `trunk/tools`
    332  - `log:/trunk/tools@10000` - the revisions in `trunk/tools` starting from  revision 10000
    333  - `log:@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795
    334  - `log:/trunk/tools@20788,20791:20795` - list revision 20788 and the revisions from 20791 to 20795 which affect the given path
    335 
    336 There are short forms for revision ranges as well:
    337  - `[20788,20791:20795]`
    338  - `[20788,20791:20795/trunk/tools]`
    339  - `r20791:20795` (but not `r20788,20791:20795` nor `r20791:20795/trunk`)
    340 
    341 Finally, note that in all of the above, a revision range can be written either as `x:y` or `x-y`.
    342 
    343 In the presence of multiple repositories, the name of the repository should be specified as the first part of the path, e.g. `log:repos/branches` or `[20-40/repos]`.
    344 
    345146----
    346147See also: WikiFormatting, TracWiki, WikiPageNames, InterTrac, InterWiki