Bug 232378: switch from entities to XIncludes for inclusion of modular docs files

Patch by Colin Ogilvie <colin.ogilvie@gmail.com>; r=vladd

16 files changed, 184 insertions, 98 deletions

diff --git a/docs/xml/Bugzilla-Guide.xml b/docs/xml/Bugzilla-Guide.xml
index 58a75448e..72db6e7fa 100644
--- a/docs/xml/Bugzilla-Guide.xml
+++ b/docs/xml/Bugzilla-Guide.xml
@@ -1,23 +1,9 @@
-<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd" [
-
-<!-- Include macros -->
-<!ENTITY about SYSTEM "about.xml">
-<!ENTITY conventions SYSTEM "conventions.xml">
-<!ENTITY doc-index SYSTEM "index.xml">
-<!ENTITY faq SYSTEM "faq.xml">
-<!ENTITY gfdl SYSTEM "gfdl.xml">
-<!ENTITY glossary SYSTEM "glossary.xml">
-<!ENTITY installation SYSTEM "installation.xml">
-<!ENTITY administration SYSTEM "administration.xml">
-<!ENTITY security SYSTEM "security.xml">
-<!ENTITY using SYSTEM "using.xml">
-<!ENTITY integration SYSTEM "integration.xml">
-<!ENTITY index SYSTEM "index.xml">
-<!ENTITY customization SYSTEM "customization.xml">
-<!ENTITY troubleshooting SYSTEM "troubleshooting.xml">
-<!ENTITY patches SYSTEM "patches.xml">
-<!ENTITY introduction SYSTEM "introduction.xml">
-<!ENTITY modules SYSTEM "modules.xml">
+<?xml version="1.0"?>
+<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                      "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
 
 <!-- Things to change for a stable release:
      * bz-ver to current stable
@@ -31,47 +17,6 @@
      For a devel release, simple bump bz-ver and bz-date
 -->
 
-<!ENTITY bz-ver "2.22rc1">
-<!ENTITY bz-nextver "2.22">
-<!ENTITY bz-date "2006-02-20">
-<!ENTITY current-year "2006">
-
-<!ENTITY landfillbase "http://landfill.bugzilla.org/bugzilla-tip/">
-<!ENTITY bz "http://www.bugzilla.org/">
-<!ENTITY bzg-bugs "<ulink url='http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation'>Bugzilla Documentation</ulink>">
-<!ENTITY mysql "http://www.mysql.com/">
-
-<!-- For minimum versions -->
-<!ENTITY min-mysql-ver "4.0.14">
-<!ENTITY min-pg-ver "7.3.x">
-<!ENTITY min-perl-ver "5.6.1">
-<!ENTITY min-perl-ver-win "5.8.1">
-<!ENTITY min-template-ver "2.08">
-<!ENTITY min-file-temp-ver "any">
-<!ENTITY min-appconfig-ver "1.52">
-<!ENTITY min-text-wrap-ver "2001.0131">
-<!ENTITY min-file-spec-ver "0.84">
-<!ENTITY min-data-dumper-ver "any">
-<!ENTITY min-dbd-mysql-ver "2.9003">
-<!ENTITY min-dbd-pg-ver "1.31">
-<!ENTITY min-dbi-ver "1.38">
-<!ENTITY min-date-format-ver "2.21">
-<!ENTITY min-cgi-ver "2.93">
-<!ENTITY min-mail-mailer-ver "1.67">
-<!ENTITY min-mime-base64-ver "3.01">
-<!ENTITY min-mime-parser-ver "5.406">
-<!ENTITY min-storable-ver "any">
-<!-- Optional modules -->
-<!ENTITY min-gd-ver "1.20">
-<!ENTITY min-gd-graph-ver "any">
-<!ENTITY min-gd-text-align-ver "any">
-<!ENTITY min-chart-base-ver "1.0">
-<!ENTITY min-xml-parser-ver "any">
-<!ENTITY min-patchreader-ver "0.9.4">
-<!ENTITY min-image-magick-ver "any">
-
-]>
-
 
 <!-- Coding standards for this document 
 
