From Graham Bloice:
[obnox/wireshark/wip.git] / docbook / developer-guide.xml
index 2d5e99c8e7f542e086722d7ad64c38ae68d7a3a5..329a5ebe601ef977baa558da3286d8a4b4e01e55 100644 (file)
@@ -27,42 +27,67 @@ DOCUMENT SECTION
 -Use this section to encode all document information
 -->
 
-  <!ENTITY DocumentTitle "<application>Ethereal</application> Developer's Guide">
-  <!ENTITY DocumentSubTitle "">
-  <!ENTITY DocumentTitleAbbreviation "EDG">
+  <!ENTITY DocumentTitle "<application>Wireshark</application> Developer's Guide">
+  <!ENTITY DocumentSubTitle "&SvnVersion; for Wireshark &WiresharkCurrentVersion;">
+  <!ENTITY DocumentTitleAbbreviation "WSDG">
 
   <!ENTITY DocumentCopyrightHolder "Ulf Lamping">
-  <!ENTITY DocumentCopyrightYear "2004">
+  <!ENTITY DocumentCopyrightYear "2004-2007">
 
-  <!ENTITY DocumentEdition "First edition">
-  <!ENTITY DocumentPubDate "2004">
+  <!ENTITY DocumentEdition "Draft">
+  <!ENTITY DocumentVersion "Draft 0.0.3">
+  <!ENTITY DocumentPubDate "2007">
+  <!ENTITY % SvnVersionFile SYSTEM "svn_version.xml">
+  %SvnVersionFile;
 
-  <!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 DocumentLegalNotice "<para>Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation.</para><para>All logos and trademarks in this document are property of their respective owner.</para>">
 
-  <!ENTITY EtherealWebSite "http://www.ethereal.com">
-  <!ENTITY EtherealDownloadPage "&EtherealWebSite;/download.html">
-  <!ENTITY EtherealAuthorsPage "&EtherealWebSite;/introduction.html#authors">
-  <!ENTITY EtherealFAQPage "&EtherealWebSite;/faq.html">
-  <!ENTITY EtherealDevMailList "ethereal-dev[AT]ethereal.com">
-  <!ENTITY EtherealUsersGuidePage "&EtherealWebSite;/docs/#usersguide">
-  <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
+<!--
+Wireshark Info
+-->
+  <!ENTITY WiresharkCurrentVersion "0.99.5">
+  <!ENTITY WiresharkWebSite "http://www.wireshark.org">
+  <!ENTITY WiresharkDownloadPage "&WiresharkWebSite;/download/">
+  <!ENTITY WiresharkAuthorsPage "http://anonsvn.wireshark.org/wireshark/trunk/AUTHORS">
+  <!ENTITY WiresharkFAQPage "&WiresharkWebSite;/faq.html">
+  <!ENTITY WiresharkDevMailList "wireshark-dev[AT]wireshark.org">
+  <!ENTITY WiresharkDevsGuidePage "&WiresharkWebSite;/docs/">
+  <!ENTITY WiresharkUsersGuidePage "&WiresharkWebSite;/docs/">
+  <!ENTITY WiresharkWikiSite "http://wiki.wireshark.org">
+  <!ENTITY WiresharkBugsSite "http://bugs.wireshark.org">
 
 <!--
-Ethereal Info
+Gnu info
 -->
-  <!ENTITY EtherealCurrentVersion "0.10.6">
-  <!ENTITY EtherealNextMinorVersion "0.10.7">
+  <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
 
 <!--
 FILE SECTION
 -Use this section to specify the files that make up the book. Use FPI (public identifiers)
 -->
 
+<!-- These refer to graphics files and figures contained in the document -->
+
+  <!ENTITY WiresharkLogo SYSTEM "./wsdg_graphics/ws-logo.png" NDATA PNG>
+  <!ENTITY WiresharkFunctionBlocks SYSTEM "./wsdg_graphics/ws-function-blocks.png" NDATA PNG>
 
 <!-- These are the actual files that make up the document -->
-  <!ENTITY BookMetaInformation SYSTEM "dg-src/EDG_meta_info.xml">
-  <!ENTITY Preface SYSTEM "dg-src/EDG_preface.xml">
-  <!ENTITY Introduction SYSTEM "dg-src/EDG_chapter_introduction.xml">
+
+  <!ENTITY BookMetaInformation SYSTEM "wsdg_src/WSDG_meta_info.xml">
+  <!ENTITY Preface SYSTEM "wsdg_src/WSDG_preface.xml">
+  <!ENTITY EnvIntroduction SYSTEM "wsdg_src/WSDG_chapter_env_intro.xml">
+  <!ENTITY QuickSetup SYSTEM "wsdg_src/WSDG_chapter_quick_setup.xml">
+  <!ENTITY Tools SYSTEM "wsdg_src/WSDG_chapter_tools.xml">
+  <!ENTITY Libraries SYSTEM "wsdg_src/WSDG_chapter_libraries.xml">
+  <!ENTITY Sources SYSTEM "wsdg_src/WSDG_chapter_sources.xml">
+  
+  <!ENTITY BuildIntroduction SYSTEM "wsdg_src/WSDG_chapter_build_intro.xml">
+  <!ENTITY HowWiresharkWorks SYSTEM "wsdg_src/WSDG_chapter_works.xml">
+  <!ENTITY Capture SYSTEM "wsdg_src/WSDG_chapter_capture.xml">
+  <!ENTITY Dissection SYSTEM "wsdg_src/WSDG_chapter_dissection.xml">
+  <!ENTITY UserInterface SYSTEM "wsdg_src/WSDG_chapter_userinterface.xml">
+
+  <!ENTITY AppGPL SYSTEM    "GPL_appendix.xml">
 
 <!-- These refer to graphics files and figures contained in the document -->
   <!-- 1st Chapter -->
@@ -73,7 +98,60 @@ FILE SECTION
 <subtitle>&DocumentSubTitle;</subtitle>
 &BookMetaInformation;
 &Preface;
-&Introduction;
+<part id="PartEnvironment" label="I">
+<title>Wireshark Build Environment</title>
+<partintro>
+<para>
+<command>Part I. Wireshark Build Environment</command>
+</para>
+<para>
+<command>The first part describes how to set up the tools, libraries and 
+source needed to generate Wireshark, and how to do some typical development 
+tasks.</command>
+</para>
+<para>
+Part II. Wireshark Development
+</para>
+<para>
+The second part describes how the Wireshark sources are structured and how 
+to change the sources (e.g. adding a new dissector).
+</para>
+</partintro>
+&EnvIntroduction;
+&QuickSetup;
+&Sources;
+&Tools;
+&Libraries;
+</part>
+<part id="PartDevelopment" label="II">
+<title>Wireshark Development (incomplete)</title>
+<partintro>
+<!--<para>
+This is the second of two parts:
+</para>-->
+<para>
+Part I. Wireshark Build Environment
+</para>
+<para>
+The first part describes how to set up the tools, libraries and source needed 
+to generate Wireshark, and how to do some typical development tasks.
+</para>
+<para>
+<command>Part II. Wireshark Development</command>
+</para>
+<para>
+<command>The second part describes how the Wireshark sources are structured and how 
+to change the sources (e.g. adding a new dissector).</command>
+</para>
+</partintro>
+&HowWiresharkWorks;
+&BuildIntroduction;
+&Capture;
+&Dissection;
+&UserInterface;
+</part>
+
+&AppGPL;
 <!--
 
 &Glossary;