Bug 423496: Compile the documentation with xmlto + dblatex instead of openjade

r=glob a=LpSolit

1 files changed, 71 insertions, 72 deletions

diff --git a/docs/en/xml/installation.xml b/docs/en/xml/installation.xml
index e43c567b8..cdff751d4 100644
--- a/docs/en/xml/installation.xml
+++ b/docs/en/xml/installation.xml
@@ -1,4 +1,10 @@
-<!-- <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//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="installing-bugzilla">
   <title>Installing Bugzilla</title>
 
@@ -169,16 +175,17 @@
       <para>Installed Version Test: view the default welcome page at
       http://&lt;your-machine&gt;/</para>
       
-      <para>You have freedom of choice here, pretty much any web server that
-      is capable of running <glossterm linkend="gloss-cgi">CGI</glossterm>
-      scripts will work.
-       However, we strongly recommend using the Apache web server
-       (either 1.3.x or 2.x), and 
-       the installation instructions usually assume you are
-        using it. If you have got Bugzilla working using another web server,
-        please share your experiences with us by filing a bug in &bzg-bugs;.
+      <para>
+        You have freedom of choice here, pretty much any web server that
+        is capable of running <glossterm linkend="gloss-cgi">CGI</glossterm>
+        scripts will work.
+        However, we strongly recommend using the Apache web server
+        (either 1.3.x or 2.x), and the installation instructions usually assume
+        you are using it. If you have got Bugzilla working using another web server,
+        please share your experiences with us by filing a bug in
+        <ulink url="&bzg-bugs;">Bugzilla Documentation</ulink>.
       </para>
-      
+
       <para>
       If you don't have Apache and your OS doesn't provide official packages, 
       visit <ulink url="http://httpd.apache.org/"/>.
@@ -732,9 +739,9 @@ max_allowed_packet=4M
           This can be done by modifying the <filename>/etc/my.cnf</filename>
           according to the example below:</para>
 
-          <screen>  [mysqld]
-  # Allow small words in full-text indexes
-  ft_min_word_len=2</screen>
+          <screen>[mysqld]
+# Allow small words in full-text indexes
+ft_min_word_len=2</screen>
 
           <para>Rebuilding the indexes can be done based on documentation found at
           <ulink url="http://www.mysql.com/doc/en/Fulltext_Fine-tuning.html"/>.
@@ -770,11 +777,11 @@ max_allowed_packet=4M
           </para>
 
           <screen>
-    <prompt>mysql&gt;</prompt> GRANT SELECT, INSERT,
-           UPDATE, DELETE, INDEX, ALTER, CREATE, LOCK TABLES,
-           CREATE TEMPORARY TABLES, DROP, REFERENCES ON bugs.*
-           TO bugs@localhost IDENTIFIED BY '<replaceable>$db_pass</replaceable>';
-    <prompt>mysql&gt;</prompt> FLUSH PRIVILEGES;
+<prompt>mysql&gt;</prompt> GRANT SELECT, INSERT,
+       UPDATE, DELETE, INDEX, ALTER, CREATE, LOCK TABLES,
+       CREATE TEMPORARY TABLES, DROP, REFERENCES ON bugs.*
+       TO bugs@localhost IDENTIFIED BY '<replaceable>$db_pass</replaceable>';
+<prompt>mysql&gt;</prompt> FLUSH PRIVILEGES;
           </screen>
         </section>
 
@@ -796,8 +803,8 @@ max_allowed_packet=4M
           </para>
 
           <screen>
-    <prompt>mysql&gt;</prompt> use <replaceable>$bugs_db</replaceable>
-    <prompt>mysql&gt;</prompt> ALTER TABLE attachments
+<prompt>mysql&gt;</prompt> use <replaceable>$bugs_db</replaceable>
+<prompt>mysql&gt;</prompt> ALTER TABLE attachments
            AVG_ROW_LENGTH=1000000, MAX_ROWS=20000;
           </screen>
 
@@ -832,11 +839,11 @@ max_allowed_packet=4M
           <para>On most systems, to create the user in PostgreSQL, you will need to
           login as the root user, and then</para>
 
-          <screen> <prompt>bash#</prompt> su - postgres</screen>
+          <screen><prompt>bash#</prompt> su - postgres</screen>
 
           <para>As the postgres user, you then need to create a new user: </para>
             
