Update doc for TortoiseGitMerge
[TortoiseGit.git] / doc / source / en / TortoiseMerge / tme_dug_controls.xml
blobc197e9602edd7030b0111c7aeac0ceb72989e648
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE chapter SYSTEM "../../dtd/dblite.dtd">\r
3 <sect1 id="tmerge-dug-toolbar">\r
4         <title>Buttons and Other Controls</title>\r
5         <para>\r
6                 <figure id="tmerge-dug-dia-toolbar">\r
7                         <title>The Toolbar</title>\r
8                         <graphic fileref="images/TMerge_Toolbar.png"/>\r
9                 </figure>\r
10                 Below the menu bar lies the tool bar. This provides easy access to\r
11                 the most commonly used tools, which are\r
12                 <itemizedlist>\r
13                         <listitem>\r
14                                 <para>\r
15                                         <guibutton>Open</guibutton>\r
16                                         accesses the file-open dialog. What else?\r
17                                 </para>\r
18                         </listitem>\r
19                         <listitem>\r
20                                 <para>\r
21                                         <guibutton>Save</guibutton>\r
22                                         saves any changes you have made.\r
23                                 </para>\r
24                         </listitem>\r
25                         <listitem>\r
26                                 <para>\r
27                                         <guibutton>Reload</guibutton>\r
28                                         discards any changes you have made in TortoiseGitMerge and\r
29                                         reloads the files from disk.\r
30                                 </para>\r
31                         </listitem>\r
32                         <listitem>\r
33                                 <para>\r
34                                         <guibutton>Undo</guibutton>\r
35                                         implements a multi-level undo, allowing you to reverse\r
36                                         any changes you have made within TortoiseGitMerge.\r
37                                 </para>\r
38                         </listitem>\r
39                         <listitem>\r
40                                 <para>\r
41                                         <guibutton>Prev/Next Difference</guibutton>\r
42                                         jumps directly to the next point where the files differ.\r
43                                         This saves scrolling through all the unchanged parts\r
44                                         of the file.\r
45                                 </para>\r
46                                 <para>\r
47                                         When you do this in 2-pane diff mode, the detail bar at\r
48                                         the bottom of the screen will show you the inline differences\r
49                                         for the first line, regardless of where the mouse is hovering.\r
50                                 </para>\r
51                         </listitem>\r
52                         <listitem>\r
53                                 <para>\r
54                                         <guibutton>Prev/Next Conflict</guibutton>\r
55                                         jumps directly to the next point where the file\r
56                                         differences are in conflict and need to be resolved.\r
57                                 </para>\r
58                         </listitem>\r
59                         <listitem>\r
60                                 <para>\r
61                                         <guibutton>Use Theirs/Use Mine</guibutton>\r
62                                         selects whether to use a block from the left\r
63                                         or the right pane.\r
64                                         Refer to the next section for more information about\r
65                                         editing changes and conflicts.\r
66                                 </para>\r
67                         </listitem>\r
68                         <listitem>\r
69                                 <para>\r
70                                         <guibutton>Theirs before Mine/Mine before Theirs</guibutton>\r
71                                         is used when you want to combine changes in a conflicted file.\r
72                                         Refer to the next section for more information about\r
73                                         editing changes and conflicts.\r
74                                 </para>\r
75                         </listitem>\r
76                         <listitem>\r
77                                 <para>\r
78                                         <guibutton>Mark as Resolved</guibutton>\r
79                                         When you have resolved all the conflicts in a file and\r
80                                         saved the changes, you can mark it as resolved from\r
81                                         within TortoiseGitMerge, rather than going back to\r
82                                         explorer and marking as resolved from there.\r
83                                 </para>\r
84                         </listitem>\r
85                         <listitem>\r
86                                 <para>\r
87                                         <guibutton>Show Whitespaces</guibutton>\r
88                                         toggles the option to display space and tab characters\r
89                                         as symbols so you can distinguish white space changes.\r
90                                 </para>\r
91                         </listitem>\r
92                         <listitem>\r
93                                 <para>\r
94                                         <guibutton>Inline Diff Word-wise</guibutton>\r
95                                         toggles the method used to display inline diffs.\r
96                                         In word-wise mode, when a character is changed, the whole\r
97                                         word is highlighted. In char-wise mode, each individual\r
98                                         changed character is highlighted.\r
99                                 </para>\r
100                                 <para>\r
101                                         Word-wise is the default and in most cases it works better.\r
102                                         For example if you change a variable name, the whole name\r
103                                         is highlighted in word-wise mode, whereas in char-wise mode\r
104                                         you tend to get a mess of added and deleted characters\r
105                                         which doesn't make much sense. However, some content does\r
106                                         not resolve neatly into words, for example a hex file,\r
107                                         and in that case, char-wise display works better.\r
108                                 </para>\r
109                         </listitem>\r
110                         <listitem>\r
111                                 <para>\r
112                                         <guibutton>Switch View</guibutton>\r
113                                         selects between one-pane and two-pane view.\r
114                                         Disabled in 3-pane view.\r
115                                 </para>\r
116                         </listitem>\r
117                         <listitem>\r
118                                 <para>\r
119                                         <guibutton>Switch Left and Right View</guibutton>\r
120                                         In 2-pane view, swaps the left and right windows.\r
121                                         When you are comparing a file in 2 different trees, \r
122                                         as opposed to 2 revisions of the same file, TortoiseGit\r
123                                         does not know which one should go in the left pane as\r
124                                         the <quote>original/base</quote> version. If it gets\r
125                                         this wrong, you can change it to make viewing easier.\r
126                                 </para>\r
127                         </listitem>\r
128                         <listitem>\r
129                                 <para>\r
130                                         <guibutton>Show/Hide Patch List</guibutton>\r
131                                         When TortoiseGitMerge has a patch list, this button allows\r
132                                         you to hide it (so you can see both windows), or show it\r
133                                         (so you can review the file list).\r
134                                 </para>\r
135                         </listitem>\r
136                         <listitem>\r
137                                 <para>\r
138                                         <guibutton>Settings</guibutton>\r
139                                         takes you to TortoiseGitMerge's settings dialog.\r
140                                 </para>\r
141                         </listitem>\r
142                 </itemizedlist>\r
143         </para>\r
144         <para>\r
145                 On the left side of the window is a locator bar. This provides\r
146                 a quick visual reference as to where the changes lie within the\r
147                 file. The bar has three columns. The left column refers to the\r
148                 left pane, the right column to the right pane, and the centre\r
149                 column to the bottom pane (if present). In one-pane view only\r
150                 the left column is used. The locator bar can also be used as a\r
151                 scroll bar to scroll all the windows simultaneously.\r
152         </para>\r
153         <para>\r
154                 Below the bottom window is the status bar. This shows the number of\r
155                 lines added and deleted in <literal>Theirs</literal> and\r
156                 <literal>Mine</literal>, and the number of unresolved\r
157                 conflicts remaining.\r
158                 You can also see which line-ending style is in use, what\r
159                 encoding (ASCII, UTF-8, etc) is assumed by TortoiseGitMerge, and whether\r
160                 there is a byte-order-mark (BOM) present in UTF-8 files.\r
161                 The left side of the status bar is used to display hints when you\r
162                 hover the mouse over a control.\r
163         </para>\r
164 </sect1>\r