diff options
Diffstat (limited to 'sandbox/mallard/spec/mal_caption.xml')
-rw-r--r-- | sandbox/mallard/spec/mal_caption.xml | 68 |
1 files changed, 68 insertions, 0 deletions
diff --git a/sandbox/mallard/spec/mal_caption.xml b/sandbox/mallard/spec/mal_caption.xml index b65623e..2f96787 100644 --- a/sandbox/mallard/spec/mal_caption.xml +++ b/sandbox/mallard/spec/mal_caption.xml @@ -1,2 +1,70 @@ <topic xmlns="http://www.gnome.org/~shaunm/mallard"> +<info> + <version number="0.1" date="2007-02-05" status="draft"/> + <credit type="author" name="Shaun McCance" email="shaunm@gnome.org"/> + <copyright year="2007" name="Shaun McCance"/> + <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" /> +</info> + +<title>Captions</title> + +<synopsis><code mime="application/relax-ng-compact-syntax"> +mal_caption = element caption { + <link xref="mal_inline">mal_inline</link>+ +} +</code></synopsis> + +<p>The <code>caption</code> element marks a short text caption at the +bottom of a <link xref="mal_figure">figure</link>. Captions provide +a short textual description of the contents of the figure, often an +image. Captions are simple block elements that can contain all +general <link xref="mal_inline">inline content</link>.</p> + + +<!-- BEGIN examples --> +<section id="examples"> + <title>Examples</title> + + <p>More exaples of figures can be found on the page <link xref="mal_figure"/>.</p> + + <code><![CDATA[ +<figure> + <media type="image" mime="image/png" href="figures/mallard.png"/> + <caption>Drake, the Mallard mascot</caption> +</figure> +]]></code> + <figure> + <media type="image" mime="image/png" href="figures/mallard.png"/> + <caption>Drake, the Mallard mascot</caption> + </figure> + + <comment> + <cite name="Shaun McCance" date="2007-02-06"/> + <p>Maybe add an example with a non-image figure? Should we even allow these?</p> + </comment> +</section> +<!-- END examples --> + + +<!-- BEGIN processing --> +<section id="processing"> + <title>Processing Expectations</title> + + <p>The exact display of a caption will depend on how the enclosing figure is + displayed. A caption is a block of text that should be displayed directly + below the normal contents of the enclosing figure.</p> + + <p>Display tools should attempt to display the caption in a way that makes it + clear that it belongs to the enclosing figure. For example, if a display tool + draws a frame around the enclosing figure, it may choose to place the caption + inside that frame. If the figure is indented from its enclosing block, the + caption should also be at the same indentation level.</p> + + <p>Captions are typically displayed directly below the normal contents of the + enclosing figure, with very little vertical space above them. If the enclosing + figure contains content other than images, then display tools should be careful + to ensure the caption is not confused with the normal figure content.</p> +</section> +<!-- END processing --> + </topic> |