[gnome-doc-utils/mallard: 55/87] Adding processing expectations to cmd

[Shaun McCance <shaunm src gnome org>]

commit 8a0f0336f8e4335475e35b9416ba44ca50eb663d
Author: Shaun McCance <shaunm gnome org>
Date:   Mon Dec 1 17:23:42 2008 -0600

    Adding processing expectations to cmd
---
 doc/mallard/C/mal_inline_cmd.xml |   19 ++++++++++++++-----
 1 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/doc/mallard/C/mal_inline_cmd.xml b/doc/mallard/C/mal_inline_cmd.xml
index 9477843..ec6b447 100644
--- a/doc/mallard/C/mal_inline_cmd.xml
+++ b/doc/mallard/C/mal_inline_cmd.xml
@@ -6,7 +6,7 @@
   <link type="guide" xref="mal_inline#elements"/>
   <link type="seealso" xref="mal_block_screen"/>
 
-  <version number="0.1" date="2007-02-05" status="incomplete"/>
+  <version number="0.1" date="2007-02-05" status="review"/>
 
   <credit type="author">
     <name>Shaun McCance</name>
@@ -126,10 +126,19 @@ you to filter files based on their modification times.</p>
 <!-- BEGIN processing -->
 <section id="processing">
   <title>Processing Expectations</title>
-  <comment>
-    <cite date="2007-02-06"><name>Shaun McCance</name></cite>
-    <p>Add processing expectations.</p>
-  </comment>
+  <p>Commands should be displayed in a fixed-width font.  This mimics the look
+  of a typical environment where commands are executed.  More importantly,
+  fixed-width fonts tend to have more distinction between visually similar
+  characters.  This is particularly important in commands, since letters often
+  appear without the context of a known word that helps make them discernable
+  in normal prose.</p>
+
+  <p>Commands in documentation are often provided with options to illustrate
+  how to use them to a particular effect.  This can make it difficult to find
+  the end of the command quickly.  Surrounding text content, especially
+  punctuation, can sometimes be confused for part of the command.  For this
+  reason, it is recommended that processing tools apply a border or background
+  color to commands.</p>
 </section>
 <!-- END processing -->