documentation-guide/en_US writing-guidelines.xml,1.9,1.10

[Paul W. Frields (pfrields)]

Author: pfrields

Update of /cvs/docs/documentation-guide/en_US
In directory cvs-int.fedora.redhat.com:/tmp/cvs-serv24977

Modified Files:
	writing-guidelines.xml 
Log Message:
Give advice on previewing work.



Index: writing-guidelines.xml
===================================================================
RCS file: /cvs/docs/documentation-guide/en_US/writing-guidelines.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- writing-guidelines.xml	1 Jul 2007 17:30:32 -0000	1.9
+++ writing-guidelines.xml	16 Sep 2007 19:11:27 -0000	1.10
@@ -644,6 +644,24 @@
     </section>	
 -->
 
+  <section id="sn-live-previews">
+    <title>Previewing Your Work</title>
+    <para>The GNOME <application>Help</application> browser, also known
+      as <command>yelp</command>, and the KDE
+      <application>Khelp</application> documentation browser can render
+      DocBook XML information as needed.  Use these applications to
+      preview your work if you prefer reading your work in a
+      browser-like environment.  Run the following command:</para>
+    <screen><![CDATA[yelp file:///path/to/parent-file.xml]]></screen>
+    <para>Make sure to point the preferred help browser at the top
+      parent file of your XML document.  Once the document loads, you
+      can add a bookmark for it for ease of use later.</para>
+    <tip>
+      <title>Using Bookmarks</title>
+      <para>Keeping your documents in the same place for every checkout
+	session makes help browser bookmarks more effective.</para>
+    </tip>
+  </section>
 </chapter>
 
 <!--