Mercurial > hgbook
annotate en/ch00-preface.xml @ 838:d1f676a6a4b3 default tip
update mq chapter.
propagate ef53d025f410.
author | Yoshiki Yazawa <yaz@honeyplanet.jp> |
---|---|
date | Thu, 03 Dec 2009 01:26:08 +0900 |
parents | d5688822c51d |
children |
rev | line source |
---|---|
658
b90b024729f1
WIP DocBook snapshot that all compiles. Mirabile dictu!
Bryan O'Sullivan <bos@serpentine.com>
parents:
649
diff
changeset
|
1 <!-- vim: set filetype=docbkxml shiftwidth=2 autoindent expandtab tw=77 : --> |
b90b024729f1
WIP DocBook snapshot that all compiles. Mirabile dictu!
Bryan O'Sullivan <bos@serpentine.com>
parents:
649
diff
changeset
|
2 |
b90b024729f1
WIP DocBook snapshot that all compiles. Mirabile dictu!
Bryan O'Sullivan <bos@serpentine.com>
parents:
649
diff
changeset
|
3 <preface id="chap:preface"> |
686
34cb220eb717
Add a file name for the preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
683
diff
changeset
|
4 <?dbhtml filename="preface.html"?> |
658
b90b024729f1
WIP DocBook snapshot that all compiles. Mirabile dictu!
Bryan O'Sullivan <bos@serpentine.com>
parents:
649
diff
changeset
|
5 <title>Preface</title> |
26 | 6 |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
7 <sect1> |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
8 <title>Technical storytelling</title> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
9 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
10 <para id="x_72e">A few years ago, when I wanted to explain why I believed |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
11 that distributed revision control is important, the field was |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
12 then so new that there was almost no published literature to |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
13 refer people to.</para> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
14 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
15 <para id="x_72f">Although at that time I spent some time working on the |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
16 internals of Mercurial itself, I switched to writing this book |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
17 because that seemed like the most effective way to help the |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
18 software to reach a wide audience, along with the idea that |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
19 revision control ought to be distributed in nature. I publish |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
20 the book online under a liberal license for the same |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
21 reason: to get the word out.</para> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
22 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
23 <para id="x_730">There's a familiar rhythm to a good software book that |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
24 closely resembles telling a story: What is this thing? Why does |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
25 it matter? How will it help me? How do I use it? In this |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
26 book, I try to answer those questions for distributed revision |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
27 control in general, and for Mercurial in particular.</para> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
28 </sect1> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
29 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
30 <sect1> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
31 <title>Thank you for supporting Mercurial</title> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
32 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
33 <para id="x_731">By purchasing a copy of this book, you are supporting the |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
34 continued development and freedom of Mercurial in particular, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
35 and of open source and free software in general. O'Reilly Media |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
36 and I are donating my royalties on the sales of this book to the |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
37 Software Freedom Conservancy (<ulink |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
38 url="http://www.softwarefreedom.org/">http://www.softwarefreedom.org/</ulink>) |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
39 which provides clerical and legal support to Mercurial and a |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
40 number of other prominent and worthy open source software |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
41 projects.</para> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
42 </sect1> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
43 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
44 <sect1> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
45 <title>Acknowledgments</title> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
46 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
47 <para id="x_732">This book would not exist were it not for the efforts of |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
48 Matt Mackall, the author and project lead of Mercurial. He is |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
49 ably assisted by hundreds of volunteer contributors across the |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
50 world.</para> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
51 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
52 <para id="x_733">My children, Cian and Ruairi, always stood ready to help me |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
53 to unwind with wonderful, madcap little-boy games. I'd also |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
54 like to thank my ex-wife, Shannon, for her support.</para> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
55 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
56 <para id="x_734">My colleagues and friends provided help and support in |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
57 innumerable ways. This list of people is necessarily very |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
58 incomplete: Stephen Hahn, Karyn Ritter, Bonnie Corwin, James |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
59 Vasile, Matt Norwood, Eben Moglen, Bradley Kuhn, Robert Walsh, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
60 Jeremy Fitzhardinge, Rachel Chalmers.</para> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
61 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
62 <para id="x_735">I developed this book in the open, posting drafts of |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
63 chapters to the book web site as I completed them. Readers then |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
64 submitted feedback using a web application that I developed. By |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
65 the time I finished writing the book, more than 100 people had |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
66 submitted comments, an amazing number considering that the |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
67 comment system was live for only about two months towards the |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
68 end of the writing process.</para> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
69 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
70 <para id="x_736">I would particularly like to recognize the following people, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
71 who between them contributed over a third of the total number of |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
72 comments. I would like to thank them for their care and effort |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
73 in providing so much detailed feedback.</para> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
74 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
75 <para id="x_737">Martin Geisler, Damien Cassou, Alexey Bakhirkin, Till Plewe, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
76 Dan Himes, Paul Sargent, Gokberk Hamurcu, Matthijs van der |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
77 Vleuten, Michael Chermside, John Mulligan, Jordi Fita, Jon |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
78 Parise.</para> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
79 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
80 <para id="x_738">I also want to acknowledge the help of the many people who |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
81 caught errors and provided helpful suggestions throughout the |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
82 book.</para> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
83 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
84 <para id="x_739">Jeremy W. Sherman, Brian Mearns, Vincent Furia, Iwan |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
85 Luijks, Billy Edwards, Andreas Sliwka, Paweł Sołyga, Eric |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
86 Hanchrow, Steve Nicolai, Michał Masłowski, Kevin Fitch, Johan |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
87 Holmberg, Hal Wine, Volker Simonis, Thomas P Jakobsen, Ted |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
88 Stresen-Reuter, Stephen Rasku, Raphael Das Gupta, Ned |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
89 Batchelder, Lou Keeble, Li Linxiao, Kao Cardoso Félix, Joseph |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
90 Wecker, Jon Prescot, Jon Maken, John Yeary, Jason Harris, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
91 Geoffrey Zheng, Fredrik Jonson, Ed Davies, David Zumbrunnen, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
92 David Mercer, David Cabana, Ben Karel, Alan Franzoni, Yousry |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
93 Abdallah, Whitney Young, Vinay Sajip, Tom Towle, Tim Ottinger, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
94 Thomas Schraitle, Tero Saarni, Ted Mielczarek, Svetoslav |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
95 Agafonkin, Shaun Rowland, Rocco Rutte, Polo-Francois Poli, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
96 Philip Jenvey, Petr Tesałék, Peter R. Annema, Paul Bonser, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
97 Olivier Scherler, Olivier Fournier, Nick Parker, Nick Fabry, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
98 Nicholas Guarracino, Mike Driscoll, Mike Coleman, Mietek Bák, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
99 Michael Maloney, László Nagy, Kent Johnson, Julio Nobrega, Jord |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
100 Fita, Jonathan March, Jonas Nockert, Jim Tittsler, Jeduan |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
101 Cornejo Legorreta, Jan Larres, James Murphy, Henri Wiechers, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
102 Hagen Möbius, Gábor Farkas, Fabien Engels, Evert Rol, Evan |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
103 Willms, Eduardo Felipe Castegnaro, Dennis Decker Jensen, Deniz |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
104 Dogan, David Smith, Daed Lee, Christine Slotty, Charles Merriam, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
105 Guillaume Catto, Brian Dorsey, Bob Nystrom, Benoit Boissinot, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
106 Avi Rosenschein, Andrew Watts, Andrew Donkin, Alexey Rodriguez, |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
107 Ahmed Chaudhary.</para> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
108 </sect1> |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
109 |
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
110 <sect1> |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
111 <title>Conventions Used in This Book</title> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
112 |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
113 <para id="x_73a">The following typographical conventions are used in this |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
114 book:</para> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
115 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
116 <variablelist> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
117 <varlistentry> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
118 <term>Italic</term> |
26 | 119 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
120 <listitem> |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
121 <para id="x_73b">Indicates new terms, URLs, email addresses, filenames, |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
122 and file extensions.</para> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
123 </listitem> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
124 </varlistentry> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
125 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
126 <varlistentry> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
127 <term><literal>Constant width</literal></term> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
128 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
129 <listitem> |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
130 <para id="x_73c">Used for program listings, as well as within |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
131 paragraphs to refer to program elements such as variable |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
132 or function names, databases, data types, environment |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
133 variables, statements, and keywords.</para> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
134 </listitem> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
135 </varlistentry> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
136 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
137 <varlistentry> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
138 <term><userinput>Constant width bold</userinput></term> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
139 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
140 <listitem> |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
141 <para id="x_73d">Shows commands or other text that should be typed |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
142 literally by the user.</para> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
143 </listitem> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
144 </varlistentry> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
145 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
146 <varlistentry> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
147 <term><replaceable>Constant width italic</replaceable></term> |
26 | 148 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
149 <listitem> |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
150 <para id="x_73e">Shows text that should be replaced with user-supplied |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
151 values or by values determined by context.</para> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
152 </listitem> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
153 </varlistentry> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
154 </variablelist> |
200
9bba958be4c6
Mention automatic example generation.
Bryan O'Sullivan <bos@serpentine.com>
parents:
26
diff
changeset
|
155 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
156 <tip> |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
157 <para id="x_73f">This icon signifies a tip, suggestion, or general |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
158 note.</para> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
159 </tip> |
200
9bba958be4c6
Mention automatic example generation.
Bryan O'Sullivan <bos@serpentine.com>
parents:
26
diff
changeset
|
160 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
161 <caution> |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
162 <para id="x_740">This icon indicates a warning or caution.</para> |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
163 </caution> |
658
b90b024729f1
WIP DocBook snapshot that all compiles. Mirabile dictu!
Bryan O'Sullivan <bos@serpentine.com>
parents:
649
diff
changeset
|
164 </sect1> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
165 |
658
b90b024729f1
WIP DocBook snapshot that all compiles. Mirabile dictu!
Bryan O'Sullivan <bos@serpentine.com>
parents:
649
diff
changeset
|
166 <sect1> |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
167 <title>Using Code Examples</title> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
168 |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
169 <para id="x_741">This book is here to help you get your job done. In general, |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
170 you may use the code in this book in your programs and |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
171 documentation. You do not need to contact us for permission |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
172 unless you’re reproducing a significant portion of the code. For |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
173 example, writing a program that uses several chunks of code from |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
174 this book does not require permission. Selling or distributing a |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
175 CD-ROM of examples from O’Reilly books does require permission. |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
176 Answering a question by citing this book and quoting example |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
177 code does not require permission. Incorporating a significant |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
178 amount of example code from this book into your product’s |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
179 documentation does require permission.</para> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
180 |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
181 <para id="x_742">We appreciate, but do not require, attribution. An |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
182 attribution usually includes the title, author, publisher, and |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
183 ISBN. For example: “<emphasis>Book Title</emphasis> by Some |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
184 Author. Copyright 2008 O’Reilly Media, Inc., |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
185 978-0-596-xxxx-x.”</para> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
186 |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
187 <para id="x_743">If you feel your use of code examples falls outside fair use |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
188 or the permission given above, feel free to contact us at |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
189 <email>permissions@oreilly.com</email>.</para> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
190 </sect1> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
191 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
192 <sect1> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
193 <title>Safari® Books Online</title> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
194 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
195 <note role="safarienabled"> |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
196 <para id="x_744">When you see a Safari® Books Online icon on the cover of |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
197 your favorite technology book, that means the book is |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
198 available online through the O’Reilly Network Safari |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
199 Bookshelf.</para> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
200 </note> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
201 |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
202 <para id="x_745">Safari offers a solution that’s better than e-books. It’s a |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
203 virtual library that lets you easily search thousands of top |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
204 tech books, cut and paste code samples, download chapters, and |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
205 find quick answers when you need the most accurate, current |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
206 information. Try it for free at <ulink role="orm:hideurl:ital" |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
207 url="http://my.safaribooksonline.com/?portal=oreilly">http://my.safaribooksonline.com</ulink>.</para> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
208 </sect1> |
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
209 |
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
210 <sect1> |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
211 <title>How to Contact Us</title> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
212 |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
213 <para id="x_746">Please address comments and questions concerning this book |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
214 to the publisher:</para> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
215 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
216 <simplelist type="vert"> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
217 <member>O’Reilly Media, Inc.</member> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
218 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
219 <member>1005 Gravenstein Highway North</member> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
220 |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
221 <member>Sebastopol, CA 95472</member> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
222 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
223 <member>800-998-9938 (in the United States or Canada)</member> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
224 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
225 <member>707-829-0515 (international or local)</member> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
226 |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
227 <member>707 829-0104 (fax)</member> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
228 </simplelist> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
229 |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
230 <para id="x_747">We have a web page for this book, where we list errata, |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
231 examples, and any additional information. You can access this |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
232 page at:</para> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
233 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
234 <simplelist type="vert"> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
235 <member><ulink url="http://www.oreilly.com/catalog/<catalog |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
236 page>"></ulink></member> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
237 </simplelist> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
238 |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
239 <remark>Don’t forget to update the <url> attribute, |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
240 too.</remark> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
241 |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
242 <para id="x_748">To comment or ask technical questions about this book, send |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
243 email to:</para> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
244 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
245 <simplelist type="vert"> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
246 <member><email>bookquestions@oreilly.com</email></member> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
247 </simplelist> |
682
28b5a5befb08
Fold preface and intro into one
Bryan O'Sullivan <bos@serpentine.com>
parents:
680
diff
changeset
|
248 |
832
d5688822c51d
Preface, now with actual text
Bryan O'Sullivan <bos@serpentine.com>
parents:
831
diff
changeset
|
249 <para id="x_749">For more information about our books, conferences, Resource |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
250 Centers, and the O’Reilly Network, see our web site at:</para> |
26 | 251 |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
252 <simplelist type="vert"> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
253 <member><ulink url="http://www.oreilly.com"></ulink></member> |
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
254 </simplelist> |
658
b90b024729f1
WIP DocBook snapshot that all compiles. Mirabile dictu!
Bryan O'Sullivan <bos@serpentine.com>
parents:
649
diff
changeset
|
255 </sect1> |
b90b024729f1
WIP DocBook snapshot that all compiles. Mirabile dictu!
Bryan O'Sullivan <bos@serpentine.com>
parents:
649
diff
changeset
|
256 </preface> |
831
acf9dc5f088d
Add a skeletal preface.
Bryan O'Sullivan <bos@serpentine.com>
parents:
771
diff
changeset
|
257 |
658
b90b024729f1
WIP DocBook snapshot that all compiles. Mirabile dictu!
Bryan O'Sullivan <bos@serpentine.com>
parents:
649
diff
changeset
|
258 <!-- |
b90b024729f1
WIP DocBook snapshot that all compiles. Mirabile dictu!
Bryan O'Sullivan <bos@serpentine.com>
parents:
649
diff
changeset
|
259 local variables: |
b90b024729f1
WIP DocBook snapshot that all compiles. Mirabile dictu!
Bryan O'Sullivan <bos@serpentine.com>
parents:
649
diff
changeset
|
260 sgml-parent-document: ("00book.xml" "book" "preface") |
b90b024729f1
WIP DocBook snapshot that all compiles. Mirabile dictu!
Bryan O'Sullivan <bos@serpentine.com>
parents:
649
diff
changeset
|
261 end: |
b90b024729f1
WIP DocBook snapshot that all compiles. Mirabile dictu!
Bryan O'Sullivan <bos@serpentine.com>
parents:
649
diff
changeset
|
262 --> |