-          <screen> <prompt>bash$</prompt> createuser -U postgres -dRSP bugs</screen>
+          <screen><prompt>bash$</prompt> createuser -U postgres -dRSP bugs</screen>
  
           <para>When asked for a password, provide the password which will be set as
           <replaceable>$db_pass</replaceable> in <filename>localconfig</filename>.
@@ -880,9 +887,9 @@ max_allowed_packet=4M
           </para>
 
           <programlisting>
-    CREATE TABLESPACE bugs
-    DATAFILE '<replaceable>$path_to_datafile</replaceable>' SIZE 500M
-    AUTOEXTEND ON NEXT 30M MAXSIZE UNLIMITED
+CREATE TABLESPACE bugs
+DATAFILE '<replaceable>$path_to_datafile</replaceable>' SIZE 500M
+AUTOEXTEND ON NEXT 30M MAXSIZE UNLIMITED
           </programlisting>
 
           <para>
@@ -907,17 +914,17 @@ max_allowed_packet=4M
           </para>
 
           <programlisting>
-    CREATE USER bugs
-    IDENTIFIED BY "<replaceable>$db_pass</replaceable>"
-    DEFAULT TABLESPACE bugs
-    TEMPORARY TABLESPACE TEMP
-    PROFILE DEFAULT;
-    -- GRANT/REVOKE ROLE PRIVILEGES
-    GRANT CONNECT TO bugs;
-    GRANT RESOURCE TO bugs;
-    -- GRANT/REVOKE SYSTEM PRIVILEGES
-    GRANT UNLIMITED TABLESPACE TO bugs;
-    GRANT EXECUTE ON CTXSYS.CTX_DDL TO bugs;
+CREATE USER bugs
+IDENTIFIED BY "<replaceable>$db_pass</replaceable>"
+DEFAULT TABLESPACE bugs
+TEMPORARY TABLESPACE TEMP
+PROFILE DEFAULT;
+-- GRANT/REVOKE ROLE PRIVILEGES
+GRANT CONNECT TO bugs;
+GRANT RESOURCE TO bugs;
+-- GRANT/REVOKE SYSTEM PRIVILEGES
+GRANT UNLIMITED TABLESPACE TO bugs;
+GRANT EXECUTE ON CTXSYS.CTX_DDL TO bugs;
           </programlisting>
         </section>
 
@@ -930,8 +937,8 @@ max_allowed_packet=4M
           </para>
 
           <programlisting>
-    SetEnv ORACLE_HOME /u01/app/oracle/product/10.2.0/
-    SetEnv LD_LIBRARY_PATH /u01/app/oracle/product/10.2.0/lib/
+SetEnv ORACLE_HOME /u01/app/oracle/product/10.2.0/
+SetEnv LD_LIBRARY_PATH /u01/app/oracle/product/10.2.0/lib/
           </programlisting>
 
           <para>
@@ -1040,12 +1047,12 @@ max_allowed_packet=4M
                 </para>
     
                 <programlisting>
-    &lt;Directory /var/www/html/bugzilla&gt;
-    AddHandler cgi-script .cgi
-    Options +Indexes +ExecCGI
-    DirectoryIndex index.cgi
-    AllowOverride Limit FileInfo Indexes
-    &lt;/Directory&gt;
+&lt;Directory /var/www/html/bugzilla&gt;
+AddHandler cgi-script .cgi
+Options +Indexes +ExecCGI
+DirectoryIndex index.cgi
+AllowOverride Limit FileInfo Indexes
+&lt;/Directory&gt;
                 </programlisting>
     
                 <para>
@@ -1101,9 +1108,7 @@ max_allowed_packet=4M
                 (the same one as in the step above):
                 </para>
     
-                <programlisting>
-    +FollowSymLinks
-                </programlisting>
+                <programlisting>+FollowSymLinks</programlisting>
     
                 <para>
                 Without this directive, Apache will not follow symbolic links
@@ -1142,10 +1147,10 @@ max_allowed_packet=4M
                 <para>You should also ensure that you have disabled <literal>KeepAlive</literal>
                 support in your Apache install when utilizing Bugzilla under mod_perl</para>
                 </warning> 
-                
+
                 <programlisting>
-    PerlSwitches -w -T
-    PerlConfigRequire /var/www/html/bugzilla/mod_perl.pl
+PerlSwitches -w -T
+PerlConfigRequire /var/www/html/bugzilla/mod_perl.pl
                 </programlisting>
             </step>
 			
