| blob | 65501d58390689c35629f27151e221acbcee4af1 |
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE sect1 SYSTEM "../../../dtd/dblite.dtd">\r
3 <sect1 id="tsvn-dug-repoviewer">\r
4 <title>Integration with Web-based Repository Viewers</title>\r
5 <indexterm>\r
6 <primary>web view</primary>\r
7 </indexterm>\r
8 <indexterm>\r
9 <primary>repo viewer</primary>\r
10 </indexterm>\r
11 <indexterm>\r
12 <primary>ViewVC</primary>\r
13 </indexterm>\r
14 <indexterm>\r
15 <primary>WebSVN</primary>\r
16 </indexterm>\r
17 <para>\r
18 There are several web-based repository viewers available for use with\r
19 Git such as\r
20 <ulink url="http://www.viewvc.org/">\r
21 <citetitle>ViewVC</citetitle>\r
22 </ulink>\r
23 and \r
24 <ulink url="http://websvn.tigris.org/">\r
25 <citetitle>WebSVN</citetitle>\r
26 </ulink>.\r
27 TortoiseGit provides a means to link with these viewers.\r
28 </para>\r
29 <para>\r
30 You can integrate a repo viewer of your choice in TortoiseGit.\r
31 To do this, you have to define some properties which define the linkage.\r
32 They must be set on Folders: (<xref linkend="tsvn-dug-propertypage"/>)\r
33 </para>\r
34 <para>\r
35 <variablelist>\r
36 <varlistentry>\r
37 <term condition="pot">webviewer:revision</term>\r
38 <listitem>\r
39 <para>\r
40 Set this property to the URL of your repo viewer to view all\r
41 changes in a specific revision.\r
42 It must be properly URI encoded and it has to contain\r
43 <literal>%REVISION%</literal>.\r
44 <literal>%REVISION%</literal> is replaced with the revision\r
45 number in question.\r
46 This allows TortoiseGit to display a context menu entry in the\r
47 log dialog\r
48 <menuchoice>\r
49 <guimenu>Context Menu</guimenu>\r
50 <guimenuitem>View revision in webviewer</guimenuitem>\r
51 </menuchoice>\r
52 </para>\r
53 </listitem>\r
54 </varlistentry>\r
55 <varlistentry>\r
56 <term condition="pot">webviewer:pathrevision</term>\r
57 <listitem>\r
58 <para>\r
59 Set this property to the URL of your repo viewer to view\r
60 changes to a specific file in a specific revision.\r
61 It must be properly URI encoded and it has to contain\r
62 <literal>%REVISION%</literal> and <literal>%PATH%</literal>.\r
63 <literal>%PATH%</literal> is replaced with the path relative\r
64 to the repository root.\r
65 This allows TortoiseGit to display a context menu entry in the\r
66 log dialog\r
67 <menuchoice>\r
68 <guimenu>Context Menu</guimenu>\r
69 <guimenuitem>View revision and path in webviewer</guimenuitem>\r
70 </menuchoice>\r
71 For example, if you right-click in the log dialog bottom pane\r
72 on a file entry <literal>/trunk/src/file</literal> then the\r
73 <literal>%PATH%</literal> in the URL will be replaced with\r
74 <literal>/trunk/src/file</literal>.\r
75 </para>\r
76 </listitem>\r
77 </varlistentry>\r
78 </variablelist>\r
79 </para>\r
80 <para>\r
81 You can also use relative URLs instead of absolute ones. This is useful\r
82 in case your web viewer is on the same domain/server as your source\r
83 repository. In case the domain name ever changes, you don't have to adjust\r
84 the <literal>webviewer:revision</literal> and <literal>webviewer:pathrevision</literal> \r
85 property. The format is the same as for the <literal>bugtraq:url</literal> property.\r
86 See <xref linkend="tsvn-dug-bugtracker"/>.\r
87 </para>\r
88 <important>\r
89 <title>Set the Properties on Folders</title>\r
90 <para>\r
91 These properties must be set on folders for the system to work. \r
92 When you commit a file or folder the properties are read from that folder.\r
93 If the properties are not found there, TortoiseGit will search upwards\r
94 through the folder tree to find them until it comes to an unversioned\r
95 folder, or the tree root (eg. <literal>C:\</literal>) is found.\r
96 If you can be sure that each user checks out only from e.g\r
97 <filename>trunk/</filename> and not some sub-folder, then it's enough if\r
98 you set the properties on <filename>trunk/</filename>.\r
99 If you can't be sure, you should set the properties recursively\r
100 on each sub-folder.\r
101 A property setting deeper in the project hierarchy overrides settings on\r
102 higher levels (closer to <filename>trunk/</filename>).\r
103 </para>\r
104 <para>\r
105 For <literal>tsvn:</literal> properties <emphasis>only</emphasis>\r
106 you can use the <guilabel>Recursive</guilabel> checkbox to set\r
107 the property to all sub-folders in the hierarchy, without also\r
108 setting it on all files.\r
109 </para>\r
110 </important>\r
111 <tip>\r
112 <title>No Repo Viewer Links from Repository Browser</title>\r
113 <para>\r
114 Because the repo viewer integration depends upon accessing Git\r
115 properties, you will only see the results when using a checked\r
116 out working copy. Fetching properties remotely is a slow operation,\r
117 so you will not see this feature in action from the repo browser.\r
118 </para>\r
119 </tip>\r
120 </sect1>\r