[svnbook commit] r3255 - trunk/src/en/book

cmpilato noreply at red-bean.com
Thu Aug 7 13:11:05 CDT 2008


Author: cmpilato
Date: Thu Aug  7 13:11:04 2008
New Revision: 3255

Log:
* src/en/book/ch00-preface.xml
  Rework the 'Conventions' section to not break into subsections
  (which is what we think the copyeditor probably meant when she
  struck out the printed titles of those subsections).



Modified:
   trunk/src/en/book/ch00-preface.xml

Modified: trunk/src/en/book/ch00-preface.xml
==============================================================================
--- trunk/src/en/book/ch00-preface.xml	(original)
+++ trunk/src/en/book/ch00-preface.xml	Thu Aug  7 13:11:04 2008
@@ -198,67 +198,59 @@
   <sect1 id="svn.preface.conventions">
     <title>Conventions Used in This Book</title>
         
-    <!-- =============================================================== -->
-    <sect2 id="svn.preface.conventions.typo">
-      <title></title>
-
-      <para>The following typographic conventions are used in this
-        book:</para>
-      
-      <variablelist>
-
-        <varlistentry>
-          <term>
-            <userinput>Constant width</userinput>
-          </term>
-          <listitem>
-            <para>Used for literal user input, command output, and
-              command-line options</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
-          <term>
-            <filename>Italic</filename>
-          </term>
-          <listitem>
-            <para>Used for program and Subversion tool subcommand
-              names, file and directory names, and new terms</para>
-          </listitem>
-        </varlistentry>
-
-        <varlistentry>
-          <term>
-            <replaceable>Constant width italic</replaceable>
-          </term>
-          <listitem>
-            <para>Used for replaceable items in code and text</para>
-          </listitem>
-        </varlistentry>
+    <para>We use the following typographic conventions in this
+      book:</para>
 
-      </variablelist>
+    <variablelist>
 
-    </sect2>
+      <varlistentry>
+        <term>
+          <userinput>Constant width</userinput>
+        </term>
+        <listitem>
+          <para>Used for literal user input, command output, and
+            command-line options</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>
+          <filename>Italic</filename>
+        </term>
+        <listitem>
+          <para>Used for program and Subversion tool subcommand
+            names, file and directory names, and new terms</para>
+        </listitem>
+      </varlistentry>
+
+      <varlistentry>
+        <term>
+          <replaceable>Constant width italic</replaceable>
+        </term>
+        <listitem>
+          <para>Used for replaceable items in code and text</para>
+        </listitem>
+      </varlistentry>
 
-    <!-- =============================================================== -->
-    <sect2 id="svn.preface.conventions.icons">
-      <title></title>
+    </variablelist>
 
-      <note>
-        <para>This icon designates a note relating to the surrounding
-          text.</para>
-      </note>
-
-      <tip>
-        <para>This icon designates a helpful tip relating to the surrounding
-          text.</para>
-      </tip>
-
-      <warning>
-        <para>This icon designates a warning relating to the surrounding
-          text.</para>
-      </warning>
-    </sect2>
+    <para>We sprinkled especially interesting, helpful, or important
+      bits of knowledge throughout the book (in contextually relevant
+      locations), set off visually so they're easy to find.  Look for
+      the following icons as you read:</para>
+
+    <note>
+      <para>Designates a special point of interest</para>
+    </note>
+
+    <tip>
+      <para>Designates a helpful tip or best practice</para>
+    </tip>
+
+    <warning>
+      <para>Designates a warning—pay close attention to
+        these to avoid problems</para>
+    </warning>
 
   </sect1>
 




More information about the svnbook-dev mailing list