Switch to XInclude from SYSTEM entities for module inclusion to work around

a bug in xsltproc which prevents xref resolution in complex documents
(http://bugzilla.gnome.org/show_bug.cgi?id=96925).

This pretty much ties us to xsltproc for the time being. To use another
XSLT engine, try running the top-level file through 'xmllint --xinclude'
first.

Running things through 'xmllint --noent' is also an effective work around,
but xinclude is nicer for most of our purposes.

Also corrects a nesting problem in the residue decode section.

svn path=/trunk/vorbis/; revision=4063

diff --git a/doc/xml/01-introduction.xml b/doc/xml/01-introduction.xml
index c5f94b9..bb12102 100644 (file)
--- a/doc/xml/01-introduction.xml
+++ b/doc/xml/01-introduction.xml
@@ -1,7 +1,13 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+]>
+
 <section id="vorbis-spec-intro">
 <sectioninfo>
 <releaseinfo>
- $Id: 01-introduction.xml,v 1.4 2002/10/21 23:36:59 giles Exp $
+ $Id: 01-introduction.xml,v 1.5 2002/10/27 14:55:31 giles Exp $
 <emphasis>Last update to this document: July 18, 2002</emphasis>
 </releaseinfo>
 </sectioninfo>
@@ -12,8 +18,8 @@
 
 <para>
 This document provides a high level description of the Vorbis codec's
-construction.  A bit-by-bit specification appears beginning in <xref
-linkend="vorbis-spec-codec"/>. The later sections assume a high-level
+construction.  A bit-by-bit specification appears beginning in <xref linkend="vorbis-spec-codec"/>.
+The later sections assume a high-level
 understanding of the Vorbis decode process, which is 
 provided here.</para>
 

diff --git a/doc/xml/02-bitpacking.xml b/doc/xml/02-bitpacking.xml
index 2a65128..0c3a230 100644 (file)
--- a/doc/xml/02-bitpacking.xml
+++ b/doc/xml/02-bitpacking.xml
@@ -1,7 +1,13 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+]>
+
 <section id="vorbis-spec-bitpacking">
 <sectioninfo>
 <releaseinfo>
- $Id: 02-bitpacking.xml,v 1.4 2002/10/21 23:37:00 giles Exp $
+ $Id: 02-bitpacking.xml,v 1.5 2002/10/27 14:55:31 giles Exp $
  <emphasis>Last update to this document: July 14, 2002</emphasis>
 </releaseinfo>
 </sectioninfo>

diff --git a/doc/xml/03-codebook.xml b/doc/xml/03-codebook.xml
index c14e1a0..e178bf6 100644 (file)
--- a/doc/xml/03-codebook.xml
+++ b/doc/xml/03-codebook.xml
@@ -1,7 +1,13 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+]>
+
 <section id="vorbis-spec-codebook">
 <sectioninfo>
 <releaseinfo>
- $Id: 03-codebook.xml,v 1.3 2002/10/21 23:37:00 giles Exp $
+ $Id: 03-codebook.xml,v 1.4 2002/10/27 14:55:31 giles Exp $
  <emphasis>Last update to this document: August 8, 2002</emphasis>
 </releaseinfo>
 </sectioninfo>

diff --git a/doc/xml/04-codec.xml b/doc/xml/04-codec.xml
index 1d53868..d210a32 100644 (file)
--- a/doc/xml/04-codec.xml
+++ b/doc/xml/04-codec.xml
@@ -1,7 +1,13 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY pi     "&#x03C0;"> <!-- GREEK SMALL LETTER PI -->
+]>
+
 <section id="vorbis-spec-codec">
 <sectioninfo>
 <releaseinfo>
- $Id: 04-codec.xml,v 1.5 2002/10/25 14:41:13 giles Exp $
+ $Id: 04-codec.xml,v 1.6 2002/10/27 14:55:31 giles Exp $
  <emphasis>Last update to this document: October 15, 2002</emphasis>
 </releaseinfo>
 </sectioninfo>

