very first steps for a "new" developer's guide

svn path=/trunk/; revision=11761

8 files changed, 164 insertions, 183 deletions

diff --git a/docbook/Makefile b/docbook/Makefile
index df840da41c..e038963df9 100644
--- a/docbook/Makefile
+++ b/docbook/Makefile
@@ -32,7 +32,9 @@ XSLTPROC="xsltproc"
 XMLLINT="xmllint"
 
 # as eug_chm will stop with an error, make sure it's the last in this dependency list
-all: eug_validate eug_pdf_a4 eug_html eug_html_chunked eug_chm 
+all: eug edg 
+
+eug: eug_validate eug_pdf_a4 eug_html eug_html_chunked eug_chm 
 
 clean:
 	rm -f *.html
@@ -109,3 +111,23 @@ ifdef HHC
 	rm -r htmlhelp.hhp
 	rm -r toc.hhc
 endif
+
+
+edg: edg_validate edg_html_chunked 
+#eug_pdf_a4 eug_html eug_chm 
+
+# validate the content
+edg_validate:
+	@ echo --- VALIDATING XML ---
+	$(XMLLINT) --valid --noout developer-guide.xml
+
+# create html chunked page files
+edg_html_chunked: images
+	@ echo --- HTML CHUNKED ---
+	mkdir -p edg_html_chunked
+	mkdir -p edg_html_chunked/graphics
+	mkdir -p edg_html_chunked/graphics/toolbar
+	cp ./graphics/*.* edg_html_chunked/graphics
+	cp ./graphics/toolbar/*.* edg_html_chunked/graphics/toolbar
+	$(XSLTPROC) --stringparam base.dir edg_html_chunked/ --stringparam  use.id.as.filename 1 --stringparam admon.graphics 1 --stringparam admon.graphics.path graphics/ --stringparam section.autolabel 1 --stringparam  section.label.includes.component.label 1 --nonet $(DOCBOOKXSL)/html/chunk.xsl developer-guide.xml
+
diff --git a/docbook/developer-guide.xml b/docbook/developer-guide.xml
index 40c604c663..f2951c4f09 100644
--- a/docbook/developer-guide.xml
+++ b/docbook/developer-guide.xml
@@ -10,15 +10,16 @@ BIOGRAPHICAL SECTION
 -->
 
 <!-- Authors Names -->
-  <!ENTITY AuthorFullName "Richard Sharpe">
-  <!ENTITY AuthorFirstName "Richard">
+  <!ENTITY AuthorFullName "Ulf Lamping">
+  <!ENTITY AuthorFirstName "Ulf">
   <!ENTITY AuthorOtherName "">
-  <!ENTITY AuthorSurname "Sharpe">
+  <!ENTITY AuthorSurname "Lamping">
+  <!ENTITY AuthorEmail "ulf.lamping[AT]web.de">
 
 <!--Authors Affiliation -->
   <!ENTITY AuthorShortAffiliation "">
-  <!ENTITY AuthorJobTitle "Director">
-  <!ENTITY AuthorOrgName "NS Computer Software and Services P/L">
+  <!ENTITY AuthorJobTitle "">
+  <!ENTITY AuthorOrgName "">
   <!ENTITY AuthorOrgDiv "">
 
 <!--
@@ -30,19 +31,22 @@ DOCUMENT SECTION
   <!ENTITY DocumentSubTitle "">
   <!ENTITY DocumentTitleAbbreviation "EDG">
 
-  <!ENTITY DocumentCopyrightHolder "NS Computer Software and Services P/L">
-  <!ENTITY DocumentCopyrightYear "2000">
+  <!ENTITY DocumentCopyrightHolder "Ulf Lamping">
+  <!ENTITY DocumentCopyrightYear "2004">
 
   <!ENTITY DocumentEdition "First edition">
-  <!ENTITY DocumentPubDate "2000">
+  <!ENTITY DocumentPubDate "2004">
 
-  <!ENTITY DocumentLegalNotice "<para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. A copy of the license is included in the section entitled &quot;GNU Free Documentation License&quot;</para>">
+  <!ENTITY DocumentLegalNotice "<para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation; with the Invariant Sections being LIST THEIR TITLES, with the Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. A copy of the license is included in the section entitled &quot;GNU Free Documentation License&quot;</para><para>All logos and trademarks in this document are property of their respective owner.</para>">
+
+  <!ENTITY EtherealWebSite "http://www.ethereal.com">
+  <!ENTITY EtherealDevMailList "ethereal-dev[AT]ethereal.com">
 
 <!--
 Ethereal Info
 -->
-  <!ENTITY EtherealCurrentVersion "0.8.10">
-  <!ENTITY EtherealNextMinorVersion "0.8.11">
+  <!ENTITY EtherealCurrentVersion "0.10.6">
+  <!ENTITY EtherealNextMinorVersion "0.10.7">
 
 <!--
 FILE SECTION
@@ -52,11 +56,7 @@ FILE SECTION
 
 <!-- These are the actual files that make up the document -->
   <!ENTITY BookMetaInformation SYSTEM "dg-src/EDG_meta_info.xml">
-  <!ENTITY Chapter1 SYSTEM "dg-src/EDG_chapter_one.xml">
-  <!ENTITY Chapter2 SYSTEM "dg-src/EDG_chapter_two.xml">
-  <!ENTITY Chapter3 SYSTEM "dg-src/EDG_chapter_three.xml">
-  <!ENTITY Chapter4 SYSTEM "dg-src/EDG_chapter_four.xml">
-  <!ENTITY Chapter5 SYSTEM "dg-src/EDG_chapter_five.xml">
+  <!ENTITY Preface SYSTEM "dg-src/EDG_preface.xml">
 
 <!-- These refer to graphics files and figures contained in the document -->
   <!-- 1st Chapter -->
@@ -66,11 +66,7 @@ FILE SECTION
 <title>&DocumentTitle;</title>
 <subtitle>&DocumentSubTitle;</subtitle>
 &BookMetaInformation;
-&Chapter1;
-&Chapter2;
-&Chapter3;
-&Chapter4;
-&Chapter5;
+&Preface;
 <!--
 
 &Glossary;
diff --git a/docbook/dg-src/EDG_chapter_five.xml b/docbook/dg-src/EDG_chapter_five.xml
deleted file mode 100644
index 50e36ff20d..0000000000
--- a/docbook/dg-src/EDG_chapter_five.xml
+++ /dev/null
@@ -1,14 +0,0 @@
-<!-- EDG Chapter Five -->
-<!-- $Id$-->
-
-<chapter id="Chap05">
-<title>Functions available to dissector writers</title>
-<section>
-<title>Groups 1</title>
-<para>
-<application>Ethereal</application> is perhaps one of blah blah...
-</para>
-</section>
-
-</chapter>
-<!-- End of EDG Chapter 5 -->
diff --git a/docbook/dg-src/EDG_chapter_four.xml b/docbook/dg-src/EDG_chapter_four.xml
deleted file mode 100644
index 9808922f62..0000000000
--- a/docbook/dg-src/EDG_chapter_four.xml
+++ /dev/null
@@ -1,35 +0,0 @@
-<!-- EDG Chapter Four -->
-<!-- $Id$ -->
-
-<chapter id="Chap04">
-<title>Writing a new dissector by example</title>
-<section>
-<title>Introduction</title>
-<para>
-<application>Ethereal</application> is perhaps one of blah blah...
-</para>
-</section>
-
-<section>
-<title>Producing the code</title>
-<para>Another para</para>
-</section>
-
-<section>
-<title>The files you have to create and modify</title>
-<para>A para</para>
-</section>
-
-<section>
-<title>Running autoconf.sh</title>
-<para>A para</para>
-</section>
-
-<section>
-<title>Contributing your new dissector</title>
-<para>A para</para>
-</section>
-
-</chapter>
-<!-- End of EDG Chapter 4 -->
-
diff --git a/docbook/dg-src/EDG_chapter_one.xml b/docbook/dg-src/EDG_chapter_one.xml
deleted file mode 100644
index 9e4ca79458..0000000000
--- a/docbook/dg-src/EDG_chapter_one.xml
+++ /dev/null
@@ -1,41 +0,0 @@
-<!-- EDG Chapter One -->
-<!-- $Id$ -->
-
-<chapter id="Chap01">
-<title>Introduction</title>
-  <!-- Introduction -->
-<section>
-<title>What is <application>Ethereal?</application></title>
-<para>
-<application>Ethereal</application> is perhaps one of blah blah...
-</para>
-</section>
-
-<section>
-<title>A rose by any other name</title>
-<para>One more</para>
-</section>
-
-<section>
-<title>A brief history of Ethereal</title>
-<para>One para</para>
-</section>
-
-<section>
-<title>Platforms Ethereal runs on</title>
-<para>One para</para>
-
-</section>
-
-<section>
-<title>Where to get Ethereal</title>
-<para>Another para</para>
-</section>
-
-<section>
-<title>Where to get the latest copy of this document</title>
-<para>Another para</para>
-</section>
-
-</chapter>
-<!-- End of EDG Chapter 1 -->
diff --git a/docbook/dg-src/EDG_chapter_three.xml b/docbook/dg-src/EDG_chapter_three.xml
deleted file mode 100644
index 6ba526eb29..0000000000
--- a/docbook/dg-src/EDG_chapter_three.xml
+++ /dev/null
@@ -1,36 +0,0 @@
-<!-- EDG Chapter Three -->
-<!-- $Id$ -->
-
-<chapter id="Chap03">
-<title>How Ethereal works</title>
-<section>
-<title>Introduction</title>
-<para>
-<application>Ethereal</application> is perhaps one of blah blah...
-</para>
-</section>
-
-<section>
-<title>Capturing packets</title>
-<!-- Including Windows versions -->
-<para>Another para</para>
-</section>
-
-<section>
-<title>Passes across the data</title>
-<para>Another para</para>
-</section>
-
-<section>
-<title>Calling the dissection routines</title>
-<para>Another para</para>
-
-</section>
-
-<section>
-<title>Parameters passed</title>
-<para>Another para</para>
-</section>
-
-</chapter>
-<!-- End of EDG Chapter 3 -->
diff --git a/docbook/dg-src/EDG_chapter_two.xml b/docbook/dg-src/EDG_chapter_two.xml
deleted file mode 100644
index 6e9e9eaf28..0000000000
--- a/docbook/dg-src/EDG_chapter_two.xml
+++ /dev/null
@@ -1,35 +0,0 @@
-<!-- EDG Chapter Two -->
-<!-- $Id$ -->
-
-<chapter id="Chap02">
-<title>What is packet sniffing</title>
-<section>
-<title>Introduction</title>
-<para>
-<application>Ethereal</application> is perhaps one of blah blah...
-</para>
-</section>
-
-<section>
-<title>tcpdump, libpcap and other tools</title>
-<para>A para here</para>
-</section>
-
-<section>
-<title>The structure of packets</title>
-<para>Another para</para>
-</section>
-
-<section>
-<title>How a packet's payload is handled</title>
-<para>Another para</para>
-
-</section>
-
-<section>
-<title>An introduction to wiretap</title>
-<para>Another para</para>
-</section>
-
-</chapter>
-<!-- End of EDG Chapter 2 -->
diff --git a/docbook/dg-src/EDG_preface.xml b/docbook/dg-src/EDG_preface.xml
new file mode 100644
index 0000000000..c7f9c7f4a6
--- /dev/null
+++ b/docbook/dg-src/EDG_preface.xml
@@ -0,0 +1,124 @@
+<!-- $Id: EUG_preface.xml 11618 2004-08-06 21:06:27Z jmayer $ -->

+

+<preface id="Preface">

+  <title>Preface</title>

+  <section id="PreForeword">

+  <title>Foreword</title>

+  <para>

+    Frequently people new to Ethereal development are asking questions 

+	about how to implement new features to Ethereal. This book tries to give 

+	you a guide to start your own experiments into the wonderful world of 

+	Ethereal development.

+  </para>

+  <para>

+    We hope that you find it useful, and look forward to your comments.

+  </para>

+  </section>

+

+  <section id="PreAudience">

+  <title>Who should read this document?</title>

+  <para>

+  The intended audience of this book is anyone going into the development of 

+  Ethereal.

+  </para>

+  <para>

+  This book is not intended to explain the usage of Ethereal in general. 

+  Please refer to the "Ethereal User's Guide" about Ethereal usage.

+  </para>

+  <para>

+  By reading this book, you will learn how to develop Ethereal. It will 

+  hopefully guide you around some common problems that frequently appears for 

+  new (and sometimes even advanced) developers of Ethereal.

+  </para>

+  </section>

+

+  <section id="PreAck">

+  <title>Acknowledgements</title>

+  <para>

+    The authors would like to thank the whole Ethereal team for their 

+	assistance. In particular, the authors would like to thank:

+    <itemizedlist>

+      <listitem>

+	<para>

+	  Gerald Combs, for initiating the Ethereal project.

+	</para>

+      </listitem>

+      <listitem>

+	<para>

+	  Guy Harris, for many helpful hints and a great deal of patience 

+	  in reviewing this document.

+	</para>

+      </listitem>

+    </itemizedlist>

+  </para>

+  <para>

+    The authors would also like to thank the following people for their 

+	helpful feedback on this document:

+    <itemizedlist>

+      <listitem>

+      <para>XXX - We hopefully might get some feedback in the future :-)

+      </para>

+      </listitem>

+    </itemizedlist>

+  </para>

+  </section>

+

+  <section id="PreAbout">

+    <title>About this document</title>

+    <para>

+      This book was developed by 

+      <ulink url="mailto:&AuthorEmail;">Ulf Lamping</ulink>.

+    </para>

+    <para>

+      It is written in DocBook/XML.

+    </para>

+    <para>

+	You will find some specially marked parts in this book:

+    </para>

+    <warning><title>This is a warning!</title>

+	<para>

+	You should pay attention to a warning, as otherwise data loss might occur.

+	</para>

+    </warning>

+    <note><title>This is a note!</title>

+	<para>

+	A note will point you to common mistakes and things that might not be 

+	obvious.

+	</para>

+    </note>

+    <tip><title>This is a tip!</title>

+	<para>

+	Tips will be helpful for your everyday work using Ethereal.

+	</para>

+    </tip>

+  </section>

+  

+  <section id="PreDownload">

+    <title>Where to get the latest copy of this document?</title>

+    <para>

+      The latest copy of this documentation can always be found at: 

+     <!-- <ulink url="&LatestVersionWebsite;">&LatestVersionWebsite;</ulink>; 

+      and at: --> 

+      <ulink url="&EtherealWebSite;/docs/developer-guide/"/>.

+    </para>

+   <!-- <para>

+      In addition, you can find a PDF version of the guide at: 

+      <ulink url="&LatestVersionPDFWebsiteA4;">

+	&LatestVersionPDFWebsiteA4;

+      </ulink> 

+      in A4 and 

+      <ulink url="&LatestVersionPDFWebsiteUSLetter;">

+	&LatestVersionPDFWebsiteUSLetter

+      </ulink> 

+      in US Letter.

+    </para> -->    

+  </section>

+

+  <section id="PreFeedback">

+    <title>Providing feedback about this document</title>

+    <para>

+      Should you have any feedback about this document, please send them 

+      to the authors through <ulink url="mailto:&EtherealDevMailList;">&EtherealDevMailList;</ulink>.

+    </para>

+  </section>

+</preface>