from Jaap Keuter:
[obnox/wireshark/wip.git] / docbook / edg_src / EDG_preface.xml
1 <!-- $Id$ -->
2
3 <preface id="Preface">
4   <title>Preface</title>
5   <section id="PreForeword">
6   <title>Foreword</title>
7   <para>
8         This book tries to give you a guide to start your own experiments into 
9         the wonderful world of Ethereal development.
10   </para>
11   <para>
12         Developers who are new to Ethereal are often having a hard time getting 
13         their development environment up and running. This is
14         especially true for Win32 developers, as a lot of the tools and methods
15         used when building Ethereal are much more common in the UNIX world than
16         on Win32.
17   </para>
18   <para>
19         The first part of this book will describe how to set up the environment 
20         needed to develop Ethereal.
21   </para>
22   <para>
23         The second part of this book will describe how to change the Ethereal 
24         source code.
25   </para>
26   <para>
27     We hope that you find this book useful, and look forward to your comments.
28   </para>
29   </section>
30
31   <section id="PreAudience">
32   <title>Who should read this document?</title>
33   <para>
34   The intended audience of this book is anyone going into the development of 
35   Ethereal.
36   </para>
37   <para>
38   This book is not intended to explain the usage of Ethereal in general. 
39   Please refer the 
40   <ulink url="&EtherealUsersGuidePage;">Ethereal User's Guide</ulink> 
41   about Ethereal usage.
42   </para>
43   <para>
44   By reading this book, you will learn how to develop Ethereal. It will 
45   hopefully guide you around some common problems that frequently appears for 
46   new (and sometimes even advanced) developers of Ethereal.
47   </para>
48   </section>
49
50   <section id="PreAck">
51   <title>Acknowledgements</title>
52   <para>
53     The authors would like to thank the whole Ethereal team for their 
54         assistance. In particular, the authors would like to thank:
55     <itemizedlist>
56       <listitem>
57         <para>
58           Gerald Combs, for initiating the Ethereal project.
59         </para>
60       </listitem>
61       <listitem>
62         <para>
63       Guy Harris, for many helpful hints and his effort in maintaining
64       the various contributions on the mailing lists.
65         </para>
66       </listitem>
67     </itemizedlist>
68   </para>
69   <para>
70     The authors would also like to thank the following people for their 
71         helpful feedback on this document:
72     <itemizedlist>
73       <listitem>
74       <para>XXX - Please give feedback :-)
75       </para>
76       </listitem>
77     </itemizedlist>
78         And of course a big thank you to the many, many contributors of the 
79         Ethereal development community!
80   </para>
81   </section>
82
83   <section id="PreAbout">
84     <title>About this document</title>
85     <para>
86       This book was developed by 
87       <ulink url="mailto:&AuthorEmail;">Ulf Lamping</ulink>.
88     </para>
89     <para>
90       It is written in DocBook/XML.
91     </para>
92     <para>
93         You will find some specially marked parts in this book:
94     </para>
95     <warning><title>This is a warning!</title>
96         <para>
97         You should pay attention to a warning, as otherwise data loss might occur.
98         </para>
99     </warning>
100     <note><title>This is a note!</title>
101         <para>
102         A note will point you to common mistakes and things that might not be 
103         obvious.
104         </para>
105     </note>
106     <tip><title>This is a tip!</title>
107         <para>
108         Tips will be helpful for your everyday work developing Ethereal.
109         </para>
110     </tip>
111   </section>
112   
113   <section id="PreDownload">
114     <title>Where to get the latest copy of this document?</title>
115     <para>
116       The latest copy of this documentation can always be found at: 
117      <!-- <ulink url="&LatestVersionWebsite;">&LatestVersionWebsite;</ulink>; 
118       and at: --> 
119       <ulink url="&EtherealWikiSite;/Development"/> in PDF (A4 and US letter)
120       and HTML (single and chunked) and CHM format.
121     </para>
122    <!-- <para>
123       In addition, you can find a PDF version of the guide at: 
124       <ulink url="&LatestVersionPDFWebsiteA4;">
125         &LatestVersionPDFWebsiteA4;
126       </ulink> 
127       in A4 and 
128       <ulink url="&LatestVersionPDFWebsiteUSLetter;">
129         &LatestVersionPDFWebsiteUSLetter
130       </ulink> 
131       in US Letter.
132     </para> -->    
133   </section>
134
135   <section id="PreFeedback">
136     <title>Providing feedback about this document</title>
137     <para>
138       Should you have any feedback about this document, please send it 
139       to the authors through <ulink url="mailto:&EtherealDevMailList;">&EtherealDevMailList;</ulink>.
140     </para>
141   </section>
142 </preface>