@@ -1521,8 +1526,8 @@ AddType application/rdf+xml .rdf</screen>
     and the utilities available to make it easier.
     </para>
 
-    <para>If you have anything to add or notes for an operating system not
-    covered, please file a bug in &bzg-bugs;. 
+    <para>If you have anything to add or notes for an operating system not covered,
+    please file a bug in <ulink url="&bzg-bugs;">Bugzilla Documentation</ulink>.
     </para>
 
     <section id="os-win32">
@@ -1855,13 +1860,11 @@ pid-file=/home/foo/mymysql/the.pid
             <para>After your mysqld program is built and any .my.cnf file is 
             in place, you must initialize the databases (ONCE).</para>
             <screen>
-              <prompt>bash$</prompt>
-              <command>mysql_install_db</command>
+<prompt>bash$</prompt> <command>mysql_install_db</command>
             </screen>
             <para>Then start the daemon with</para>
             <screen>
-              <prompt>bash$</prompt>
-              <command>safe_mysql &amp;</command>
+<prompt>bash$</prompt> <command>safe_mysql &amp;</command>
             </screen>
             <para>After you start mysqld the first time, you then connect to
             it as "root" and <command>GRANT</command> permissions to other
@@ -1883,7 +1886,6 @@ pid-file=/home/foo/mymysql/the.pid
             </warning>
           </section>
       </section>
-
     </section>
 
     <section>
@@ -1897,16 +1899,11 @@ pid-file=/home/foo/mymysql/the.pid
       </para>
 
       <screen>
-        <prompt>bash$</prompt>
-        <command>wget http://perl.org/CPAN/src/stable.tar.gz</command>
-        <prompt>bash$</prompt>
-        <command>tar zvxf stable.tar.gz</command>
-        <prompt>bash$</prompt>
-        <command>cd perl-5.8.1</command> (or whatever the version of Perl is called)
-        <prompt>bash$</prompt>
-        <command>sh Configure -de -Dprefix=/home/foo/perl</command>
-        <prompt>bash$</prompt>
-        <command>make &amp;&amp; make test &amp;&amp; make install</command>
+<prompt>bash$</prompt> <command>wget http://perl.org/CPAN/src/stable.tar.gz</command>
+<prompt>bash$</prompt> <command>tar zvxf stable.tar.gz</command>
+<prompt>bash$</prompt> <command>cd perl-&min-perl-ver;</command>
+<prompt>bash$</prompt> <command>sh Configure -de -Dprefix=/home/foo/perl</command>
+<prompt>bash$</prompt> <command>make &amp;&amp; make test &amp;&amp; make install</command>
       </screen>
 
       <para>
@@ -1923,7 +1920,7 @@ pid-file=/home/foo/mymysql/the.pid
       Installing the Perl modules as a non-root user is accomplished by
       running the <filename>install-module.pl</filename>
       script. For more details on this script, see 
-      <ulink url="api/install-module.html"><filename>install-module.pl</filename>
+      <ulink url="../html/api/install-module.html"><filename>install-module.pl</filename>
       documentation</ulink>
       </para>
     </section>
@@ -2000,10 +1997,12 @@ pid-file=/home/foo/mymysql/the.pid
         shell commands after running <command>./checksetup.pl</command>,
         every time you run it (or modify <filename>checksetup.pl</filename>
         to do them for you via the system() command).
-        <programlisting>        for i in docs graphs images js skins; do find $i -type d -exec chmod o+rx {} \; ; done
-        for i in jpg gif css js png html rdf xul; do find . -name \*.$i -exec chmod o+r {} \; ; done
-        find . -name .htaccess -exec chmod o+r {} \;
-        chmod o+x . data data/webdot</programlisting>
+        <programlisting>
+for i in docs graphs images js skins; do find $i -type d -exec chmod o+rx {} \; ; done
+for i in jpg gif css js png html rdf xul; do find . -name \*.$i -exec chmod o+r {} \; ; done
+find . -name .htaccess -exec chmod o+r {} \;
+chmod o+x . data data/webdot
+        </programlisting>
         Pay particular attention to the number of semicolons and dots.
         They are all important.  A future version of Bugzilla will
         hopefully be able to do this for you out of the box.</para>