Changes between Version 1 and Version 2 of TracLinks
- Timestamp:
- Jun 21, 2008, 6:11:58 PM (16 years ago)
Legend:
- Unmodified
- Added
- Removed
- Modified
-
TracLinks
v1 v2 1 = Trac リンク=2 TracLinks は Trac の基礎となる機能です。というのも、 TracLinks によってシステムのエントリ間 - チケット、レポート、チェンジセット、Wikiページ、マイルストーン、ソースファイルなど - で簡単にハイパーリンクすることができるからです。1 = Trac Links = 2 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. 3 3 4 TracLinks は通常、 '''type:id''' (''id'' はコンポーネントの5 番号や名前、パス) の形式で記述しますが、よく使われるコンポーネントについては、 6 下の例のように表記を省略することもできます。 4 TracLinks are generally of the form '''type:id''' (where ''id'' represents the 5 number, name or path of the item) though some frequently used kinds of items 6 also have short-hand notations. 7 7 8 例:9 * チケット: '''!#1''' or '''!ticket:1'''10 * チケットのコメント: '''!comment:ticket:1:2'''11 * レポート: '''!{1}''' or '''!report:1'''12 * チェンジセット: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk'''13 * リビジョンログ: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3'''14 * Diffs ( [http://trac.edgewall.org/milestone/0.10 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'''15 * Wiki ページ: '''CamelCase''' or '''!wiki:CamelCase'''16 * マイルストーン: '''!milestone:1.0'''17 * 添付ファイル: '''!attachment:ticket:944:attachment.1073.diff'''18 * ファイル: '''!source:trunk/COPYING'''19 * あるリビジョンのファイル: '''!source:/trunk/COPYING#200'''20 * あるリビジョンのファイルのある行数: '''!source:/trunk/COPYING@200#L25'''21 表示:22 * チケット: #1 or ticket:123 * チケットのコメント: comment:ticket:1:224 * レポート: {1} or report:125 * チェンジセット: r1, [1], changeset:1, or (restricted) [1/trunk], changeset:1/trunk26 * リビジョンログ: r1:3, [1:3] or log:@1:3, log:trunk@1:327 * Diffs ( [http://trac.edgewall.org/milestone/0.10 0.10] 以降): diff:@20:30, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default or diff:trunk/trac@3538//sandbox/vc-refactoring/trac@353928 * Wiki ページ: CamelCase or wiki:CamelCase29 * マイルストーン: milestone:1.030 * 添付ファイル: attachment:ticket:944:attachment.1073.diff31 * ファイル: source:trunk/COPYING32 * あるリビジョンのファイル: source:/trunk/COPYING#20033 * あるリビジョンのファイルのある行数: source:/trunk/COPYING@200#L258 Some examples: 9 * Tickets: '''!#1''' or '''!ticket:1''' 10 * Ticket comments: '''!comment:ticket:1:2''' 11 * Reports: '''!{1}''' or '''!report:1''' 12 * Changesets: '''!r1''', '''![1]''', '''!changeset:1''' or (restricted) '''![1/trunk]''', '''!changeset:1/trunk''' 13 * Revision log: '''!r1:3''', '''![1:3]''' or '''!log:@1:3''', '''!log:trunk@1:3''' 14 * Diffs (requires [milestone:0.10 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''' 15 * Wiki pages: '''!CamelCase''' or '''!wiki:CamelCase''' 16 * Milestones: '''!milestone:1.0''' 17 * Attachment: '''!attachment:ticket:944:attachment.1073.diff''' 18 * Files: '''!source:trunk/COPYING''' 19 * A specific file revision: '''!source:/trunk/COPYING@200''' 20 * A particular line of a specific file revision: '''!source:/trunk/COPYING@200#L25''' 21 Display: 22 * Tickets: #1 or ticket:1 23 * Ticket comments: comment:ticket:1:2 24 * Reports: {1} or report:1 25 * Changesets: r1, [1], changeset:1, or (restricted) [1/trunk], changeset:1/trunk 26 * Revision log: r1:3, [1:3] or log:@1:3, log:trunk@1:3 27 * Diffs (requires [milestone:0.10 0.10]): diff:@20:30, diff:tags/trac-0.9.2/wiki-default//tags/trac-0.9.3/wiki-default or diff:trunk/trac@3538//sandbox/vc-refactoring/trac@3539 28 * Wiki pages: CamelCase or wiki:CamelCase 29 * Milestones: milestone:1.0 30 * Attachment: attachment:ticket:944:attachment.1073.diff 31 * Files: source:trunk/COPYING 32 * A specific file revision: source:/trunk/COPYING@200 33 * A particular line of a specific file revision: source:/trunk/COPYING@200#L25 34 34 35 '''Note:''' wiki:CamelCase の書式が使われることはほとんどありませんが、36 ページ名が WikiPageNames のルールに従っていないページ (一文字、 37 アルファベット以外の文字、etc.) をリンクしたい場合には便利です。 38 WikiPageNames に Wiki ページ名へのリンクに関する特記事項が書いてあるので見て下さい。 35 '''Note:''' The wiki:CamelCase form is rarely used, but it can be convenient to refer to 36 pages whose names do not follow WikiPageNames rules, i.e., single words, 37 non-alphabetic characters, etc. See WikiPageNames for more about features specific 38 to links to Wiki page names. 39 39 40 フル表記の (簡略形でない) Trac リンクでは、次のようにしてリンクタイトルを 41 カスタマイズすることもできます:40 Trac links using the full (non-shorthand) notation can also be given a custom 41 link title like this: 42 42 43 43 {{{ 44 [ticket:1 これは1番目のチケットへのリンクです].44 [ticket:1 This is a link to ticket number one]. 45 45 }}} 46 46 47 表示: [ticket:1 これは1番目のチケットへのリンクです].47 Display: [ticket:1 This is a link to ticket number one]. 48 48 49 タイトルが省略された場合、 ID のみ(コロンの後ろ側)が表示されます。 49 If the title is be omitted, only the id (the part after the colon) is displayed: 50 50 51 51 {{{ … … 53 53 }}} 54 54 55 表示: [ticket:1]55 Display: [ticket:1] 56 56 57 もし名前空間の一部が省略されていたら、 `wiki` がデフォルトの値です。(''バージョン 0.10 以降''):57 `wiki` is the default if the namespace part of a full link is omitted (''since version 0.10''): 58 58 59 59 {{{ … … 61 61 }}} 62 62 63 表示: [SandBox the sandbox]63 Display: [SandBox the sandbox] 64 64 65 TracLinks はとてもシンプルなアイディアですが、実際にはとても複雑な情報網になっています。実際、使う分にはとても直感的で簡単ですし、 "リンクの追跡" がプロジェクトでおこったことやなぜある事象が起こったのかを理解するのにとても役に立ちます。65 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. 66 66 67 以下に示すセクションは特定のリンクの種類の詳細について記述しています。 TracLinks の上級者向けの使用方法も同時に記述します。 67 The following sections describe the individual link types in detail, as well as several notes advanced usage of links. 68 68 69 == attachment: リンク==69 == attachment: links == 70 70 71 添付ファイルへのリンクのシンタックスは次に示すとおりです:72 * !attachment:the_file.txt は、現在のオブジェクトに添付されたファイル the_file.txt へのリンクを生成します。73 * !attachment:wiki:MyPage:the_file.txt は、 Wiki ページ !MyPage に添付されたファイル the_file.txt へのリンクを生成します。74 * !attachment:ticket:753:the_file.txt は、チケット 753 に添付されたファイル the_file.txt へのリンクを生成します。71 The link syntax for attachments is as follows: 72 * !attachment:the_file.txt creates a link to the attachment the_file.txt of the current object 73 * !attachment:wiki:MyPage:the_file.txt creates a link to the attachment the_file.txt of the !MyPage wiki page 74 * !attachment:ticket:753:the_file.txt creates a link to the attachment the_file.txt of the ticket 753 75 75 76 == ソースファイルへのリンク==76 == source: links == 77 77 78 source:/some/path 形式のリンクは、パスがディレクトリを示しているならば 79 ディレクトリブラウザを開き、それ以外の場合はリビジョンログを表示します。 80 また、source:/some/file@123 のように表記することで、特定のリビジョンにリンクしたり、 81 source:/some/file@latest で、最新のリビジョンにリンクすることもできます。 82 リビジョンを特定している場合、 !source:/some/file@123#L10 の書式で特定の行にリンクすることができます。 78 The default behavior for a source:/some/path link is to open the directory browser 79 if the path points to a directory and otherwise open the log view. 80 It's also possible to link directly to a specific revision of a file like this: source:/some/file@123 81 or like this to link to the latest revision: source:/some/file@latest. 82 If the revision is specified, one can even link to a specific line number: source:/some/file@123#L10 83 83 84 == search: リンクと query: リンク==84 == search: and query: links == 85 85 86 [wiki:TracSearch#リンク検索 "TracSearch#リンク検索"] と [wiki:TracQuery#TracLinksを使用する "TracQuery#TracLinks を使用する"] 参照。 86 See TracSearch#SearchLinks and TracQuery#UsingTracLinks 87 87 88 == !SubWiki リンク==89 !SubWiki ページへ !SubWiki リンクするには '/' を使います。:88 == !SubWiki links == 89 To create a SubWiki link to a SubWiki-page just use a '/': 90 90 {{{ 91 91 [wiki:WikiPage/SubWikiPage]. 92 92 }}} 93 93 94 == InterWiki リンク==94 == InterWiki links == 95 95 96 他に、プレフィックスを自由に定義して、他の Web アプリケーションのリソースをポイントさせることができます。プレフィックスと対応する Web アプリケーションの URL の定義は特殊な Wiki ページ、 InterMapTxt ページで定義されます。 他の TracEnvironment へのリンクを作ることもできますが、より柔軟に他の TracEnvironment を指す特別な方法があることを覚えておいてください。 96 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. 97 97 98 == InterTrac リンク==98 == InterTrac links == 99 99 100 上記の TracLinks はすべて一つの TracEnvironment におけるものでした。他の TracEnvironment をあらわすプレフィックスにコロンを付けたものを TracLinks につけると、実際に他の TracEnvironment に存在するリソースを参照します。他の TracEnvironment は登録しなければなりません。詳しくは InterTrac を参照して下さい。 100 Any 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. 101 101 102 102 103 == サーバ上の相対リンク==103 == Server-relative links == 104 104 105 サーバ上の静的コンテンツや、 `/register` ページ(訳注:一般的なアカウント登録用ページをあらわしています) 106 など、 Trac リンク機能自体ではリンクを生成できないような同じサーバ上のオブジェクトにリンクすることが出来たら便利なこともあるでしょう。 107 サーバのルートからの絶対パスか 108 現在のページの URL からの相対リンクを指定するだけで、そのようなことを実現出来るようになりました:105 It is often useful to be able to link to objects on your server that have no built-in 106 Trac linking mechanism, such as static resources, a `/register` page, etc. This 107 can be achieved by simply using either an absolute path from the server root, 108 or a relative link from the URL of the current page: 109 109 110 110 {{{ … … 113 113 }}} 114 114 115 表示: [../newticket newticket] [/ home]115 Display: [../newticket newticket] [/ home] 116 116 117 == Trac リンクで空白文字をエスケープする==117 == Quoting space in TracLinks == 118 118 119 TracLinks のプレフィックスの後ろにスペースを含んだターゲットがある場合、 120 シングルクォーテーションかダブルクォーテーションで囲みます。 121 例:119 Immediately after a TracLinks prefix, targets containing space characters should 120 be enclosed in a pair of quotes or double quotes. 121 Examples: 122 122 * !wiki:"The whitespace convention" 123 * !attachment:'the file.txt' もしくは123 * !attachment:'the file.txt' or 124 124 * !attachment:"the file.txt" 125 125 * !attachment:"ticket:123:the file.txt" 126 126 127 == TracLinks が使えるところ==128 TracLinks が使えるのは:127 == Where to use TracLinks == 128 You can use TracLinks in: 129 129 130 * ソースコード (Subverison) のコミットメッセージ131 * Wiki ページ132 * チケット、レポート、マイルストーンでの説明記述箇所130 * Source code (Subversion) commit messages 131 * Wiki pages 132 * Full descriptions for tickets, reports and milestones 133 133 134 その他、 WikiFormatting を利用可能なことが明示されているすべてのテキストフィールド。 134 and any other text fields explicitly marked as supporting WikiFormatting. 135 135 136 == リンクの無効化==136 == Escaping Links == 137 137 138 !TracLinks を無効化するには、先頭に '!' (エクスクラメーションマーク)を付けます。 138 To prevent parsing of a !TracLink, you can escape it by preceding it with a '!' (exclamation mark). 139 139 {{{ 140 140 !NoLinkHere. … … 142 142 }}} 143 143 144 表示:144 Display: 145 145 !NoLinkHere. 146 146 ![42] is not a link either.