From: Miek Gieben <miekg@NLnetLabs.nl>
Date: Wed, 19 Jan 2005 10:26:26 +0000 (+0000)
Subject: I hate documenting. I hate documentation
X-Git-Tag: release-0.50~562
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=c28c22499820731411318a49434fc8a12f20bb2e;p=thirdparty%2Fldns.git

I hate documenting. I hate documentation
---

diff --git a/doc/API.xml b/doc/API.xml
new file mode 100644
index 00000000..f7129291
--- /dev/null
+++ b/doc/API.xml
@@ -0,0 +1,75 @@
+<?xml version="1.0"?>
+
+<!DOCTYPE rfc SYSTEM "rfc2629.dtd">
+<!-- $Id -->
+
+<?rfc toc="yes" ?>
+<?rfc compact="yes" ?>
+<?rfc editing="no" ?>
+<?rfc iprnotified="no" ?>
+<?rfc private="LibDNS API" ?>
+
+<rfc ipr="none" category="info" docName="libdns-api-00.txt">
+
+<front>
+<title>LibDNS API</title>
+    <author initials="R." surname="Gieben" fullname="Miek Gieben">
+     <organization>NLnet Labs</organization>
+      <address>
+        <postal>
+          <street>Kruislaan 419</street>
+          <city>Amsterdam</city>
+          <code>1098 VA</code>
+          <country>The Netherlands</country>
+        </postal>
+        <email>miek@nlnetlabs.nl</email>
+        <uri>http://www.nlnetlabs.nl</uri>
+      </address>
+    </author>
+    <author initials="J." surname="Jansen" fullname="Jelte Jansen">
+     <organization>NLnet Labs</organization>
+      <address>
+        <postal>
+          <street>Kruislaan 419</street>
+          <city>Amsterdam</city>
+          <code>1098 VA</code>
+          <country>The Netherlands</country>
+        </postal>
+        <email>jelte@nlnetlabs.nl</email>
+        <uri>http://www.nlnetlabs.nl</uri>
+      </address>
+    </author>
+    <author initials="E." surname="Rozendaal" fullname="Erik Rozendaal">
+     <organization>NLnet Labs</organization>
+      <address>
+        <postal>
+          <street>Kruislaan 419</street>
+          <city>Amsterdam</city>
+          <code>1098 VA</code>
+          <country>The Netherlands</country>
+        </postal>
+        <email>erik@nlnetlabs.nl</email>
+        <uri>http://www.nlnetlabs.nl</uri>
+      </address>
+    </author>
+<date month="January" year="2005" />
+<keyword>DNS</keyword>
+<keyword>Elite</keyword>
+<keyword>Hacking</keyword>
+<abstract>
+<t>
+A small abstract will come here, TBD.
+</t>
+</abstract>
+</front>
+
+<middle>
+
+<section title="API">
+<t>
+</t>
+</section> <!-- API -->
+</middle>  
+<back>
+</back>
+</rfc>
diff --git a/doc/rfc2629.dtd b/doc/rfc2629.dtd
new file mode 100644
index 00000000..9ae39b3c
--- /dev/null
+++ b/doc/rfc2629.dtd
@@ -0,0 +1,209 @@
+<!--
+  DTD for the RFC document series, draft of 99-01-30
+  -->
+
+
+<!--
+  Contents
+
+    DTD data types
+
+    The top-level
+
+    Front matter
+
+    The Body
+
+    Back matter
+  -->
+
+
+<!--
+  DTD data types:
+
+        entity        description
+        ======        ===============================================
+        NUMBER        [0-9]+
+        NUMBERS       a comma-separated list of NUMBER
+
+        DAY           the day of the month, e.g., "1"
+        MONTH         the month of the year, e.g., "January"
+        YEAR          a four-digit year, e.g., "1999"
+
+        URI           e.g., "http://invisible.net/"
+
+        ATEXT/CTEXT   printable ASCII text (no line-terminators)
+
+        TEXT          character data
+  -->
+
+
+<!ENTITY % NUMBER     "CDATA">
+<!ENTITY % NUMBERS    "CDATA">
+
+<!ENTITY % DAY        "CDATA">
+<!ENTITY % MONTH      "CDATA">
+<!ENTITY % YEAR       "CDATA">
+
+<!ENTITY % URI        "CDATA">
+
+<!ENTITY % ATEXT      "CDATA">
+<!ENTITY % CTEXT      "#PCDATA">
+
+<!ENTITY % TEXT       "#PCDATA">
+
+<!ENTITY   rfc.number "XXXX">
+
+
+<!--
+  The top-level
+  -->
+
+
+<!--
+  attributes for the "rfc" element are supplied by the RFC
+  editor. when preparing drafts, authors should leave them blank.
+
+  the "seriesNo" attribute is used if the category is, e.g., BCP.
+  -->
+<!ELEMENT rfc         (front,middle,back?)>
+<!ATTLIST rfc
+          number      %NUMBER;           #IMPLIED
+          obsoletes   %NUMBERS;          ""
+          updates     %NUMBERS;          ""
+          category    (std|bcp|info|exp|historic)
+                                         "info"
+          seriesNo    %NUMBER;           #IMPLIED
+          ipr         (full2026|noDerivativeWorks2026|none)
+                                         #IMPLIED
+          docName     %ATEXT;            #IMPLIED> 
+
+<!--
+  Front matter
+  -->
+
+
+<!ELEMENT front       (title,author+,date,area*,workgroup*,keyword*,
+                       abstract?,note*)>
+
+<!-- the "abbrev" attribute is used for headers, etc. -->
+<!ELEMENT title       (%CTEXT;)>
+<!ATTLIST title
+          abbrev      %ATEXT;            #IMPLIED> 
+
+<!ELEMENT author      (organization,address?)>
+<!ATTLIST author
+          initials    %ATEXT;            #IMPLIED
+          surname     %ATEXT;            #IMPLIED
+          fullname    %ATEXT;            #IMPLIED>
+
+<!ELEMENT organization
+                      (%CTEXT;)>
+<!ATTLIST organization
+          abbrev      %ATEXT;            #IMPLIED> 
+ 
+<!ELEMENT address     (postal?,phone?,facsimile?,email?,uri?)>
+
+<!-- at most one of each the city, region, code, and country
+     elements may be present -->
+<!ELEMENT postal      (street+,(city|region|code|country)*)>
+<!ELEMENT street      (%CTEXT;)>
+<!ELEMENT city        (%CTEXT;)>
+<!ELEMENT region      (%CTEXT;)>
+<!ELEMENT code        (%CTEXT;)>
+<!ELEMENT country     (%CTEXT;)>
+<!ELEMENT phone       (%CTEXT;)>
+<!ELEMENT facsimile   (%CTEXT;)>
+<!ELEMENT email       (%CTEXT;)>
+<!ELEMENT uri         (%CTEXT;)>
+
+<!ELEMENT date        EMPTY>
+<!ATTLIST date
+          day         %DAY;              #IMPLIED
+          month       %MONTH;            #REQUIRED
+          year        %YEAR;             #REQUIRED>
+
+<!-- meta-data... -->
+<!ELEMENT area        (%CTEXT;)>
+<!ELEMENT workgroup   (%CTEXT;)>
+<!ELEMENT keyword     (%CTEXT;)>
+
+<!ELEMENT abstract    (t)+>
+<!ELEMENT note        (t)+>
+<!ATTLIST note
+          title       %ATEXT;            #REQUIRED>
+
+
+<!--
+  The body
+  -->
+
+
+<!ELEMENT middle      (section)+>
+
+<!ELEMENT section     (t|figure|section)*>
+<!ATTLIST section
+          anchor      ID                 #IMPLIED
+          title       %ATEXT;            #REQUIRED>
+
+<!ELEMENT t           (%TEXT;|list|figure|xref|eref|iref|vspace)*>
+<!ATTLIST t
+          hangText    %ATEXT;            #IMPLIED>
+
+<!-- the value of the style attribute is inherited from the closest 
+     parent -->
+<!ELEMENT list        (t+)>
+<!ATTLIST list
+          style       (numbers|symbols|hanging|empty)
+                                         "empty">
+
+<!ELEMENT xref        (%CTEXT;)>
+<!ATTLIST xref
+          target      IDREF              #REQUIRED
+          pageno      (true|false)       "false">
+
+<!ELEMENT eref        (%CTEXT;)>
+<!ATTLIST eref
+          target      %URI;              #REQUIRED>
+
+<!ELEMENT iref        EMPTY>
+<!ATTLIST iref
+          item        %ATEXT;            #REQUIRED
+          subitem     %ATEXT;            "">
+
+<!ELEMENT vspace      EMPTY>
+<!ATTLIST vspace
+          blankLines  %NUMBER;           "0">
+
+<!ELEMENT figure      (preamble?,artwork,postamble?)>
+<!ATTLIST figure
+          anchor      ID                 #IMPLIED
+          title       %ATEXT;            "">
+
+<!ELEMENT preamble    (%TEXT;|xref|eref|iref)*>
+<!ELEMENT artwork     (%TEXT;)*>
+<!ATTLIST artwork
+          xml:space   (default|preserve) "preserve"
+          name        %ATEXT;            ""
+          type        %ATEXT;            "">
+
+<!ELEMENT postamble   (%TEXT;|xref|eref|iref)*>
+
+
+<!--
+  Back matter
+  -->
+
+
+<!-- sections, if present, are appendices -->
+<!ELEMENT back        (references?,section*)>
+
+<!ELEMENT references  (reference+)>
+<!ELEMENT reference   (front,seriesInfo*)>
+<!ATTLIST reference
+          anchor      ID                 #IMPLIED
+          target      %URI;              #IMPLIED>
+<!ELEMENT seriesInfo  EMPTY>
+<!ATTLIST seriesInfo
+          name        %ATEXT;            #REQUIRED
+          value       %ATEXT;            #REQUIRED>