doc/source/en/TortoiseMerge/tme_dug_settings.xml

   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>Use ribbons</guilabel>\r
  28             when set, ribbons interface is used (looks like Office 2007).\r
  29             When unset, traditional toolbar interface is used.\r
  30             Default is set.\r
  31         </para>\r
  32         <para>\r
  33             <guilabel>Use spaces</guilabel>\r
  34             when set, pressing tab key inserts spaces.\r
  35             Default is unset (tab char is used).\r
  36         </para>\r
  37         <para>\r
  38             <guilabel>Smart tab char</guilabel>\r
  39             when set, pressing tab key inserts tab/spaces based on adjacent lines/characters.\r
  40             Default is unset.\r
  41         </para>\r
  42         <para>\r
  43             <guilabel>EditorConfig</guilabel>\r
  44             when set, it will detect <literal>.editorconfig</literal> files.\r
  45             Currently, it supports indent_style(space/tab) and indent_size properties.\r
  46             See <ulink url="http://editorconfig.org/"><citetitle>EditorConfig</citetitle></ulink> website for more details.\r
  47         </para>\r
  48         <para>\r
  49             <guilabel>Max line length for inline diffs</guilabel>\r
  50             TortoiseGitMerge can get slow when showing inline diffs for\r
  51             very long lines. Because of that only lines that are shorter\r
  52             than 3000 chars are shown with inline diffs. You can change\r
  53             this value here.\r
  54         </para>\r
  55         <para>\r
  56             <guilabel>Ignore line endings</guilabel>\r
  57             hides changes which are due solely to difference in line-end style.\r
  58         </para>\r
  59         <para>\r
  60             <guilabel>Ignore case changes</guilabel>\r
  61             hides changes which are due solely to case changes within the text.\r
  62             This can be useful with apps such as Visual Basic, which changes\r
  63             case in variables without warning.\r
  64         </para>\r
  65         <para>\r
  66             <guilabel>Context lines for patches</guilabel>\r
  67             specifies how many context lines for patch files generated from TortoiseGitMerge.\r
  68             The default value is -1, which means context lines number is controlled \r
  69             by git or <literal>diff.context</literal> config.\r
  70         </para>\r
  71     </sect2>\r
  72     <sect2 id="tmerge-dug-settings-color">\r
  73         <title>Colour Settings Page</title>\r
  74         <?dbhh topicname="HIDD_SETCOLORPAGE"?>\r
  75         <figure id="tmerge-dug-dia-setcolor">\r
  76             <title>The Settings Color Page</title>\r
  77             <graphic fileref="images/TMerge_SettingsColors.png"/>\r
  78         </figure>\r
  79         <para>\r
  80             This dialog allows you to select the background color coding\r
  81             used to highlight the different line changes.\r
  82         </para>\r
  83         <variablelist>\r
  84             <varlistentry>\r
  85                 <term>Normal</term>\r
  86                 <listitem>\r
  87                     All lines which are unchanged, or where changes are hidden.\r
  88                 </listitem>\r
  89             </varlistentry>\r
  90             <varlistentry>\r
  91                 <term>Added</term>\r
  92                 <listitem>\r
  93                     Lines which have been added.\r
  94                 </listitem>\r
  95             </varlistentry>\r
  96             <varlistentry>\r
  97                 <term>Removed</term>\r
  98                 <listitem>\r
  99                     Lines which have been deleted.\r
 100                 </listitem>\r
 101             </varlistentry>\r
 102             <varlistentry>\r
 103                 <term>Modified</term>\r
 104                 <listitem>\r
 105                     Lines which have relatively small changes, and are shown using inline diff.\r
 106                     This colour is used for the <emphasis>unchanged</emphasis> portion of\r
 107                     the line content. Changed portions will be shown using the inline\r
 108                     added and deleted colours described below.\r
 109                     If <guilabel>Colour code in-line changes</guilabel> is not enabled,\r
 110                     this colour will not be used and changed lines will always be shown\r
 111                     as replacements.\r
 112                 </listitem>\r
 113             </varlistentry>\r
 114             <varlistentry>\r
 115                 <term>Conflicted</term>\r
 116                 <listitem>\r
 117                     Where the same line has been changed in both files.\r
 118                 </listitem>\r
 119             </varlistentry>\r
 120             <varlistentry>\r
 121                 <term>Conflict resolved</term>\r
 122                 <listitem>\r
 123                     Where the same line has been changed in both files,\r
 124                     and you have now selected which version should be used.\r
 125                 </listitem>\r
 126             </varlistentry>\r
 127             <varlistentry>\r
 128                 <term>Empty</term>\r
 129                 <listitem>\r
 130                     Where lines have been added in the opposite pane,\r
 131                     and no such line existed in this pane.\r
 132                 </listitem>\r
 133             </varlistentry>\r
 134             <varlistentry>\r
 135                 <term>Inline added text</term>\r
 136                 <listitem>\r
 137                     When inline diffs are shown, added text is shown in this colour.\r
 138                 </listitem>\r
 139             </varlistentry>\r
 140             <varlistentry>\r
 141                 <term>Inline removed text</term>\r
 142                 <listitem>\r
 143                     When inline diffs are shown, deleted text is shown in this colour.\r
 144                 </listitem>\r
 145             </varlistentry>\r
 146             <varlistentry>\r
 147                 <term>Misc whitespaces</term>\r
 148                 <listitem>\r
 149                     Characters used to indicate Whitespace are shown in a different colour\r
 150                     from normal text.\r
 151                 </listitem>\r
 152             </varlistentry>\r
 153         </variablelist>\r
 154     </sect2>\r
 155 </sect1>\r