diff options
| author | Paul W. Frields <stickster@gmail.com> | 2007-09-16 19:11:27 +0000 |
|---|---|---|
| committer | Paul W. Frields <stickster@gmail.com> | 2007-09-16 19:11:27 +0000 |
| commit | 234dab31e9d7d86f4f079b03164f4551eea71aab (patch) | |
| tree | eae915552d5c0fec72d367a9135df57d9cfd8232 | |
| parent | 52c78b851020d96cf6d31db23d3394a09e3c1496 (diff) | |
| download | documentation-guide-234dab31e9d7d86f4f079b03164f4551eea71aab.tar.gz documentation-guide-234dab31e9d7d86f4f079b03164f4551eea71aab.tar.xz documentation-guide-234dab31e9d7d86f4f079b03164f4551eea71aab.zip | |
Give advice on previewing work.
| -rw-r--r-- | en_US/writing-guidelines.xml | 20 |
1 files changed, 19 insertions, 1 deletions
diff --git a/en_US/writing-guidelines.xml b/en_US/writing-guidelines.xml index 0eaf2e7..6eaf477 100644 --- a/en_US/writing-guidelines.xml +++ b/en_US/writing-guidelines.xml @@ -51,7 +51,7 @@ <para>Any time the file is committed to CVS, the line is updated automatically to include information about the file. For example:</para> - <screen><![CDATA[<!-- $Id: writing-guidelines.xml,v 1.9 2007/07/01 17:30:32 pfrields Exp $ -->]]></screen> + <screen><![CDATA[<!-- $Id: writing-guidelines.xml,v 1.10 2007/09/16 19:11:27 pfrields Exp $ -->]]></screen> </section> </section> <section id="sn-id-naming-conventions"> @@ -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> <!-- |