diff --git a/doc/xml/05-comment.xml b/doc/xml/05-comment.xml
index 71ef341..916dde4 100644 (file)
--- a/doc/xml/05-comment.xml
+++ b/doc/xml/05-comment.xml
@@ -1,7 +1,13 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+<!ENTITY uuml "&#x00FC;"> <!-- Latin small letter u with diaeresis -->
+]>
+
 <section id="vorbis-spec-comment">
 <sectioninfo>
  <releaseinfo>
- $Id: 05-comment.xml,v 1.3 2002/10/25 14:41:44 giles Exp $
+ $Id: 05-comment.xml,v 1.4 2002/10/27 14:55:31 giles Exp $
  <emphasis>Last update to this document: July 16, 2002</emphasis>
 </releaseinfo>
 </sectioninfo>

diff --git a/doc/xml/06-floor0.xml b/doc/xml/06-floor0.xml
index 9260333..89b860c 100644 (file)
--- a/doc/xml/06-floor0.xml
+++ b/doc/xml/06-floor0.xml
@@ -1,7 +1,13 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+]>
+
 <section id="vorbis-spec-floor0">
 <sectioninfo>
 <releaseinfo>
-  $Id: 06-floor0.xml,v 1.5 2002/10/26 15:43:57 giles Exp $
+  $Id: 06-floor0.xml,v 1.6 2002/10/27 14:55:31 giles Exp $
   <emphasis>Last update to this document: July 19, 2002</emphasis>
 </releaseinfo>
 </sectioninfo>  

diff --git a/doc/xml/07-floor1.xml b/doc/xml/07-floor1.xml
index 31b40ee..748166d 100644 (file)
--- a/doc/xml/07-floor1.xml
+++ b/doc/xml/07-floor1.xml
@@ -1,7 +1,13 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+]>
+
 <section id="vorbis-spec-floor1">
 <sectioninfo>
 <releaseinfo>
- $Id: 07-floor1.xml,v 1.2 2002/10/18 00:43:00 giles Exp $
+ $Id: 07-floor1.xml,v 1.3 2002/10/27 14:55:31 giles Exp $
  <emphasis>Last update to this document: October 15, 2002</emphasis>
 </releaseinfo>
 </sectioninfo>

diff --git a/doc/xml/08-residue.xml b/doc/xml/08-residue.xml
index def2bb8..8b34315 100644 (file)
--- a/doc/xml/08-residue.xml
+++ b/doc/xml/08-residue.xml
@@ -1,7 +1,13 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+]>
+
 <section id="vorbis-spec-residue">
 <sectioninfo>
  <releaseinfo>
-  $Id: 08-residue.xml,v 1.2 2002/10/13 15:18:47 giles Exp $
+  $Id: 08-residue.xml,v 1.3 2002/10/27 14:55:31 giles Exp $
   <emphasis>Last update to this document: July 19, 2002</emphasis>
  </releaseinfo>
 </sectioninfo>
@@ -176,8 +182,6 @@ vector to begin with, residue type 1 and type 2 are equivalent.</para>
 
 </section>
 
-</section>
-
 <section>
 <title>Residue decode</title>
 
@@ -451,3 +455,5 @@ decoded.</para>
 </section>
 
 </section>
+
+</section>

diff --git a/doc/xml/09-helper.xml b/doc/xml/09-helper.xml
index 7da24f0..e674a8b 100644 (file)
--- a/doc/xml/09-helper.xml
+++ b/doc/xml/09-helper.xml
@@ -1,7 +1,13 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+]>
+
 <section id="vorbis-spec-helper">
 <sectioninfo>
 <releaseinfo>
- $Id: 09-helper.xml,v 1.3 2002/10/16 21:43:32 giles Exp $
+ $Id: 09-helper.xml,v 1.4 2002/10/27 14:55:31 giles Exp $
  <emphasis>Last update to this document: October 15, 2002</emphasis>
 </releaseinfo>
 </sectioninfo>