@@ -141,43 +86,43 @@
   </bookinfo>
 
 <!-- About This Guide -->
-&about;
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="about.xml" /> 
 
 <!-- Installing Bugzilla -->
-&installation;
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="installation.xml" />
 
 <!-- Administering Bugzilla -->
-&administration;
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="administration.xml" />
 
 <!-- Securing Bugzilla -->
-&security;
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="security.xml" />
 
 <!-- Customizing Bugzilla -->
-&customization;
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="customization.xml" />
 
 <!-- Using Bugzilla -->
-&using;
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="using.xml" />
 
 <!-- Appendix: The Frequently Asked Questions -->
-&faq;
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="faq.xml" />
 
 <!-- Appendix: Troubleshooting -->
-&troubleshooting;
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="troubleshooting.xml" />
 
 <!-- Appendix: Custom Patches -->
-&patches;
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="patches.xml" />
 
 <!-- Appendix: Manually Installing Perl Modules -->
-&modules;
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="modules.xml" />
 
 <!-- Appendix: GNU Free Documentation License -->
-&gfdl;
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="gfdl.xml" />
 
 <!-- Glossary -->
-&glossary;
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="glossary.xml" />
 
 <!-- Index -->
-&index;
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="index.xml" />
 
 
 </book>
diff --git a/docs/xml/about.xml b/docs/xml/about.xml
index a6f51d7e0..b1dab24f6 100644
--- a/docs/xml/about.xml
+++ b/docs/xml/about.xml
@@ -1,6 +1,9 @@
-<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
-<!ENTITY conventions SYSTEM "conventions.xml"> ] > -->
-<!-- $Id: about.xml,v 1.19 2005/01/14 12:08:47 jake%bugzilla.org Exp $ -->
+<?xml version="1.0"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
 
 <chapter id="about">
 <title>About This Guide</title>
@@ -209,9 +212,9 @@
     </para>
   </section>
 
