doc/source/en/TortoiseGit/tsvn_preface.xml

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 <!DOCTYPE preface SYSTEM "../../dtd/dblite.dtd">\r
   3 <preface id="tsvn-preface">\r
   4         <title>Preface</title>\r
   5         <simplesect>\r
   6                 <graphic srccredit="TortoiseGit Logo" fileref="images/TortoiseGit_logo_hor468x64.png" scalefit="1" />\r
   7         </simplesect>\r
   8         <simplesect>\r
   9                 <para>\r
  10                         <itemizedlist>\r
  11                                 <listitem>\r
  12                                         <para>\r
  13                                                 Do you work in a team?\r
  14                                         </para>\r
  15                                 </listitem>\r
  16                                 <listitem>\r
  17                                         <para>\r
  18                                                 Has it ever happened that you were working on a file,\r
  19                                                 and someone else was working on the same file at the same time?\r
  20                                                 Did you lose your changes to that file because of that?\r
  21                                         </para>\r
  22                                 </listitem>\r
  23                                 <listitem>\r
  24                                         <para>\r
  25                                                 Have you ever saved a file, and then wanted to\r
  26                                                 revert the changes you made? Have you ever wished you\r
  27                                                 could see what a file looked like some time ago?\r
  28                                         </para>\r
  29                                 </listitem>\r
  30                                 <listitem>\r
  31                                         <para>\r
  32                                                 Have you ever found a bug in your project and\r
  33                                                 wanted to know when that bug got into your files?\r
  34                                         </para>\r
  35                                 </listitem>\r
  36                         </itemizedlist>\r
  37                 </para>\r
  38                 <para>\r
  39                         If you answered <quote>yes</quote> to one of these questions, then\r
  40                         TortoiseGit is for you! Just read on to find out how TortoiseGit\r
  41                         can help you in your work. It's not that difficult.\r
  42                 </para>\r
  43         </simplesect>\r
  44         <!-- =================================================================== -->\r
  45         <!-- ========================   SECTION 1 ============================== -->\r
  46         <!-- =================================================================== -->\r
  47         <sect1 id="tsvn-preface-audience">\r
  48                 <title>Audience</title>\r
  49                 <para>\r
  50                         This book is written for computer literate folk who want to\r
  51                         use Git to manage their data, but are uncomfortable using the\r
  52                         command line client to do so. Since TortoiseGit is a windows shell\r
  53                         extension it's assumed that the user is familiar with the windows\r
  54                         explorer and knows how to use it.\r
  55                 </para>\r
  56         </sect1>\r
  57         <!-- =================================================================== -->\r
  58         <!-- ========================   SECTION 1a ============================= -->\r
  59         <!-- =================================================================== -->\r
  60         <sect1 id="tsvn-preface-readingguide">\r
  61                 <title>Reading Guide</title>\r
  62                 <para>\r
  63                         This <xref linkend="tsvn-preface"/> explains a little about the\r
  64                         TortoiseGit project, the community of people who work on it, and\r
  65                         the licensing conditions for using it and distributing it.\r
  66                 </para>\r
  67                 <para>\r
  68                         The <xref linkend="tsvn-introduction"/> explains what TortoiseGit is,\r
  69                         what it does, where it comes from and the basics for installing it\r
  70                         on your PC.\r
  71                 </para>\r
  72                 <para>\r
  73                         In <xref linkend="tsvn-basics"/> we give a short introduction\r
  74                         to the <emphasis>Git</emphasis> revision control system which\r
  75                         underlies TortoiseGit. This is borrowed from the documentation for the\r
  76                         Git project and explains the different approaches to version\r
  77                         control, and how Git works.\r
  78                 </para>\r
  79                 <para>\r
  80                         Even most Git users will never have to set up a server themselves.\r
  81                         The next chapter deals with how to set up such a server, and is useful\r
  82                         for administrators.\r
  83                 </para>\r
  84                 <para>\r
  85                         The chapter on <xref linkend="tsvn-repository"/> explains how to set up\r
  86                         a local repository, which is useful for testing Git and TortoiseGit\r
  87                         using a single PC. It also explains a bit about repository administration\r
  88                         which is also relevant to repositories located on a server.\r
  89                 </para>\r
  90                 <para>\r
  91                         The <xref linkend="tsvn-dug"/> is the most important section as\r
  92                         it explains all the main features of TortoiseGit and how to use them.\r
  93                         It takes the form of a tutorial, starting with checking out a working copy,\r
  94                         modifying it, committing your changes, etc. It then progresses to more\r
  95                         advanced topics.\r
  96                 </para>\r
  97                 <!--\r
  98                 <para>\r
  99                         <xref linkend="tsvn-subwcrev"/> is a separate program included with TortoiseGit\r
 100                         which can extract the information from your working copy and write it into a\r
 101                         file. This is useful for including build information in your projects.\r
 102                 </para>\r
 103                 -->\r
 104                 <para>\r
 105                         The <xref linkend="tsvn-howto"/> section answers some common questions\r
 106                         about performing tasks which are not explicitly covered elsewhere.\r
 107                 </para>\r
 108                 <para>\r
 109                         The section on <xref linkend="tsvn-automation"/> shows how the\r
 110                         TortoiseGit GUI dialogs can be called from the command line. This is useful\r
 111                         for scripting where you still need user interaction.\r
 112                 </para>\r
 113                 <para>\r
 114                         The <xref linkend="tsvn-cli"/> give a correlation\r
 115                         between TortoiseGit commands and their equivalents in the Git\r
 116                         command line client <literal>svn.exe</literal>.\r
 117                 </para>\r
 118         </sect1>\r
 119         <!-- =================================================================== -->\r
 120         <!-- ========================   SECTION 2 ============================== -->\r
 121         <!-- =================================================================== -->\r
 122         <sect1 id="tsvn-preface-source">\r
 123                 <title>TortoiseGit is free!</title>\r
 124                 <para>\r
 125                         TortoiseGit is free. You don't have to pay to use it, and you can use it\r
 126                         any way you want. It is developed under the GNU General Public License (GPL).\r
 127                 </para>\r
 128                 <para>\r
 129                         TortoiseGit is an Open Source project. That means you have full\r
 130                         read access to the source code of this program. Project Home is \r
 131                         <ulink url="http://code.google.com/p/tortoisegit">\r
 132                                 <citetitle>http://code.google.com/p/tortoisegit</citetitle>\r
 133                         </ulink>\r
 134                 </para>\r
 135         </sect1>\r
 136         <!-- =================================================================== -->\r
 137         <!-- ========================   SECTION 3 ============================== -->\r
 138         <!-- =================================================================== -->\r
 139         <sect1 id="tsvn-preface-community">\r
 140                 <title>Community</title>\r
 141                 <para>\r
 142                         Both TortoiseGit and Git are developed by a community of\r
 143                         people who are working on those projects. They come from different\r
 144                         countries all over the world and joined together to create wonderful\r
 145                         programs.\r
 146                 </para>\r
 147         </sect1>\r
 148         <!-- =================================================================== -->\r
 149         <!-- ========================   SECTION 4 ============================== -->\r
 150         <!-- =================================================================== -->\r
 151         <sect1 id="tsvn-preface-acknowledgements">\r
 152                 <title>Acknowledgments</title>\r
 153                 <variablelist>\r
 154                         <varlistentry>\r
 155                                 <term>Frank Li "lznuaa@gmail.com"</term>\r
 156                                 <listitem>\r
 157                                         <para>\r
 158                                                 for founding the TortoiseGit project\r
 159                                         </para>\r
 160                                 </listitem>\r
 161                         </varlistentry>\r
 162                         <varlistentry>\r
 163                                 <term>myagi(Georg Fischer) "snowcoder@gmail.com"</term>\r
 164                                 <listitem>\r
 165                                         <para>\r
 166                                         \r
 167                                         For hard work to get TortoiseGit Overlay work.\r
 168                                         </para>\r
 169                                 </listitem>\r
 170                         </varlistentry>\r
 171                         <varlistentry>\r
 172                                 <term>Colin Law</term>\r
 173                                 <listitem>\r
 174                                         <para>                                          \r
 175                                         </para>\r
 176                                 </listitem>\r
 177                         </varlistentry>                 \r
 178                         <varlistentry>\r
 179                                 <term>Johan t Hart</term>\r
 180                                 <listitem>\r
 181                                         <para>                                          \r
 182                                         </para>\r
 183                                 </listitem>\r
 184                         </varlistentry>\r
 185                         <varlistentry>\r
 186                                 <term>Tim Kemp</term>\r
 187                                 <listitem>\r
 188                                         <para>\r
 189                                                 for founding the TortoiseSVN project(TortoiseGit come from this project)\r
 190                                         </para>\r
 191                                 </listitem>\r
 192                         </varlistentry>\r
 193                         <varlistentry>\r
 194                                 <term>Stefan Küng</term>\r
 195                                 <listitem>\r
 196                                         <para>\r
 197                                                 for the hard work to get TortoiseGit to what it is now\r
 198                                         </para>\r
 199                                 </listitem>\r
 200                         </varlistentry>\r
 201                         <varlistentry>\r
 202                                 <term>Lübbe Onken</term>\r
 203                                 <listitem>\r
 204                                         <para>\r
 205                                                 for the beautiful icons, logo, bug hunting, translating and\r
 206                                                 managing the translations\r
 207                                         </para>\r
 208                                 </listitem>\r
 209                         </varlistentry>\r
 210                         <varlistentry>\r
 211                                 <term>Simon Large</term>\r
 212                                 <listitem>\r
 213                                         <para>\r
 214                                                 for helping with the documentation and bug hunting\r
 215                                         </para>\r
 216                                 </listitem>\r
 217                         </varlistentry>\r
 218                         <varlistentry>\r
 219                                 <term>The Git Book</term>\r
 220                                 <listitem>\r
 221                                         <para>\r
 222                                                 for the great introduction to Git and its\r
 223                                                 chapter 2 which we copied here\r
 224                                         </para>\r
 225                                 </listitem>\r
 226                         </varlistentry>\r
 227                         <varlistentry>\r
 228                                 <term>The Tigris Style project</term>\r
 229                                 <listitem>\r
 230                                         <para>\r
 231                                                 for some of the styles which are reused in this documentation\r
 232                                         </para>\r
 233                                 </listitem>\r
 234                         </varlistentry>\r
 235                         <varlistentry>\r
 236                                 <term>Our Contributors</term>\r
 237                                 <listitem>\r
 238                                         <para>\r
 239                                                 for the patches, bug reports and new ideas, and for\r
 240                                                 helping others by answering questions on our mailing list.\r
 241                                         </para>\r
 242                                 </listitem>\r
 243                         </varlistentry>\r
 244                         <varlistentry>\r
 245                                 <term>Our Donators</term>\r
 246                                 <listitem>\r
 247                                         <para>\r
 248                                                 for many hours of joy with the music they sent us\r
 249                                         </para>\r
 250                                 </listitem>\r
 251                         </varlistentry>\r
 252                 </variablelist>\r
 253         </sect1>\r
 254         <!-- ================================================================= -->\r
 255         <!-- ======================== SECTION 5 ============================== -->\r
 256         <!-- ================================================================= -->\r
 257         <sect1 id="tsvn-preface-terminoloty">\r
 258                 <title>Terminology used in this document</title>\r
 259                 <para>\r
 260                         To make reading the docs easier, the names of all the screens and Menus \r
 261                         from TortoiseGit are marked up in a different font.\r
 262                         The <guilabel>Log Dialog</guilabel> for instance.\r
 263                 </para>\r
 264                 <para>\r
 265                         A menu choice is indicated with an arrow.\r
 266                         <menuchoice>\r
 267                                 <guimenu>TortoiseGit</guimenu>\r
 268                                 <guimenuitem>Show Log</guimenuitem>\r
 269                         </menuchoice>\r
 270                         means: select <emphasis>Show Log</emphasis> from the\r
 271                         <emphasis>TortoiseGit</emphasis> context menu.\r
 272                 </para>\r
 273                 <para>\r
 274                         Where a local context menu appears within one of the TortoiseGit\r
 275                         dialogs, it is shown like this:\r
 276                         <menuchoice>\r
 277                                 <guimenu>Context Menu</guimenu>\r
 278                                 <guimenuitem>Save As ...</guimenuitem>\r
 279                         </menuchoice>\r
 280                 </para>\r
 281                 <para>\r
 282                         User Interface Buttons are indicated like this:\r
 283                         Press <guibutton>OK</guibutton> to continue.\r
 284                 </para>\r
 285                 <para>\r
 286                         User Actions are indicated using a bold font.\r
 287                         <keycap>Alt+A</keycap>: press the\r
 288                         <keycap>Alt</keycap>-Key on your keyboard and while holding it down\r
 289                         press the <keycap>A</keycap>-Key as well.\r
 290                         <action>Right-drag</action>: press the right mouse button and while\r
 291                         holding it down <emphasis>drag</emphasis> the items to the new location.\r
 292                 </para>\r
 293                 <para>\r
 294                         System output and keyboard input is indicated with a\r
 295                         <literal>different</literal> font as well.\r
 296                 </para>\r
 297                 <important>\r
 298                         <para>\r
 299                                 Important notes are marked with an icon.\r
 300                         </para>\r
 301                 </important>\r
 302                 <tip>\r
 303                         <para>\r
 304                                 Tips that make your life easier.\r
 305                         </para>\r
 306                 </tip>\r
 307                 <caution>\r
 308                         <para>\r
 309                                 Places where you have to be careful what you are doing.\r
 310                         </para>\r
 311                 </caution>\r
 312                 <warning>\r
 313                         <para>\r
 314                                 Where extreme care has to be taken, data corruption or other\r
 315                                 nasty things may occur if these warnings are ignored.\r
 316                         </para>\r
 317                 </warning>\r
 318                 <graphic srccredit="hide" fileref="images/background.png" scalefit="1" width="100%"/>\r
 319         </sect1>\r
 320 </preface>\r