diff --git a/doc/xml/10-tables.xml b/doc/xml/10-tables.xml
index 4bc50c1..584758d 100644 (file)
--- a/doc/xml/10-tables.xml
+++ b/doc/xml/10-tables.xml
@@ -1,7 +1,13 @@
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+]>
+
 <section id="vorbis-spec-tables">
 <sectioninfo>
  <releaseinfo>
-  $Id: 10-tables.xml,v 1.1 2002/10/12 20:37:11 giles Exp $
+  $Id: 10-tables.xml,v 1.2 2002/10/27 14:55:31 giles Exp $
   <emphasis>Last update to this document: July 18, 2002</emphasis>
  </releaseinfo>
 </sectioninfo>

diff --git a/doc/xml/Vorbis_I_spec.xml b/doc/xml/Vorbis_I_spec.xml
index 5813be7..82a79f9 100644 (file)
--- a/doc/xml/Vorbis_I_spec.xml
+++ b/doc/xml/Vorbis_I_spec.xml
@@ -6,18 +6,6 @@
 <!ENTITY uuml "&#x00FC;"> <!-- Latin small letter u with diaeresis -->
 <!-- parser isn't finding %isogrk3; -->
 <!ENTITY pi    "&#x03C0;"> <!-- GREEK SMALL LETTER PI -->
-<!ENTITY intro SYSTEM "01-introduction.xml">
-<!ENTITY bitpacking SYSTEM "02-bitpacking.xml">
-<!ENTITY codebook SYSTEM "03-codebook.xml">
-<!ENTITY codec SYSTEM "04-codec.xml">
-<!ENTITY comment SYSTEM "05-comment.xml">
-<!ENTITY floor0 SYSTEM "06-floor0.xml">
-<!ENTITY floor1 SYSTEM "07-floor1.xml">
-<!ENTITY residue SYSTEM "08-residue.xml">
-<!ENTITY helpers SYSTEM "09-helper.xml">
-<!ENTITY tables SYSTEM "10-tables.xml">
-<!ENTITY oggvorbis SYSTEM "a1-encapsulation_ogg.xml">
-<!ENTITY rtpvorbis SYSTEM "a2-encapsulation_rtp.xml">
 <!ENTITY colophon SYSTEM "footer.xml">
 ]>
 
@@ -27,18 +15,20 @@
   <corpauthor>Xiph.org Foundation</corpauthor>
 </articleinfo>
 
-&intro;
-&bitpacking;
-&codebook;
-&codec;
-&comment;
-&floor0;
-&floor1;
-&residue;
-&helpers;
-&tables;
-&oggvorbis;
-&rtpvorbis;
-&colophon;
+ <xi:include href="01-introduction.xml"  xmlns:xi="http://www.w3.org/2001/XInclude"/> 
+ <xi:include href="02-bitpacking.xml"    xmlns:xi="http://www.w3.org/2001/XInclude"/> 
+ <xi:include href="03-codebook.xml"      xmlns:xi="http://www.w3.org/2001/XInclude"/> 
+ <xi:include href="04-codec.xml"         xmlns:xi="http://www.w3.org/2001/XInclude"/> 
+ <xi:include href="05-comment.xml"       xmlns:xi="http://www.w3.org/2001/XInclude"/> 
+ <xi:include href="06-floor0.xml"        xmlns:xi="http://www.w3.org/2001/XInclude"/> 
+ <xi:include href="07-floor1.xml"        xmlns:xi="http://www.w3.org/2001/XInclude"/> 
+ <xi:include href="08-residue.xml"       xmlns:xi="http://www.w3.org/2001/XInclude"/> 
+ <xi:include href="09-helper.xml"        xmlns:xi="http://www.w3.org/2001/XInclude"/> 
+ <xi:include href="10-tables.xml"        xmlns:xi="http://www.w3.org/2001/XInclude"/> 
+
+ <xi:include href="a1-encapsulation_ogg.xml"  xmlns:xi="http://www.w3.org/2001/XInclude"/> 
+ <xi:include href="a2-encapsulation_rtp.xml"  xmlns:xi="http://www.w3.org/2001/XInclude"/>
+
+ <xi:include href="footer.xml"           xmlns:xi="http://www.w3.org/2001/XInclude"/>
 
 </article>

