summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorShaun McCance <shaunm@gnome.org>2009-04-19 15:34:38 -0500
committerShaun McCance <shaunm@gnome.org>2009-04-19 15:34:38 -0500
commit5198d2741090fe227ea297f2ca44b73c846573dc (patch)
tree84d701e54df90aa18816c6d6ad6d7a47e2f0b78a
parent6ee9acd36f1cc056a82197638bfb7f265f05ec58 (diff)
downloadgnome-doc-utils-5198d2741090fe227ea297f2ca44b73c846573dc.tar.gz
Using example element in examples for mal_block_desc
-rw-r--r--doc/mallard/C/mal_block_desc.xml23
1 files changed, 11 insertions, 12 deletions
diff --git a/doc/mallard/C/mal_block_desc.xml b/doc/mallard/C/mal_block_desc.xml
index 0f9c1f1..9c2320f 100644
--- a/doc/mallard/C/mal_block_desc.xml
+++ b/doc/mallard/C/mal_block_desc.xml
@@ -42,23 +42,22 @@ for the formal element.</p>
<section id="examples">
<title>Examples</title>
- <p>More exaples of figures can be found on the page <link xref="mal_figure"/>.</p>
+ <p>Use <code>desc</code> to provide a caption for a figure:</p>
- <code><![CDATA[
+ <example>
+ <code><![CDATA[
<figure>
<media type="image" mime="image/png" href="figures/mallard.png"/>
<desc>Drake, the Mallard mascot</desc>
</figure>
]]></code>
- <figure>
- <media type="image" mime="image/png" href="figures/mallard.png"/>
- <desc>Drake, the Mallard mascot</desc>
- </figure>
-
- <comment>
- <cite date="2007-02-06"><name>Shaun McCance</name></cite>
- <p>Maybe add an example with a non-image figure? Should we even allow these?</p>
- </comment>
+ <figure>
+ <desc>Drake, the Mallard mascot</desc>
+ <media type="image" mime="image/png" href="figures/mallard.png"/>
+ </figure>
+ </example>
+
+ <p>More exaples of figures can be found on the page <link xref="mal_block_figure"/>.</p>
</section>
<!-- END examples -->
@@ -67,7 +66,7 @@ for the formal element.</p>
<section id="processing">
<title>Processing Expectations</title>
- <p>The exact display of a description will depend on how the enclosing formatl
+ <p>The exact display of a description will depend on how the enclosing formal
element is displayed. A description is a block of text that should be displayed
directly above or below the normal contents of the enclosing element.</p>