[gnome-doc-utils/mallard: 49/87] Adding notes to inline elements

From: Shaun McCance <shaunm src gnome org>
To: svn-commits-list gnome org
Subject: [gnome-doc-utils/mallard: 49/87] Adding notes to inline elements
Date: Sun, 19 Apr 2009 12:18:27 -0400 (EDT)
commit 526a8dc899540860771187266a27919130d64a88
Author: Shaun McCance <shaunm gnome org>
Date:   Mon Dec 1 10:25:55 2008 -0600

    Adding notes to inline elements
---
 doc/mallard/C/mal_attr_external.xml |   25 ++++++++++++++++++++++
 doc/mallard/C/mal_inline_app.xml    |    6 +++-
 doc/mallard/C/mal_inline_cmd.xml    |   34 +++++++++++++++++++++++++++++-
 doc/mallard/C/mal_inline_code.xml   |   28 +++++++++++++++++--------
 doc/mallard/C/mal_inline_em.xml     |   20 +++++++++++++++++-
 doc/mallard/C/mal_inline_file.xml   |   21 ++++++++++++++++++-
 doc/mallard/C/mal_inline_gui.xml    |   29 +++++++++++++++++++++++++-
 doc/mallard/C/mal_inline_guiseq.xml |   16 ++++++++++++++
 doc/mallard/C/mal_inline_input.xml  |   24 ++++++++++++++++++++-
 doc/mallard/C/mal_inline_key.xml    |   20 +++++++++++++++++-
 doc/mallard/C/mal_inline_keyseq.xml |   15 +++++++++++++
 doc/mallard/C/mal_inline_output.xml |   39 ++++++++++++++++++++++++++++++++++-
 doc/mallard/C/mal_inline_sys.xml    |   20 +++++++++++++++++-
 doc/mallard/C/mal_inline_var.xml    |   20 +++++++++++++++++-
 14 files changed, 297 insertions(+), 20 deletions(-)

diff --git a/doc/mallard/C/mal_attr_external.xml b/doc/mallard/C/mal_attr_external.xml
new file mode 100644
index 0000000..cdc745f
--- /dev/null
+++ b/doc/mallard/C/mal_attr_external.xml
@@ -0,0 +1,25 @@
+<page xmlns="http://www.gnome.org/~shaunm/mallard";
+      type="topic"
+      id="mal_attr_external">
+
+<info>
+  <credit type="author">
+    <name>Shaun McCance</name>
+    <email>shaunm gnome org</email>
+  </credit>
+  <copyright>
+    <year>2008</year>
+    <name>Shaun McCance</name>
+  </copyright>
+
+  <version number="0.1" date="2008-02-19" status="incomplete"/>
+</info>
+
+<title>External Attributes</title>
+
+<comment>
+  <cite date="2008-12-01"><name>Shaun McCance</name></cite>
+  <p>Add content</p>
+</comment>
+
+</page>
diff --git a/doc/mallard/C/mal_inline_app.xml b/doc/mallard/C/mal_inline_app.xml
index c66d3e2..4a18de9 100644
--- a/doc/mallard/C/mal_inline_app.xml
+++ b/doc/mallard/C/mal_inline_app.xml
@@ -50,9 +50,11 @@ the name of the command used to run an application; use
 
     <item><p>The <code>app</code> element can link to other pages or documents.
     See <link xref="mal_attr_link"/> for more information.</p></item>
+
+    <item><p>The <code>app</code> element can have attributes from external
+    namespaces.  See <link xref="mal_attr_external"/> for more information
+    on external-namespace attributes on inline elements.</p></item>
   </list>
-  <comment><cite date="2008-11-13"><name>Shaun McCance</name></cite>
-  <p>Add a note about external attributes</p></comment>
 </section>
 <!-- END notes -->
 
diff --git a/doc/mallard/C/mal_inline_cmd.xml b/doc/mallard/C/mal_inline_cmd.xml
index b62ce47..3cb75fd 100644
--- a/doc/mallard/C/mal_inline_cmd.xml
+++ b/doc/mallard/C/mal_inline_cmd.xml
@@ -5,7 +5,6 @@
 <info>
   <link type="guide" xref="mal_inline#elements"/>
   <link type="seealso" xref="mal_block_screen"/>