diff --git a/doc/xml/a1-encapsulation_ogg.xml b/doc/xml/a1-encapsulation_ogg.xml
index ff6ea4d..f4bcb12 100644 (file)
--- a/doc/xml/a1-encapsulation_ogg.xml
+++ b/doc/xml/a1-encapsulation_ogg.xml
@@ -1,9 +1,14 @@
-<?xml version="1.0" ?>
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+]>
+
 <appendix id="vorbis-over-ogg">
 <appendixinfo>
  <releaseinfo>
   <emphasis>Last update to this document: July 14, 2002</emphasis>
-  $Id: a1-encapsulation_ogg.xml,v 1.1 2002/10/16 22:46:44 giles Exp $
+  $Id: a1-encapsulation_ogg.xml,v 1.2 2002/10/27 14:55:31 giles Exp $
  </releaseinfo>
 </appendixinfo>
 <title>Embedding Vorbis into an Ogg stream</title>

diff --git a/doc/xml/a2-encapsulation_rtp.xml b/doc/xml/a2-encapsulation_rtp.xml
index e3b705b..370717b 100644 (file)
--- a/doc/xml/a2-encapsulation_rtp.xml
+++ b/doc/xml/a2-encapsulation_rtp.xml
@@ -1,14 +1,19 @@
-<?xml version="1.0" ?>
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+]>
+
 <appendix id="vorbis-over-rtp">
 <appendixinfo>
  <releaseinfo>
-  <emphasis>$Id: a2-encapsulation_rtp.xml,v 1.2 2002/10/26 13:21:35 giles Exp $</emphasis>
+  <emphasis>$Id: a2-encapsulation_rtp.xml,v 1.3 2002/10/27 14:55:31 giles Exp $</emphasis>
  </releaseinfo>
 </appendixinfo>
 <title>Vorbis encapsulation in RTP</title>
 
 <literallayout class="monospaced">
-<!-- this works with extensions implemented in Saxon and Xalan 
+<!-- this works with extensions implemented in Saxon and Xalan
 <textobject><textdata fileref="../draft-moffitt-vorbis-rtp-00.txt"/></textobject> -->
 <!-- this works with xinclude, implemented in xsltproc -->
 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"

diff --git a/doc/xml/footer.xml b/doc/xml/footer.xml
index 11ad308..d4a10b3 100644 (file)
--- a/doc/xml/footer.xml
+++ b/doc/xml/footer.xml
@@ -1,4 +1,11 @@
-<!-- articles can't have an explicit colophon -->
+<?xml version="1.0" standalone="no"?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+
+]>
+<!-- footer or colophon for xiph.org documents -->
+
+<!-- articles aren't permitted an explicit colophon -->
 <appendix id="footer">
 <title>Colophon</title>
 
@@ -19,7 +26,7 @@
 </mediaobject>
 
 <para>
-Ogg is a <ulink url="http://www.xiph.org">Xiph.org Foundation</ulink> effort
+Ogg is a <ulink url="http://www.xiph.org/">Xiph.org Foundation</ulink> effort
 to protect essential tenets of Internet multimedia from corporate
 hostage-taking; Open Source is the net's greatest tool to keep
 everyone honest. See <ulink url="http://www.xiph.org/about.html">About
@@ -50,3 +57,4 @@ This document is set in DocBook XML.
 </para>
 
 </appendix>
+<!-- end of colophon -->