| blob | aa88d1fd13cae8b2fc9c8102775d47a3f0979431 |
1 <?xml version="1.0" encoding="UTF-8"?>\r
2 <!DOCTYPE preface SYSTEM "../../dtd/dblite.dtd">\r
3 <preface id="tgit-preface">\r
4 <title>Preface</title>\r
5 <simplesect>\r
6 <graphic srccredit="TortoiseGit Logo" fileref="images/TortoiseGit_banner.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="tgit-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="tgit-preface-readingguide">\r
61 <title>Reading Guide</title>\r
62 <para>\r
63 This <xref linkend="tgit-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="tgit-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="https://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="https://www.youtube.com/watch?v=8dhZ9BXQgc4">\r
80 <citetitle>Tech Talk: Git</citetitle>\r
81 </ulink> (more technical). You can also read <ulink url="https://git-scm.com/book">\r
82 <citetitle>Pro Git book (multiple translations as well as downloadable versions available)</citetitle>\r
83 </ulink>, <gitdoclink cmd="user-manual"/>, or <gitdoclink cmd="gittutorial" section="7"/>\r
84 which are a short introductions\r
85 to the <emphasis>Git</emphasis> revision control system,\r
86 explain the different approaches to version\r
87 control, and how Git works (with a bunch of examples).\r
88 </para>\r
89 <!--\r
90 <para>\r
91 Even most Git users will never have to set up a server themselves.\r
92 The next chapter deals with how to set up such a server, and is useful\r
93 for administrators.\r
94 </para>\r
95 -->\r
96 <para>\r
97 The <xref linkend="tgit-dug"/> is the most important section as\r
98 it explains all the main features of TortoiseGit and how to use them.\r
99 It takes the form of a tutorial, starting with checking out a working tree,\r
100 modifying it, committing your changes, etc. It then progresses to more\r
101 advanced topics.\r
102 </para>\r
103 <!--\r
104 <para>\r
105 The <xref linkend="tgit-howto"/> section answers some common questions\r
106 about performing tasks which are not explicitly covered elsewhere.\r
107 </para>\r
108 -->\r
109 <para>\r
110 The section on <xref linkend="tgit-automation"/> shows how the\r
111 TortoiseGit GUI dialogs can be called from the command line. This is useful\r
112 for scripting where you still need user interaction.\r
113 </para>\r
114 <para>\r
115 The <gitdoclink cmd="git" section="1"/> give git official document about\r
116 command line client <filename>git.exe</filename>.\r
117 </para>\r
118 </sect1>\r
119 <!-- =================================================================== -->\r
120 <!-- ======================== SECTION 2 ============================== -->\r
121 <!-- =================================================================== -->\r
122 <sect1 id="tgit-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="https://tortoisegit.org/">\r
132 <citetitle>https://tortoisegit.org/</citetitle>\r
133 </ulink>\r
134 </para>\r
135 </sect1>\r
136 <!-- =================================================================== -->\r
137 <!-- ======================== SECTION 3 ============================== -->\r
138 <!-- =================================================================== -->\r
139 <sect1 id="tgit-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="tgit-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>Sven Strickroth "email@cs-ware.de"</term>\r
164 <listitem>\r
165 <para>\r
166 for the hard work to get TortoiseGit to what it is now,\r
167 and his leadership of the project\r
168 </para>\r
169 </listitem>\r
170 </varlistentry>\r
171 <varlistentry>\r
172 <term>Sup Yut Sum "ch3cooli@gmail.com"</term>\r
173 <listitem>\r
174 <para>for bug reports and lots of improvements (code and translations)\r
175 </para>\r
176 </listitem>\r
177 </varlistentry>\r
178 <varlistentry>\r
179 <term>Yue Lin Ho "b8732003@student.nsysu.edu.tw"</term>\r
180 <listitem>\r
181 <para>for bug reports, work on the mailing list and lots of improvements (code and translations)\r
182 </para>\r
183 </listitem>\r
184 </varlistentry>\r
185 <varlistentry>\r
186 <term>myagi (Georg Fischer) "snowcoder@gmail.com"</term>\r
187 <listitem>\r
188 <para>\r
189 \r
190 For hard work to get TortoiseGit Overlay work.\r
191 </para>\r
192 </listitem>\r
193 </varlistentry>\r
194 <varlistentry>\r
195 <term>Colin Law</term>\r
196 <listitem>\r
197 <para>\r
198 </para>\r
199 </listitem>\r
200 </varlistentry>\r
201 <varlistentry>\r
202 <term>Johan't Hart</term>\r
203 <listitem>\r
204 <para>\r
205 </para>\r
206 </listitem>\r
207 </varlistentry>\r
208 <varlistentry>\r
209 <term>Laszlo Papp "djszapi@archlinux"</term>\r
210 <listitem>\r
211 <para>\r
212 </para>\r
213 </listitem>\r
214 </varlistentry>\r
215 <varlistentry>\r
216 <term>Tim Kemp</term>\r
217 <listitem>\r
218 <para>\r
219 for founding the TortoiseSVN project (TortoiseGit is based on this project)\r
220 </para>\r
221 </listitem>\r
222 </varlistentry>\r
223 <varlistentry>\r
224 <term>Stefan Küng</term>\r
225 <listitem>\r
226 <para>\r
227 for the hard work on TortoiseSVN\r
228 </para>\r
229 </listitem>\r
230 </varlistentry>\r
231 <varlistentry>\r
232 <term>Lübbe Onken</term>\r
233 <listitem>\r
234 <para>\r
235 for the beautiful icons, logo, bug hunting and translating\r
236 </para>\r
237 </listitem>\r
238 </varlistentry>\r
239 <varlistentry>\r
240 <term>Simon Large</term>\r
241 <listitem>\r
242 <para>\r
243 for helping with the documentation and bug hunting on TortoiseSVN\r
244 </para>\r
245 </listitem>\r
246 </varlistentry>\r
247 <varlistentry>\r
248 <term>The Tigris Style project</term>\r
249 <listitem>\r
250 <para>\r
251 for some of the styles which are reused in this documentation\r
252 </para>\r
253 </listitem>\r
254 </varlistentry>\r
255 <varlistentry>\r
256 <term>Our Contributors</term>\r
257 <listitem>\r
258 <para>\r
259 for the patches, bug reports and new ideas, and for\r
260 helping others by answering questions on our mailing list.\r
261 </para>\r
262 </listitem>\r
263 </varlistentry>\r
264 <varlistentry>\r
265 <term>Our Donators</term>\r
266 <listitem>\r
267 <para>\r
268 </para>\r
269 </listitem>\r
270 </varlistentry>\r
271 </variablelist>\r
272 </sect1>\r
273 <!-- ================================================================= -->\r
274 <!-- ======================== SECTION 5 ============================== -->\r
275 <!-- ================================================================= -->\r
276 <sect1 id="tgit-preface-terminoloty">\r
277 <title>Terminology used in this document</title>\r
278 <para>\r
279 To make reading the docs easier, the names of all the screens and Menus\r
280 from TortoiseGit are marked up in a different font.\r
281 The <guilabel>Log Dialog</guilabel> for instance.\r
282 </para>\r
283 <para>\r
284 A menu choice is indicated with an arrow.\r
285 <menuchoice>\r
286 <guimenu>TortoiseGit</guimenu>\r
287 <guimenuitem>Show Log</guimenuitem>\r
288 </menuchoice>\r
289 means: select <emphasis>Show Log</emphasis> from the\r
290 <emphasis>TortoiseGit</emphasis> context menu.\r
291 </para>\r
292 <para>\r
293 Where a local context menu appears within one of the TortoiseGit\r
294 dialogs, it is shown like this:\r
295 <menuchoice>\r
296 <guimenu>Context Menu</guimenu>\r
297 <guimenuitem>Save As ...</guimenuitem>\r
298 </menuchoice>\r
299 </para>\r
300 <para>\r
301 User Interface Buttons are indicated like this:\r
302 Press <guibutton>OK</guibutton> to continue.\r
303 </para>\r
304 <para>\r
305 User Actions are indicated using a bold font.\r
306 <keycap>Alt+A</keycap>: press the\r
307 <keycap>Alt</keycap>-Key on your keyboard and while holding it down\r
308 press the <keycap>A</keycap>-Key as well.\r
309 <action>Right-drag</action>: press the right mouse button and while\r
310 holding it down <emphasis>drag</emphasis> the items to the new location.\r
311 </para>\r
312 <para>\r
313 System output and keyboard input is indicated with a\r
314 <literal>different</literal> font as well.\r
315 </para>\r
316 <important>\r
317 <para>\r
318 Important notes are marked with an icon.\r
319 </para>\r
320 </important>\r
321 <tip>\r
322 <para>\r
323 Tips that make your life easier.\r
324 </para>\r
325 </tip>\r
326 <caution>\r
327 <para>\r
328 Places where you have to be careful what you are doing.\r
329 </para>\r
330 </caution>\r
331 <warning>\r
332 <para>\r
333 Where extreme care has to be taken, data corruption or other\r
334 nasty things may occur if these warnings are ignored.\r
335 </para>\r
336 </warning>\r
337 </sect1>\r
338 </preface>\r