Updated TortoiseMerge docs from TortoiseSVN source
[TortoiseGit.git] / doc / source / en / TortoiseMerge / tme_dug_settings.xml
blob8d96ace19512ba6a8993387fe383b12a19c1767b
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE chapter SYSTEM "../../dtd/dblite.dtd">\r
3 <sect1 id="tmerge-dug-settings">\r
4     <title>Settings</title>\r
5     <sect2 id="tmerge-dug-settings-main">\r
6         <title>Main Settings Page</title>\r
7         <?dbhh topicname="HIDD_SETMAINPAGE"?>\r
8         <figure id="tmerge-dug-dia-setmain">\r
9             <title>The Settings Main Page</title>\r
10             <graphic fileref="images/TMerge_SettingsGeneral.png"/>\r
11         </figure>\r
12         <para>\r
13             Most of the options here are self-explanatory, but a few\r
14             points need clarifying.\r
15         </para>\r
16         <para>\r
17             <guilabel>Backup original file</guilabel>\r
18             renames the original file in the WC to <literal>filename.bak</literal>\r
19             before saving the modified version.\r
20         </para>\r
21         <para>\r
22             <guilabel>Default to UTF-8 encoding</guilabel>\r
23             when set, ANSI files are loaded as UTF-8 encoded and saved as\r
24             such when edited.\r
25         </para>\r
26         <para>\r
27             <guilabel>Max line length for inline diffs</guilabel>\r
28             TortoiseGitMerge can get slow when showing inline diffs for\r
29             very long lines. Because of that only lines that are shorter\r
30             than 3000 chars are shown with inline diffs. You can change\r
31             this value here.\r
32         </para>\r
33         <para>\r
34             <guilabel>Ignore line endings</guilabel>\r
35             hides changes which are due solely to difference in line-end style.\r
36         </para>\r
37         <para>\r
38             <guilabel>Ignore case changes</guilabel>\r
39             hides changes which are due solely to case changes within the text.\r
40             This can be useful with apps such as Visual Basic, which changes\r
41             case in variables without warning.\r
42         </para>\r
43     </sect2>\r
44     <sect2 id="tmerge-dug-settings-color">\r
45         <title>Colour Settings Page</title>\r
46         <?dbhh topicname="HIDD_SETCOLORPAGE"?>\r
47         <figure id="tmerge-dug-dia-setcolor">\r
48             <title>The Settings Color Page</title>\r
49             <graphic fileref="images/TMerge_SettingsColors.png"/>\r
50         </figure>\r
51         <para>\r
52             This dialog allows you to select the background color coding\r
53             used to highlight the different line changes.\r
54         </para>\r
55         <variablelist>\r
56             <varlistentry>\r
57                 <term>Normal</term>\r
58                 <listitem>\r
59                     All lines which are unchanged, or where changes are hidden.\r
60                 </listitem>\r
61             </varlistentry>\r
62             <varlistentry>\r
63                 <term>Added</term>\r
64                 <listitem>\r
65                     Lines which have been added.\r
66                 </listitem>\r
67             </varlistentry>\r
68             <varlistentry>\r
69                 <term>Removed</term>\r
70                 <listitem>\r
71                     Lines which have been deleted.\r
72                 </listitem>\r
73             </varlistentry>\r
74             <varlistentry>\r
75                 <term>Modified</term>\r
76                 <listitem>\r
77                     Lines which have relatively small changes, and are shown using inline diff.\r
78                     This colour is used for the <emphasis>unchanged</emphasis> portion of\r
79                     the line content. Changed portions will be shown using the inline\r
80                     added and deleted colours described below.\r
81                     If <guilabel>Colour code in-line changes</guilabel> is not enabled,\r
82                     this colour will not be used and changed lines will always be shown\r
83                     as replacements.\r
84                 </listitem>\r
85             </varlistentry>\r
86             <varlistentry>\r
87                 <term>Conflicted</term>\r
88                 <listitem>\r
89                     Where the same line has been changed in both files.\r
90                 </listitem>\r
91             </varlistentry>\r
92             <varlistentry>\r
93                 <term>Conflict resolved</term>\r
94                 <listitem>\r
95                     Where the same line has been changed in both files,\r
96                     and you have now selected which version should be used.\r
97                 </listitem>\r
98             </varlistentry>\r
99             <varlistentry>\r
100                 <term>Empty</term>\r
101                 <listitem>\r
102                     Where lines have been added in the opposite pane,\r
103                     and no such line existed in this pane.\r
104                 </listitem>\r
105             </varlistentry>\r
106             <varlistentry>\r
107                 <term>Inline added text</term>\r
108                 <listitem>\r
109                     When inline diffs are shown, added text is shown in this colour.\r
110                 </listitem>\r
111             </varlistentry>\r
112             <varlistentry>\r
113                 <term>Inline removed text</term>\r
114                 <listitem>\r
115                     When inline diffs are shown, deleted text is shown in this colour.\r
116                 </listitem>\r
117             </varlistentry>\r
118             <varlistentry>\r
119                 <term>Misc whitespaces</term>\r
120                 <listitem>\r
121                     Characters used to indicate Whitespace are shown in a different colour\r
122                     from normal text.\r
123                 </listitem>\r
124             </varlistentry>\r
125         </variablelist>\r
126     </sect2>\r
127 </sect1>\r