docbook/developer-guide.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4
   5 <!-- $Id$ -->
   6
   7 <!--
   8 BIOGRAPHICAL SECTION
   9 -Use this section to encode all biographical information
  10 -->
  11
  12 <!-- Authors Names -->
  13   <!ENTITY AuthorFullName "Ulf Lamping">
  14   <!ENTITY AuthorFirstName "Ulf">
  15   <!ENTITY AuthorOtherName "">
  16   <!ENTITY AuthorSurname "Lamping">
  17   <!ENTITY AuthorEmail "ulf.lamping[AT]web.de">
  18
  19 <!--Authors Affiliation -->
  20   <!ENTITY AuthorShortAffiliation "">
  21   <!ENTITY AuthorJobTitle "">
  22   <!ENTITY AuthorOrgName "">
  23   <!ENTITY AuthorOrgDiv "">
  24
  25 <!--
  26 DOCUMENT SECTION
  27 -Use this section to encode all document information
  28 -->
  29
  30   <!ENTITY DocumentTitle "<application>Ethereal</application> Developer's Guide">
  31   <!ENTITY DocumentSubTitle "&DocumentVersion; (&SvnVersion;) for Ethereal &EtherealCurrentVersion;">
  32   <!ENTITY DocumentTitleAbbreviation "EDG">
  33
  34   <!ENTITY DocumentCopyrightHolder "Ulf Lamping">
  35   <!ENTITY DocumentCopyrightYear "2004-2005">
  36
  37   <!ENTITY DocumentEdition "Draft">
  38   <!ENTITY DocumentVersion "Draft 0.0.2">
  39   <!ENTITY DocumentPubDate "2005">
  40   <!ENTITY % SvnVersionFile SYSTEM "svn_version.xml">
  41   %SvnVersionFile;
  42
  43 <!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>">
  44
  45   <!ENTITY EtherealWebSite "http://www.ethereal.com">
  46   <!ENTITY EtherealDownloadPage "&EtherealWebSite;/download.html">
  47   <!ENTITY EtherealAuthorsPage "&EtherealWebSite;/introduction.html#authors">
  48   <!ENTITY EtherealFAQPage "&EtherealWebSite;/faq.html">
  49   <!ENTITY EtherealDevMailList "ethereal-dev[AT]ethereal.com">
  50   <!ENTITY EtherealUsersGuidePage "&EtherealWebSite;/docs/#usersguide">
  51   <!ENTITY GPLWebsite "http://www.gnu.org/copyleft/gpl.html">
  52
  53 <!--
  54 Ethereal Info
  55 -->
  56   <!ENTITY EtherealCurrentVersion "0.10.9">
  57
  58 <!--
  59 FILE SECTION
  60 -Use this section to specify the files that make up the book. Use FPI (public identifiers)
  61 -->
  62
  63 <!-- These refer to graphics files and figures contained in the document -->
  64
  65   <!ENTITY EtherealLogo SYSTEM "./edg_graphics/ethereal-logo.png" NDATA PNG>
  66   <!ENTITY EtherealFunctionBlocks SYSTEM "./edg_graphics/ethereal-function-blocks.png" NDATA PNG>
  67
  68 <!-- These are the actual files that make up the document -->
  69
  70   <!ENTITY BookMetaInformation SYSTEM "edg_src/EDG_meta_info.xml">
  71   <!ENTITY Preface SYSTEM "edg_src/EDG_preface.xml">
  72   <!ENTITY EnvIntroduction SYSTEM "edg_src/EDG_chapter_env_intro.xml">
  73   <!ENTITY Tools SYSTEM "edg_src/EDG_chapter_tools.xml">
  74   <!ENTITY Libraries SYSTEM "edg_src/EDG_chapter_libraries.xml">
  75   <!ENTITY Sources SYSTEM "edg_src/EDG_chapter_sources.xml">
  76
  77   <!ENTITY BuildIntroduction SYSTEM "edg_src/EDG_chapter_build_intro.xml">
  78   <!ENTITY HowEtherealWorks SYSTEM "edg_src/EDG_chapter_works.xml">
  79   <!ENTITY Capture SYSTEM "edg_src/EDG_chapter_capture.xml">
  80   <!ENTITY Dissection SYSTEM "edg_src/EDG_chapter_dissection.xml">
  81   <!ENTITY UserInterface SYSTEM "edg_src/EDG_chapter_userinterface.xml">
  82
  83   <!ENTITY AppGPL SYSTEM    "GPL_appendix.xml">
  84
  85 <!-- These refer to graphics files and figures contained in the document -->
  86   <!-- 1st Chapter -->
  87 ]>
  88
  89 <book>
  90 <title>&DocumentTitle;</title>
  91 <subtitle>&DocumentSubTitle;</subtitle>
  92 &BookMetaInformation;
  93 &Preface;
  94 <part id="PartEnvironment" label="I">
  95 <title>Ethereal Build Environment</title>
  96 <partintro>
  97 <para>
  98 <command>Part I. Ethereal Build Environment</command>
  99 </para>
 100 <para>
 101 <command>The first part describes how to set up the tools, libraries and
 102 source needed to generate Ethereal, and how to do some typical development
 103 tasks.</command>
 104 </para>
 105 <para>
 106 Part II. Ethereal Development
 107 </para>
 108 <para>
 109 The second part describes how the Ethereal sources are structured and how
 110 to change the sources (e.g. adding a new dissector).
 111 </para>
 112 </partintro>
 113 &EnvIntroduction;
 114 &Tools;
 115 &Libraries;
 116 &Sources;
 117 </part>
 118 <part id="PartDevelopment" label="II">
 119 <title>Ethereal Development (incomplete)</title>
 120 <partintro>
 121 <!--<para>
 122 This is the second of two parts:
 123 </para>-->
 124 <para>
 125 Part I. Ethereal Build Environment
 126 </para>
 127 <para>
 128 The first part describes how to set up the tools, libraries and source needed
 129 to generate Ethereal, and how to do some typical development tasks.
 130 </para>
 131 <para>
 132 <command>Part II. Ethereal Development</command>
 133 </para>
 134 <para>
 135 <command>The second part describes how the Ethereal sources are structured and how
 136 to change the sources (e.g. adding a new dissector).</command>
 137 </para>
 138 </partintro>
 139 &HowEtherealWorks;
 140 &BuildIntroduction;
 141 &Capture;
 142 &Dissection;
 143 &UserInterface;
 144 </part>
 145
 146 &AppGPL;
 147 <!--
 148
 149 &Glossary;
 150 &Index;  -->
 151 </book>