-  <link type="seealso" xref="mal_attr_link"/>
 
   <version number="0.1" date="2007-02-05" status="incomplete"/>
 
@@ -52,6 +51,39 @@ such as options and arguments, when these need to be referenced alone.</p>
 by the user.</p>
 
 
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list type="bullet">
+    <item><p>The <code>style</code> attribute takes a space-seperated list of
+    style hints.  Processing tools should adjust their rendering according to
+    those style hints they understand.</p></item>
+
+    <item><p>The <code>mime</code> attribute takes a valid MIME type.  Processing
+    tools may adjust their rendering for particular MIME types.</p></item>
+
+    <item>
+      <p>Typical values for the <code>mime</code> attribute include:</p>
+      <table><tr>
+        <td><code>application/x-sh</code></td>
+        <td>Command to execute with the Bourne shell</td>
+      </tr><tr>
+        <td><code>application/x-csh</code></td>
+        <td>Command to execute with the C shell</td>
+      </tr></table>
+    </item>
+
+    <item><p>The <code>cmd</code> element can link to other pages or documents.
+    See <link xref="mal_attr_link"/> for more information.</p></item>
+
+    <item><p>The <code>cmd</code> element can have attributes from external
+    namespaces.  See <link xref="mal_attr_external"/> for more information
+    on external-namespace attributes on inline elements.</p></item>
+  </list>
+</section>
+<!-- END notes -->
+
+
 <!-- BEGIN examples -->
 <section id="examples">
   <title>Examples</title>
diff --git a/doc/mallard/C/mal_inline_code.xml b/doc/mallard/C/mal_inline_code.xml
index 8a5e53a..787f0a4 100644
--- a/doc/mallard/C/mal_inline_code.xml
+++ b/doc/mallard/C/mal_inline_code.xml
@@ -4,7 +4,6 @@
 
 <info>
   <link type="guide" xref="mal_inline#elements"/>
-  <link type="seealso" xref="mal_attr_link"/>
 
   <credit type="author">
     <name>Shaun McCance</name>
