| blob | 492c107c9d1ef87b047901e67635816be8cafd23 |
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 If you need a general introduction to version control with <emphasis>Git</emphasis>,\r
74 then we recommend two videos on YouTube:\r
75 <ulink url="http://www.youtube.com/watch?v=4XpnKHJAok8">\r
76 <citetitle>Tech Talk: Linus Torvalds on git</citetitle>\r
77 </ulink> (about design and differences to other VCS)\r
78 and\r
79 <ulink url="http://www.youtube.com/watch?v=8dhZ9BXQgc4">\r
80 <citetitle>Tech Talk: Git</citetitle>\r
81 </ulink> (more technical). You can also read <xref linkend="git-book"/>\r
82 which is a short introduction\r
83 to the <emphasis>Git</emphasis> revision control system. \r
84 This is borrowed from the documentation for the\r
85 Git project and explains the different approaches to version\r
86 control, and how Git works.\r
87 </para>\r
88 <!--\r
89 <para>\r
90 Even most Git users will never have to set up a server themselves.\r
91 The next chapter deals with how to set up such a server, and is useful\r
92 for administrators.\r
93 </para>\r
94 -->\r
95 <para>\r
96 The <xref linkend="tsvn-dug"/> is the most important section as\r
97 it explains all the main features of TortoiseGit and how to use them.\r
98 It takes the form of a tutorial, starting with checking out a working tree,\r
99 modifying it, committing your changes, etc. It then progresses to more\r
100 advanced topics.\r
101 </para>\r
102 <!--\r
103 <para>\r
104 <xref linkend="tsvn-subwcrev"/> is a separate program included with TortoiseGit\r
105 which can extract the information from your working tree and write it into a\r
106 file. This is useful for including build information in your projects.\r
107 </para>\r
108 -->\r
109 <!--\r
110 <para>\r
111 The <xref linkend="tsvn-howto"/> section answers some common questions\r
112 about performing tasks which are not explicitly covered elsewhere.\r
113 </para>\r
114 -->\r
115 <para>\r
116 The section on <xref linkend="tsvn-automation"/> shows how the\r
117 TortoiseGit GUI dialogs can be called from the command line. This is useful\r
118 for scripting where you still need user interaction.\r
119 </para>\r
120 <para>\r
121 The <xref linkend="git(1)"/> give git official document about\r
122 command line client <literal>git.exe</literal>.\r
123 </para>\r
124 </sect1>\r
125 <!-- =================================================================== -->\r
126 <!-- ======================== SECTION 2 ============================== -->\r
127 <!-- =================================================================== -->\r
128 <sect1 id="tsvn-preface-source">\r
129 <title>TortoiseGit is free!</title>\r
130 <para>\r
131 TortoiseGit is free. You don't have to pay to use it, and you can use it\r
132 any way you want. It is developed under the GNU General Public License (GPL).\r
133 </para>\r
134 <para>\r
135 TortoiseGit is an Open Source project. That means you have full\r
136 read access to the source code of this program. Project Home is \r
137 <ulink url="http://code.google.com/p/tortoisegit">\r
138 <citetitle>http://code.google.com/p/tortoisegit</citetitle>\r
139 </ulink>\r
140 </para>\r
141 </sect1>\r
142 <!-- =================================================================== -->\r
143 <!-- ======================== SECTION 3 ============================== -->\r
144 <!-- =================================================================== -->\r
145 <sect1 id="tsvn-preface-community">\r
146 <title>Community</title>\r
147 <para>\r
148 Both TortoiseGit and Git are developed by a community of\r
149 people who are working on those projects. They come from different\r
150 countries all over the world and joined together to create wonderful\r
151 programs.\r
152 </para>\r
153 </sect1>\r
154 <!-- =================================================================== -->\r
155 <!-- ======================== SECTION 4 ============================== -->\r
156 <!-- =================================================================== -->\r
157 <sect1 id="tsvn-preface-acknowledgements">\r
158 <title>Acknowledgments</title>\r
159 <variablelist>\r
160 <varlistentry>\r
161 <term>Frank Li "lznuaa@gmail.com"</term>\r
162 <listitem>\r
163 <para>\r
164 for founding the TortoiseGit project\r
165 </para>\r
166 </listitem>\r
167 </varlistentry>\r
168 <varlistentry>\r
169 <term>myagi (Georg Fischer) "snowcoder@gmail.com"</term>\r
170 <listitem>\r
171 <para>\r
172 \r
173 For hard work to get TortoiseGit Overlay work.\r
174 </para>\r
175 </listitem>\r
176 </varlistentry>\r
177 <varlistentry>\r
178 <term>Colin Law</term>\r
179 <listitem>\r
180 <para> \r
181 </para>\r
182 </listitem>\r
183 </varlistentry> \r
184 <varlistentry>\r
185 <term>Johan t Hart</term>\r
186 <listitem>\r
187 <para> \r
188 </para>\r
189 </listitem>\r
190 </varlistentry>\r
191 <varlistentry>\r
192 <term>Sven Strickroth "email@cs-ware.de"</term>\r
193 <listitem>\r
194 <para>\r
195 \r
196 </para>\r
197 </listitem>\r
198 </varlistentry>\r
199 <varlistentry>\r
200 <term>Laszlo Papp "djszapi@archlinux"</term>\r
201 <listitem>\r
202 <para>For bug reports and the bugtracker handling\r
203 </para>\r
204 </listitem>\r
205 </varlistentry>\r
206 <varlistentry>\r
207 <term>Tim Kemp</term>\r
208 <listitem>\r
209 <para>\r
210 for founding the TortoiseSVN project (TortoiseGit come from this project)\r
211 </para>\r
212 </listitem>\r
213 </varlistentry>\r
214 <varlistentry>\r
215 <term>Stefan Küng</term>\r
216 <listitem>\r
217 <para>\r
218 for the hard work on TortoiseSVN\r
219 </para>\r
220 </listitem>\r
221 </varlistentry>\r
222 <varlistentry>\r
223 <term>Lübbe Onken</term>\r
224 <listitem>\r
225 <para>\r
226 for the beautiful icons, logo, bug hunting, translating and\r
227 managing the translations on TortoiseSVN\r
228 </para>\r
229 </listitem>\r
230 </varlistentry>\r
231 <varlistentry>\r
232 <term>Simon Large</term>\r
233 <listitem>\r
234 <para>\r
235 for helping with the documentation and bug hunting on TortoiseSVN\r
236 </para>\r
237 </listitem>\r
238 </varlistentry>\r
239 <varlistentry>\r
240 <term>The Git Book</term>\r
241 <listitem>\r
242 <para>\r
243 for the great introduction to Git and its\r
244 chapter 2 which we copied here\r
245 </para>\r
246 </listitem>\r
247 </varlistentry>\r
248 <varlistentry>\r
249 <term>The Tigris Style project</term>\r
250 <listitem>\r
251 <para>\r
252 for some of the styles which are reused in this documentation\r
253 </para>\r
254 </listitem>\r
255 </varlistentry>\r
256 <varlistentry>\r
257 <term>Our Contributors</term>\r
258 <listitem>\r
259 <para>\r
260 for the patches, bug reports and new ideas, and for\r
261 helping others by answering questions on our mailing list.\r
262 </para>\r
263 </listitem>\r
264 </varlistentry>\r
265 <varlistentry>\r
266 <term>Our Donators</term>\r
267 <listitem>\r
268 <para>\r
269 for many hours of joy with the music they sent us\r
270 </para>\r
271 </listitem>\r
272 </varlistentry>\r
273 </variablelist>\r
274 </sect1>\r
275 <!-- ================================================================= -->\r
276 <!-- ======================== SECTION 5 ============================== -->\r
277 <!-- ================================================================= -->\r
278 <sect1 id="tsvn-preface-terminoloty">\r
279 <title>Terminology used in this document</title>\r
280 <para>\r
281 To make reading the docs easier, the names of all the screens and Menus \r
282 from TortoiseGit are marked up in a different font.\r
283 The <guilabel>Log Dialog</guilabel> for instance.\r
284 </para>\r
285 <para>\r
286 A menu choice is indicated with an arrow.\r
287 <menuchoice>\r
288 <guimenu>TortoiseGit</guimenu>\r
289 <guimenuitem>Show Log</guimenuitem>\r
290 </menuchoice>\r
291 means: select <emphasis>Show Log</emphasis> from the\r
292 <emphasis>TortoiseGit</emphasis> context menu.\r
293 </para>\r
294 <para>\r
295 Where a local context menu appears within one of the TortoiseGit\r
296 dialogs, it is shown like this:\r
297 <menuchoice>\r
298 <guimenu>Context Menu</guimenu>\r
299 <guimenuitem>Save As ...</guimenuitem>\r
300 </menuchoice>\r
301 </para>\r
302 <para>\r
303 User Interface Buttons are indicated like this:\r
304 Press <guibutton>OK</guibutton> to continue.\r
305 </para>\r
306 <para>\r
307 User Actions are indicated using a bold font.\r
308 <keycap>Alt+A</keycap>: press the\r
309 <keycap>Alt</keycap>-Key on your keyboard and while holding it down\r
310 press the <keycap>A</keycap>-Key as well.\r
311 <action>Right-drag</action>: press the right mouse button and while\r
312 holding it down <emphasis>drag</emphasis> the items to the new location.\r
313 </para>\r
314 <para>\r
315 System output and keyboard input is indicated with a\r
316 <literal>different</literal> font as well.\r
317 </para>\r
318 <important>\r
319 <para>\r
320 Important notes are marked with an icon.\r
321 </para>\r
322 </important>\r
323 <tip>\r
324 <para>\r
325 Tips that make your life easier.\r
326 </para>\r
327 </tip>\r
328 <caution>\r
329 <para>\r
330 Places where you have to be careful what you are doing.\r
331 </para>\r
332 </caution>\r
333 <warning>\r
334 <para>\r
335 Where extreme care has to be taken, data corruption or other\r
336 nasty things may occur if these warnings are ignored.\r
337 </para>\r
338 </warning>\r
339 <graphic srccredit="hide" fileref="images/background.png" scalefit="1" width="100%"/>\r
340 </sect1>\r
341 </preface>\r