[svnbook commit] r2724 - trunk/src/en

[cmpilato]

Author: cmpilato
Date: Wed Feb 28 08:18:44 2007
New Revision: 2724

Modified:
   trunk/src/en/HACKING

Log:
* src/en/HACKING
  Tweak formatting a bit, and update the sample chapter a bit.


Modified: trunk/src/en/HACKING
==============================================================================
--- trunk/src/en/HACKING	(original)
+++ trunk/src/en/HACKING	Wed Feb 28 08:18:44 2007
@@ -1,12 +1,13 @@
-This style guide is intended to be *in addition* to the O'Reilly and
-Associates style guide at
-http://www.ora.com/oreilly/author/stylesheet.html
+This style guide is intended to be *an addition to* the O'Reilly and
+Associates style guide at http://www.ora.com/oreilly/author/stylesheet.html
 ===========================================================================
 
+
 ===========
-Prose Guide
+PROSE GUIDE
 ===========
 
+
 Tone: somewhere between formal and informal. 
       For example:
       - We use contractions
@@ -37,12 +38,12 @@
   that such an assumption is being made (or rather, recommends that
   the reader first visit said other section).
 
-===========================================================================
 
 ================
-Subversion Guide
+SUBVERSION GUIDE
 ================
 
+
 - Our sample repository will be its own repository that all
   examples come from and it will be publically accessible. ###TODO
 
@@ -56,12 +57,12 @@
 
 - Primary server machine/URL: svn.red-bean.com
 
-===========================================================================
 
 ============
-Markup Guide
+MARKUP GUIDE
 ============
 
+
 - The DTD used for the Subversion book is the Docbook Lite DTD as
   defined by O'Reilly & Associates. You'll find it at in our source
   tree and in ftp://ftp.oreilly.com/pub/dblite/
@@ -75,43 +76,14 @@
 
 - All markup should be properly indented, with the exception of
   <screen></screen> blocks, which should be aligned all the way to the
-  left. For example:
+  left. 
 
-<chapter id="svn-ch-pi">
-<title>Tips</title>
+- We use commented-out divider lines to help us quickly locate section
+  boundarties.
 
-  <!-- ================================================================= -->
-  <!-- ======================== SECTION 1 ============================== -->
-  <!-- ================================================================= -->
-  <sect1 id="svn-ch-pi-sect-1">
-    <title>Flornthorple Plathering</title>
-    
-    <para>The real key to <firstterm>Plathering</firstterm> is to start with
-       a good glab. A good glab provides a solid thorpy foundation.</para>
-
-    <sect2 id="svn-ch-pi-sect-1.1">
-      <title>Cross-blather</title>
-      
-      <para>Cross-blather tends to create a hoopy pile of crandy. You
-        can avoid this by using the cross-blather avoid
-        command.</para>
-
-      <screen>
-$ cb-avoid
-Avoiding blather......... Done
-$
-</screen> <!-- Note the closing tag at the left-most column? -->
-              
-    </sect2>
-
-  </sect1>
-
-</chapter>
-
-===========================================================================
 
 ==================
-Abbreviation Rules
+ABBREVIATION RULES
 ==================
 
 
@@ -130,12 +102,11 @@
       abbreviations.
 
 
-===========================================================================
-
 =============
-Miscellaneous
+MISCELLANEOUS
 =============
 
+
 - Anything that needs attention or fixing should be marked with
   ###TODO so that it's easy to find. Also, please add your userid to
   any inline comments to facilitate discussion 'in the code.'
@@ -143,3 +114,56 @@
 - Do you want to mention svnbook.el in here?  Note that it's already
   mentioned in the top-level HACKING file.  Maybe this HACKING file
   should be merged into that one?  I dunno, you guys make the call.
+
+
+==============
+SAMPLE CHAPTER
+==============
+
+
+<chapter id="svn-ch-pi">
+<title>Tips</title>
+
+  <!-- ================================================================= -->
+  <!-- ================================================================= -->
+  <!-- ================================================================= -->
+  <sect1 id="svn-ch-pi-sect-1">
+    <title>Flornthorple Plathering</title>
+    
+    <para>The real key to <firstterm>Plathering</firstterm> is to start with
+       a good glab. A good glab provides a solid thorpy foundation.</para>
+
+    <!-- =============================================================== -->
+    <sect2 id="svn-ch-pi-sect-1.1">
+      <title>Cross-blather</title>
+      
+      <para>Cross-blather tends to create a hoopy pile of crandy. You
+        can avoid this by using the cross-blather avoid
+        command.</para>
+
+      <screen>$ cb-avoid        <!-- No EOL between opening tag and data -->
+Avoiding blather......... Done
+$
+</screen>                       <!-- Closing tag at the left-most column -->
+
+      <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+      <sect3>
+        <title>Exceptions</title>
+ 
+        <para>There's one to every rule.  Except this one.</para>
+
+      </sect3>
+
+      <!-- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -->
+      <sect3>
+        <title>Final thoughts</title>
+ 
+        <para>I see a bright light coming toward me….</para>
+
+      </sect3>
+              
+    </sect2>
+
+  </sect1>
+
+</chapter>