@@ -39,15 +38,26 @@ mal_inline_code = element code {
 </comment>
 
 
-<!-- BEGIN attributes -->
-<section id="attributes">
-  <title>Attributes</title>
-  <comment>
-    <cite date="2008-11-10"><name>Shaun McCance</name></cite>
-    <p>Add information about mime, maybe style</p>
-  </comment>
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list type="bullet">
+    <item><p>The <code>style</code> attribute takes a space-seperated list of
+    style hints.  Processing tools should adjust their rendering according to
+    those style hints they understand.</p></item>
+
+    <item><p>The <code>mime</code> attribute takes a valid MIME type.  Processing
+    tools may adjust their rendering for particular MIME types.</p></item>
+
+    <item><p>The <code>code</code> element can link to other pages or documents.
+    See <link xref="mal_attr_link"/> for more information.</p></item>
+
+    <item><p>The <code>code</code> element can have attributes from external
+    namespaces.  See <link xref="mal_attr_external"/> for more information
+    on external-namespace attributes on inline elements.</p></item>
+  </list>
 </section>
-<!-- END attributes -->
+<!-- END notes -->
 
 
 <!-- BEGIN examples -->
diff --git a/doc/mallard/C/mal_inline_em.xml b/doc/mallard/C/mal_inline_em.xml
index 8737614..551abe3 100644
--- a/doc/mallard/C/mal_inline_em.xml
+++ b/doc/mallard/C/mal_inline_em.xml
@@ -4,7 +4,6 @@
 
 <info>
   <link type="guide" xref="mal_inline#elements"/>
-  <link type="seealso" xref="mal_attr_link"/>
 
   <credit type="author">
     <name>Shaun McCance</name>
@@ -38,6 +37,25 @@ Do not use <code>em</code> to effect a particular typographic style, since it
 may be rendered differently by different processing tools.</p>
 
 
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list type="bullet">
+    <item><p>The <code>style</code> attribute takes a space-seperated list of
+    style hints.  Processing tools should adjust their rendering according to
+    those style hints they understand.</p></item>
+
+    <item><p>The <code>em</code> element can link to other pages or documents.
+    See <link xref="mal_attr_link"/> for more information.</p></item>
+
+    <item><p>The <code>em</code> element can have attributes from external
+    namespaces.  See <link xref="mal_attr_external"/> for more information
+    on external-namespace attributes on inline elements.</p></item>
+  </list>
+</section>
+<!-- END notes -->
+
+
 <!-- BEGIN examples -->
 <section id="examples">
   <title>Examples</title>
diff --git a/doc/mallard/C/mal_inline_file.xml b/doc/mallard/C/mal_inline_file.xml
index dbe40e2..204ec01 100644
--- a/doc/mallard/C/mal_inline_file.xml
+++ b/doc/mallard/C/mal_inline_file.xml
@@ -4,7 +4,6 @@
 
 <info>
   <link type="guide" xref="mal_inline#elements"/>
-  <link type="seealso" xref="mal_attr_link"/>
 
   <credit type="author">
     <name>Shaun McCance</name>
@@ -32,6 +31,26 @@ mal_inline_file = element file {
 }
 </code></synopsis>
 
+
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list type="bullet">
+    <item><p>The <code>style</code> attribute takes a space-seperated list of
+    style hints.  Processing tools should adjust their rendering according to
+    those style hints they understand.</p></item>
+
+    <item><p>The <code>file</code> element can link to other pages or documents.
+    See <link xref="mal_attr_link"/> for more information.</p></item>
+
+    <item><p>The <code>file</code> element can have attributes from external
+    namespaces.  See <link xref="mal_attr_external"/> for more information
+    on external-namespace attributes on inline elements.</p></item>
+  </list>
+</section>
+<!-- END notes -->
+
+
 <comment>
   <cite date="2007-01-30"><name>Shaun McCance</name></cite>
   <p>Add examples, processing expectations</p>
diff --git a/doc/mallard/C/mal_inline_gui.xml b/doc/mallard/C/mal_inline_gui.xml
index ae7bc95..65207a2 100644
--- a/doc/mallard/C/mal_inline_gui.xml
+++ b/doc/mallard/C/mal_inline_gui.xml
@@ -4,7 +4,6 @@
 
 <info>
   <link type="guide" xref="mal_inline#elements"/>
-  <link type="seealso" xref="mal_attr_link"/>
 
   <credit type="author">
     <name>Shaun McCance</name>
@@ -32,10 +31,34 @@ mal_inline_gui = element gui {
 }
 </code></synopsis>
 
+
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list type="bullet">
+    <item><p>The <code>style</code> attribute takes a space-seperated list of
+    style hints.  Processing tools should adjust their rendering according to
+    those style hints they understand.</p></item>
+
+    <item><p>The <code>gui</code> element can link to other pages or documents.
+    See <link xref="mal_attr_link"/> for more information.</p></item>
+
+    <item><p>The <code>gui</code> element can have attributes from external
+    namespaces.  See <link xref="mal_attr_external"/> for more information
+    on external-namespace attributes on inline elements.</p></item>
+  </list>
+</section>
+<!-- END notes -->
+
+
+<!-- BEGIN examples -->
 <section id="examples">
   <title>Examples</title>
 </section>
+<!-- END examples -->
 
+
+<!-- BEGIN processing -->
 <section id="processing">
   <title>Processing Expectations</title>
   <comment>
@@ -43,7 +66,10 @@ mal_inline_gui = element gui {
     <p>Add processing expectations.</p>
   </comment>
 </section>
+<!-- END processing -->
+
 
+<!-- BEGIN docbook -->
 <section id="docbook">
   <title>Comparison to DocBook</title>
   <p>The <code>gui</code> element is functionally similar to DocBook's deprecated
@@ -66,5 +92,6 @@ mal_inline_gui = element gui {
     <p>See principle of just enough markup</p>
   </comment>
 </section>
+<!-- END docbook -->
 
 </page>
diff --git a/doc/mallard/C/mal_inline_guiseq.xml b/doc/mallard/C/mal_inline_guiseq.xml
index a46ce19..8cefb78 100644
--- a/doc/mallard/C/mal_inline_guiseq.xml
+++ b/doc/mallard/C/mal_inline_guiseq.xml
@@ -33,4 +33,20 @@ mal_inline_guiseq = element guiseq {
 <p>The <code>guiseq</code> element marks a sequence of graphical interface
 elements.  This is typically used to to present a sequence of menu items.</p>
 
+
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list type="bullet">
+    <item><p>The <code>style</code> attribute takes a space-seperated list of
+    style hints.  Processing tools should adjust their rendering according to
+    those style hints they understand.</p></item>
+
+    <item><p>The <code>guiseq</code> element can have attributes from external
+    namespaces.  See <link xref="mal_attr_external"/> for more information
+    on external-namespace attributes on inline elements.</p></item>
+  </list>
+</section>
+<!-- END notes -->
+
 </page>
diff --git a/doc/mallard/C/mal_inline_input.xml b/doc/mallard/C/mal_inline_input.xml
index 8fdf9b1..f7fd41f 100644
--- a/doc/mallard/C/mal_inline_input.xml
+++ b/doc/mallard/C/mal_inline_input.xml
@@ -4,7 +4,6 @@
 
 <info>
   <link type="guide" xref="mal_inline#elements"/>
-  <link type="seealso" xref="mal_attr_link"/>
   <link type="seealso" xref="mal_inline_output"/>
 
   <credit type="author">
@@ -33,4 +32,27 @@ mal_inline_input = element input {
 }
 </code></synopsis>
 
+
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list type="bullet">
+    <item><p>The <code>style</code> attribute takes a space-seperated list of
+    style hints.  Processing tools should adjust their rendering according to
+    those style hints they understand.</p></item>
+
+    <item><p>The <code>input</code> element, together with the <code>output</code>
+    element, may be used to mark up the contents of a <code>screen</code> element,
+    allowing processing tools to render them differently.</p></item>
+
+    <item><p>The <code>input</code> element can link to other pages or documents.
+    See <link xref="mal_attr_link"/> for more information.</p></item>
+
+    <item><p>The <code>input</code> element can have attributes from external
+    namespaces.  See <link xref="mal_attr_external"/> for more information
+    on external-namespace attributes on inline elements.</p></item>
+  </list>
+</section>
+<!-- END notes -->
+
 </page>
diff --git a/doc/mallard/C/mal_inline_key.xml b/doc/mallard/C/mal_inline_key.xml
index 9df01b2..2476a0f 100644
--- a/doc/mallard/C/mal_inline_key.xml
+++ b/doc/mallard/C/mal_inline_key.xml
@@ -4,7 +4,6 @@
 
 <info>
   <link type="guide" xref="mal_inline#elements"/>
-  <link type="seealso" xref="mal_attr_link"/>
 
   <version number="0.1" date="2007-02-21" status="stub"/>
 
@@ -23,4 +22,23 @@ mal_inline_key = element key {
 }
 </code></synopsis>
 
+
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list type="bullet">
+    <item><p>The <code>style</code> attribute takes a space-seperated list of
+    style hints.  Processing tools should adjust their rendering according to
+    those style hints they understand.</p></item>
+
+    <item><p>The <code>key</code> element can link to other pages or documents.
+    See <link xref="mal_attr_link"/> for more information.</p></item>
+
+    <item><p>The <code>key</code> element can have attributes from external
+    namespaces.  See <link xref="mal_attr_external"/> for more information
+    on external-namespace attributes on inline elements.</p></item>
+  </list>
+</section>
+<!-- END notes -->
+
 </page>
diff --git a/doc/mallard/C/mal_inline_keyseq.xml b/doc/mallard/C/mal_inline_keyseq.xml
index 941c554..f96df7e 100644
--- a/doc/mallard/C/mal_inline_keyseq.xml
+++ b/doc/mallard/C/mal_inline_keyseq.xml
@@ -31,4 +31,19 @@ mal_inline_keyseq = element keyseq {
 </code></synopsis>
 
 
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list type="bullet">
+    <item><p>The <code>style</code> attribute takes a space-seperated list of
+    style hints.  Processing tools should adjust their rendering according to
+    those style hints they understand.</p></item>
+
+    <item><p>The <code>keyseq</code> element can have attributes from external
+    namespaces.  See <link xref="mal_attr_external"/> for more information
+    on external-namespace attributes on inline elements.</p></item>
+  </list>
+</section>
+<!-- END notes -->
+
 </page>
diff --git a/doc/mallard/C/mal_inline_output.xml b/doc/mallard/C/mal_inline_output.xml
index 0c00622..83c0971 100644
--- a/doc/mallard/C/mal_inline_output.xml
+++ b/doc/mallard/C/mal_inline_output.xml
@@ -4,7 +4,6 @@
 
 <info>
   <link type="guide" xref="mal_inline#elements"/>
-  <link type="seealso" xref="mal_attr_link"/>
 
   <credit type="author">
     <name>Shaun McCance</name>
@@ -32,4 +31,42 @@ mal_inline_output = element output {
 }
 </code></synopsis>
 
+
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list type="bullet">
+    <item><p>The <code>style</code> attribute takes a space-seperated list of
+    style hints.  Processing tools should adjust their rendering according to
+    those style hints they understand.</p></item>
+
+    <item>
+      <p>Typical values for the <code>style</code> attribute include:</p>
+      <table><tr>
+        <td><code>output</code></td>
+        <td>Standard output from a running program</td>
+      </tr><tr>
+        <td><code>error</code></td>
+        <td>Standard error from a running program</td>
+      </tr><tr>
+        <td><code>prompt</code></td>
+        <td>The command prompt for an interactive shell</td>
+      </tr></table>
+    </item>
+
+    <item><p>The <code>output</code> element, together with the <code>input</code>
+    element, may be used to mark up the contents of a <code>screen</code> element,
+    allowing processing tools to render them differently.</p></item>
+
+    <item><p>The <code>output</code> element can link to other pages or documents.
+    See <link xref="mal_attr_link"/> for more information.</p></item>
+
+    <item><p>The <code>output</code> element can have attributes from external
+    namespaces.  See <link xref="mal_attr_external"/> for more information
+    on external-namespace attributes on inline elements.</p></item>
+  </list>
+</section>
+<!-- END notes -->
+
+
 </page>
diff --git a/doc/mallard/C/mal_inline_sys.xml b/doc/mallard/C/mal_inline_sys.xml
index 53d7b68..dd9fec8 100644
--- a/doc/mallard/C/mal_inline_sys.xml
+++ b/doc/mallard/C/mal_inline_sys.xml
@@ -4,7 +4,6 @@
 
 <info>
   <link type="guide" xref="mal_inline#elements"/>
-  <link type="seealso" xref="mal_attr_link"/>
 
   <version number="0.1" date="2007-02-21" status="stub"/>
 
@@ -23,4 +22,23 @@ mal_inline_sys = element sys {
 }
 </code></synopsis>
 
+
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list type="bullet">
+    <item><p>The <code>style</code> attribute takes a space-seperated list of
+    style hints.  Processing tools should adjust their rendering according to
+    those style hints they understand.</p></item>
+
+    <item><p>The <code>sys</code> element can link to other pages or documents.
+    See <link xref="mal_attr_link"/> for more information.</p></item>
+
+    <item><p>The <code>sys</code> element can have attributes from external
+    namespaces.  See <link xref="mal_attr_external"/> for more information
+    on external-namespace attributes on inline elements.</p></item>
+  </list>
+</section>
+<!-- END notes -->
+
 </page>
diff --git a/doc/mallard/C/mal_inline_var.xml b/doc/mallard/C/mal_inline_var.xml
index 6ac8789..74c1874 100644
--- a/doc/mallard/C/mal_inline_var.xml
+++ b/doc/mallard/C/mal_inline_var.xml
@@ -4,7 +4,6 @@
 
 <info>
   <link type="guide" xref="mal_inline#elements"/>
-  <link type="seealso" xref="mal_attr_link"/>
 
   <version number="0.1" date="2007-02-21" status="stub"/>
 
@@ -23,4 +22,23 @@ mal_inline_var = element var {
 }
 </code></synopsis>
 
+
+<!-- BEGIN notes -->
+<section id="notes">
+  <title>Notes</title>
+  <list type="bullet">
+    <item><p>The <code>style</code> attribute takes a space-seperated list of
+    style hints.  Processing tools should adjust their rendering according to
+    those style hints they understand.</p></item>
+
+    <item><p>The <code>var</code> element can link to other pages or documents.
+    See <link xref="mal_attr_link"/> for more information.</p></item>
+
+    <item><p>The <code>var</code> element can have attributes from external
+    namespaces.  See <link xref="mal_attr_external"/> for more information
+    on external-namespace attributes on inline elements.</p></item>
+  </list>
+</section>
+<!-- END notes -->
+
 </page>
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]