A rather controversial new entry to the FAQ. See bug 107917. I

decided one way for the Guide, based upon the code I see currently
checked in.  If I'm wrong, feel free to correct it!

diff --git a/docs/sgml/faq.sgml b/docs/sgml/faq.sgml
index 91380863fa39d92b663821f2ae6b2bb3a3e1fe05..d1968d8f844830480a1ebf5f0b92ea4ba26b820b 100644 (file)
--- a/docs/sgml/faq.sgml
+++ b/docs/sgml/faq.sgml
@@ -1131,6 +1131,41 @@
     <qandadiv id="faq-hacking">
       <title>Bugzilla Hacking</title>
 
+      <qandaentry>
+        <question>
+         <para>
+           What kind of style should I use for templatization?
+         </para>
+       </question>
+       <answer>
+         <para>
+           Gerv and Myk suggest a 2-space endent, with embedded code sections on
+           their own line, in line with outer tags.  Like this:</para>
+           <programlisting><![CDATA[
+<fred>
+[% IF foo %]
+  <bar>
+  [% FOREACH x = barney %]
+    <tr>
+      <td>
+        [% x %]
+      </td>
+    <tr>
+  [% END %]
+[% END %]
+</fred>
+]]></programlisting>
+
+       <para> Myk also recommends you turn on PRE_CHOMP in the template
+       initialization to prevent bloating of HTML with unnecessary whitespace.
+       </para>
+
+       <para>Please note that many have differing opinions on this subject,
+       and the existing templates in Bugzilla espouse both this and a 4-space
+       style.  Either is acceptable; the above is preferred.</para>
+       </answer>
+      </qandaentry>
+
       <qandaentry>
        <question>
          <para>

diff --git a/docs/xml/faq.xml b/docs/xml/faq.xml
index 91380863fa39d92b663821f2ae6b2bb3a3e1fe05..d1968d8f844830480a1ebf5f0b92ea4ba26b820b 100644 (file)
--- a/docs/xml/faq.xml
+++ b/docs/xml/faq.xml
@@ -1131,6 +1131,41 @@
     <qandadiv id="faq-hacking">
       <title>Bugzilla Hacking</title>
 
+      <qandaentry>
+        <question>
+         <para>
+           What kind of style should I use for templatization?
+         </para>
+       </question>
+       <answer>
+         <para>
+           Gerv and Myk suggest a 2-space endent, with embedded code sections on
+           their own line, in line with outer tags.  Like this:</para>
+           <programlisting><![CDATA[
+<fred>
+[% IF foo %]
+  <bar>
+  [% FOREACH x = barney %]
+    <tr>
+      <td>
+        [% x %]
+      </td>
+    <tr>
+  [% END %]
+[% END %]
+</fred>
+]]></programlisting>
+
+       <para> Myk also recommends you turn on PRE_CHOMP in the template
+       initialization to prevent bloating of HTML with unnecessary whitespace.
+       </para>
+
+       <para>Please note that many have differing opinions on this subject,
+       and the existing templates in Bugzilla espouse both this and a 4-space
+       style.  Either is acceptable; the above is preferred.</para>
+       </answer>
+      </qandaentry>
+
       <qandaentry>
        <question>
          <para>