-  <!-- conventions used here (didn't want to give it a chapter of its own) -->
-&conventions;
- </chapter> 
+<!-- conventions used here (didn't want to give it a chapter of its own) -->
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="conventions.xml" /> 
+</chapter> 
 
 <!-- Keep this comment at the end of the file 
 Local variables: 
diff --git a/docs/xml/administration.xml b/docs/xml/administration.xml
index a32a61a59..99fd98c88 100644
--- a/docs/xml/administration.xml
+++ b/docs/xml/administration.xml
@@ -1,4 +1,10 @@
-<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
+<?xml version="1.0"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                      "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
+
 <chapter id="administration">
   <title>Administering Bugzilla</title>
 
diff --git a/docs/xml/bugzilla.ent b/docs/xml/bugzilla.ent
new file mode 100755
index 000000000..ee539d15a
--- /dev/null
+++ b/docs/xml/bugzilla.ent
@@ -0,0 +1,74 @@
+<?xml version="1.0"?>
+
+<!-- While Using OpenJade to Process the files this section is needed in the
+entity file -->
+
+<!ELEMENT xi:include (xi:fallback?) >
+<!ATTLIST xi:include
+    xmlns:xi   CDATA       #FIXED    "http://www.w3.org/2001/XInclude"
+    href       CDATA       #REQUIRED
+    parse      (xml|text)  "xml"
+    encoding   CDATA       #IMPLIED >
+
+<!ELEMENT xi:fallback ANY>
+<!ATTLIST xi:fallback
+    xmlns:xi   CDATA   #FIXED   "http://www.w3.org/2001/XInclude" >
+<!ENTITY % local.chapter.class "| xi:include"> 
+<!-- inside chapter or section elements -->
+<!ENTITY % local.divcomponent.mix "| xi:include">
+<!-- inside para, programlisting, literallayout, etc. -->   
+<!ENTITY % local.para.char.mix "| xi:include">
+<!-- inside bookinfo, chapterinfo, etc. -->      
+<!ENTITY % local.info.class "| xi:include">         
+
+
+<!-- Things to change for a stable release:
+     * bz-ver to current stable
+     * bz-nexver to next stable
+     * bz-date to the release date
+     * Remove the BZ-DEVEL comments
+     - COMPILE DOCS AND CHECKIN -
+       Also, tag and tarball before completing
+     * bz-ver to devel version
+ 
+     For a devel release, simple bump bz-ver and bz-date
+-->
+
+<!ENTITY bz-ver "2.22rc1">
+<!ENTITY bz-nextver "2.22">
+<!ENTITY bz-date "2006-02-20">
+<!ENTITY current-year "2006">
+
+<!ENTITY landfillbase "http://landfill.bugzilla.org/bugzilla-tip/">
+<!ENTITY bz "http://www.bugzilla.org/">
+<!ENTITY bzg-bugs "<ulink url='http://bugzilla.mozilla.org/enter_bug.cgi?product=Bugzilla&amp;component=Documentation'>Bugzilla Documentation</ulink>">
+<!ENTITY mysql "http://www.mysql.com/">
+
+<!-- For minimum versions -->
+<!ENTITY min-mysql-ver "4.0.14">
+<!ENTITY min-pg-ver "7.3.x">
+<!ENTITY min-perl-ver "5.6.1">
+<!ENTITY min-perl-ver-win "5.8.1">
+<!ENTITY min-template-ver "2.08">
+<!ENTITY min-file-temp-ver "any">
+<!ENTITY min-appconfig-ver "1.52">
+<!ENTITY min-text-wrap-ver "2001.0131">
+<!ENTITY min-file-spec-ver "0.84">
+<!ENTITY min-data-dumper-ver "any">
+<!ENTITY min-dbd-mysql-ver "2.9003">
+<!ENTITY min-dbd-pg-ver "1.31">
+<!ENTITY min-dbi-ver "1.38">
+<!ENTITY min-date-format-ver "2.21">
+<!ENTITY min-cgi-ver "2.93">
+<!ENTITY min-mail-mailer-ver "1.67">
+<!ENTITY min-mime-base64-ver "3.01">
+<!ENTITY min-mime-parser-ver "5.406">
+<!ENTITY min-storable-ver "any">
+<!-- Optional modules -->
+<!ENTITY min-gd-ver "1.20">
+<!ENTITY min-gd-graph-ver "any">
+<!ENTITY min-gd-text-align-ver "any">
+<!ENTITY min-chart-base-ver "1.0">
+<!ENTITY min-xml-parser-ver "any">
+<!ENTITY min-patchreader-ver "0.9.4">
+<!ENTITY min-image-magick-ver "any">
\ No newline at end of file
diff --git a/docs/xml/conventions.xml b/docs/xml/conventions.xml
index 24986d66b..9f92a4755 100644
--- a/docs/xml/conventions.xml
+++ b/docs/xml/conventions.xml
@@ -1,4 +1,10 @@
-<!-- <!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
+<?xml version="1.0"?>
+<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
+
 <section id="conventions">
   <title>Document Conventions</title>
 
diff --git a/docs/xml/customization.xml b/docs/xml/customization.xml
index 37c64cca0..b677ce804 100644
--- a/docs/xml/customization.xml
+++ b/docs/xml/customization.xml
@@ -1,4 +1,10 @@
-<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
+<?xml version="1.0"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                      "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
+
 <chapter id="customization">
   <title>Customising Bugzilla</title>
 
@@ -1093,8 +1099,8 @@ this. But you need to know this stuff anyway, right?
     </section>
   </section>
 
-  <!-- Integrating Bugzilla with Third-Party Tools -->
-  &integration;
+<!-- Integrating Bugzilla with Third-Party Tools -->
+<xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="integration.xml" />
 
 </chapter>
 
diff --git a/docs/xml/faq.xml b/docs/xml/faq.xml
index 816508839..c87d86fbb 100644
--- a/docs/xml/faq.xml
+++ b/docs/xml/faq.xml
@@ -1,4 +1,9 @@
-<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
+<?xml version="1.0"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                      "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
 
 <appendix id="faq">
   <title>The Bugzilla FAQ</title>
diff --git a/docs/xml/gfdl.xml b/docs/xml/gfdl.xml
index 1d84d1255..0de66acd3 100644
--- a/docs/xml/gfdl.xml
+++ b/docs/xml/gfdl.xml
@@ -1,4 +1,10 @@
-<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
+<?xml version="1.0"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                      "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
+
 <appendix id="gfdl">
   <title>GNU Free Documentation License</title>
 
diff --git a/docs/xml/glossary.xml b/docs/xml/glossary.xml
index 79fb2baeb..980835053 100644
--- a/docs/xml/glossary.xml
+++ b/docs/xml/glossary.xml
@@ -1,4 +1,10 @@
-<!-- <!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook V4.1//EN" > -->
+<?xml version="1.0"?>
+<!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                         "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
+
 <glossary id="glossary">
   <glossdiv>
     <title>0-9, high ascii</title>
diff --git a/docs/xml/index.xml b/docs/xml/index.xml
index 7fc1a4c14..e8a228493 100644
--- a/docs/xml/index.xml
+++ b/docs/xml/index.xml
@@ -18,4 +18,3 @@ sgml-shorttag:t
 sgml-tag-region-if-active:t
 End:
 -->
-
diff --git a/docs/xml/installation.xml b/docs/xml/installation.xml
index 49779b670..e6d35544f 100644
--- a/docs/xml/installation.xml
+++ b/docs/xml/installation.xml
@@ -1,5 +1,10 @@
-<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
-<!-- $Id: installation.xml,v 1.107 2005/12/30 15:39:01 mozilla%colinogilvie.co.uk Exp $ -->
+<?xml version="1.0"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                      "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
+
 <chapter id="installing-bugzilla">
   <title>Installing Bugzilla</title>
 
diff --git a/docs/xml/modules.xml b/docs/xml/modules.xml
index 59c58530e..ac5040f02 100644
--- a/docs/xml/modules.xml
+++ b/docs/xml/modules.xml
@@ -1,4 +1,10 @@
-<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
+<?xml version="1.0"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                      "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
+
 <appendix id="install-perlmodules-manual">
   <title>Manual Installation of Perl Modules</title>
   
diff --git a/docs/xml/patches.xml b/docs/xml/patches.xml
index 11a5ecf11..f3e17290c 100644
--- a/docs/xml/patches.xml
+++ b/docs/xml/patches.xml
@@ -1,4 +1,10 @@
-<!-- <!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
+<?xml version="1.0"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                      "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
+
 <appendix id="patches" xreflabel="Useful Patches and Utilities for Bugzilla">
   <title>Contrib</title>
 
diff --git a/docs/xml/security.xml b/docs/xml/security.xml
index f33b00335..a1f2f5770 100644
--- a/docs/xml/security.xml
+++ b/docs/xml/security.xml
@@ -1,5 +1,9 @@
-<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
-<!-- $Id: security.xml,v 1.8 2005/11/08 13:34:37 wurblzap%gmail.com Exp $ -->
+<?xml version="1.0"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                      "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
 
 <chapter id="security">
 <title>Bugzilla Security</title>
diff --git a/docs/xml/troubleshooting.xml b/docs/xml/troubleshooting.xml
index fa21d579b..10ad59f1c 100644
--- a/docs/xml/troubleshooting.xml
+++ b/docs/xml/troubleshooting.xml
@@ -1,5 +1,9 @@
-<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"> -->
-<!-- $Id: troubleshooting.xml,v 1.6 2005/09/08 20:57:44 mozilla%colinogilvie.co.uk Exp $ -->
+<?xml version="1.0"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                      "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
 
 <appendix id="troubleshooting">
 <title>Troubleshooting</title>
diff --git a/docs/xml/using.xml b/docs/xml/using.xml
index dc56e4f06..8f50cfa44 100644
--- a/docs/xml/using.xml
+++ b/docs/xml/using.xml
@@ -1,4 +1,9 @@
-<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook V4.1//EN"> -->
+<?xml version="1.0"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
+                      "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
+    <!ENTITY % myents SYSTEM "bugzilla.ent">
+    %myents;
+]>
 
 <chapter id="using">
   <title>Using Bugzilla</title>