From 8f8a3724c7fe37736f893bd2e2cba702b3f9ddc5 Mon Sep 17 00:00:00 2001
From: "myk%mozilla.org" <>
Date: Fri, 4 Apr 2008 11:47:44 +0000
Subject: Fix validation problem (unescaped ampersands) by making the program
 listing be CDATA.

---
 docs/en/xml/customization.xml | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)

(limited to 'docs/en/xml/customization.xml')

diff --git a/docs/en/xml/customization.xml b/docs/en/xml/customization.xml
index 1bc2b97ee..c85505c1f 100644
--- a/docs/en/xml/customization.xml
+++ b/docs/en/xml/customization.xml
@@ -295,7 +295,7 @@
       </para>
 
       <para>After untarring the localizations (or creating your own) in the 
-      <filename class="directory"><varname>BUGZILLA_ROOT</varname>/template</filename> directory,
+      <filename class="directory">BUGZILLA_ROOT/template</filename> directory,
       you must update the <option>languages</option> parameter to contain any
       localizations you'd like to permit. You may also wish to set the
       <option>defaultlanguage</option> parameter to something other than
@@ -345,12 +345,12 @@
       tool (e.g. <command>grep</command>) to search the standard templates
       for occurrences of <methodname>Hook.process</methodname> or browse
       the directory tree in
-      <filename><varname>BUGZILLA_ROOT</varname>/template/en/extension/hook/</filename>,
+      <filename>BUGZILLA_ROOT/template/en/extension/hook/</filename>,
       which contains a directory for each hook in the following location:
     </para>
 
     <para>
-      <filename><varname>BUGZILLA_ROOT</varname>/template/en/extension/hook/<varname>PATH_TO_STANDARD_TEMPLATE</varname>/<varname>STANDARD_TEMPLATE_NAME</varname>/<varname>HOOK_NAME</varname>/</filename>
+      <filename>BUGZILLA_ROOT/template/en/extension/hook/PATH_TO_STANDARD_TEMPLATE/STANDARD_TEMPLATE_NAME/HOOK_NAME/</filename>
     </para>
 
     <para>
@@ -375,7 +375,7 @@
       The Bugzilla reviewers will promptly review each hook request,
       name the hook, add it to the template, check the new version
       of the template into CVS, and create the corresponding directory in
-      <filename><varname>BUGZILLA_ROOT</varname>/template/en/extension/hook/</filename>.
+      <filename>BUGZILLA_ROOT/template/en/extension/hook/</filename>.
     </para>
 
     <para>
@@ -415,7 +415,7 @@
       <filename>useful-links.html.tmpl</filename>, which is located in
       the <filename>global/</filename> subdirectory on the standard Bugzilla 
       template path
-      <filename><varname>BUGZILLA_ROOT</varname>/template/en/default/</filename>.
+      <filename>BUGZILLA_ROOT/template/en/default/</filename>.
       Looking in <filename>useful-links.html.tmpl</filename>, you find
       the following hook at the end of the list of standard Bugzilla
       administration links:
@@ -429,7 +429,7 @@
 
     <para>
       The corresponding directory for this hook is
-      <filename><varname>BUGZILLA_ROOT</varname>/template/en/extension/hook/global/useful-links.html.tmpl/edit/</filename>.
+      <filename>BUGZILLA_ROOT/template/en/extension/hook/global/useful-links.html.tmpl/edit/</filename>.
     </para>
 
     <para>
@@ -454,7 +454,7 @@
         <para>
           You may want to prefix your extension template names
           with the name of your extension, e.g. 
-          <filename><literal>projman</literal>-foo.html.tmpl</filename>, 
+          <filename>projman-foo.html.tmpl</filename>, 
           so they do not conflict with the names of templates installed by
           other extensions.
         </para>
@@ -465,7 +465,7 @@
           If your extension includes entirely new templates in addition to
           extensions of standard templates, it should install those new
           templates into an extension-specific subdirectory of the
-          <filename><varname>BUGZILLA_ROOT</varname>/template/en/extension/</filename> 
+          <filename>BUGZILLA_ROOT/template/en/extension/</filename> 
           directory.  The <filename>extension/</filename> directory, like the 
           <filename>default/</filename> and <filename>custom/</filename>
           directories, is part of the template search path, so putting templates
@@ -494,9 +494,9 @@
         <para>
           Installation customizers can also take advantage of hooks when adding
           code to a Bugzilla template.  To do so, create directories in
-          <filename><varname>BUGZILLA_ROOT</varname>/template/en/custom/hook/</filename>
+          <filename>BUGZILLA_ROOT/template/en/custom/hook/</filename>
           equivalent to the directories in
-          <filename><varname>BUGZILLA_ROOT</varname>/template/en/extension/hook/</filename>          
+          <filename>BUGZILLA_ROOT/template/en/extension/hook/</filename>          
           for the hooks you want to use, then place your customization templates
           into those directories.
         </para>
@@ -584,7 +584,7 @@
     }</programlisting>
       This says that only users in the group "quality_assurance" can change
       the QA Contact field of a bug. Getting more weird:
-      <programlisting>    if (($field eq "priority") &&
+      <programlisting><![CDATA[    if (($field eq "priority") &&
         (Bugzilla->user->email =~ /.*\@example\.com$/))
     {
         if ($oldvalue eq "P1") {
@@ -593,7 +593,7 @@
         else {
             return 0;
         }
-    }</programlisting>
+    }]]></programlisting>
       This says that if the user is trying to change the priority field,
       and their email address is @example.com, they can only do so if the
       old value of the field was "P1". Not very useful, but illustrative.
-- 
cgit v1.2.3-24-g4f1b