[gnome-doc-utils/mallard: 75/87] Adding intro text for var



commit e4e8cdc0fa43207e7e85c9106df1257f9d7d2c76
Author: Shaun McCance <shaunm gnome org>
Date:   Fri Dec 12 13:46:13 2008 -0600

    Adding intro text for var
---
 doc/mallard/C/mal_inline_var.xml |    8 ++++++++
 1 files changed, 8 insertions(+), 0 deletions(-)

diff --git a/doc/mallard/C/mal_inline_var.xml b/doc/mallard/C/mal_inline_var.xml
index f413aaf..1c6a96a 100644
--- a/doc/mallard/C/mal_inline_var.xml
+++ b/doc/mallard/C/mal_inline_var.xml
@@ -4,6 +4,8 @@
 
 <info>
   <link type="guide" xref="mal_inline#elements"/>
+  <link type="seealso" xref="mal_inline_cmd"/>
+  <link type="seealso" xref="mal_inline_code"/>
 
   <version number="0.1" date="2007-02-21" status="stub"/>
 
@@ -22,6 +24,12 @@ mal_inline_var = element var {
 }
 </code></synopsis>
 
+<p>Use the <code>var</code> element to mark up placeholder text that should be
+replaced by the user.  This is typically used inside a
+<code xref="mal_inline_cmd">cmd</code> or <code xref="mal_inline_code">code</code>
+element to indicate a replaceable argument, or within running prose to refer to
+an indicated argument.</p>
+
 
 <!-- BEGIN notes -->
 <section id="notes">



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]