From 5e1f23d4285564258ab8c9c43ec2c7b33853d528 Mon Sep 17 00:00:00 2001
From: Shaun McCance desc
is formatted as a caption
for the formal element.
The desc
element can contain a mixture of text and
+ any general inline elements.
The desc
element can occur in the formal block elements
+ figure
,
+ listing
, and
+ synopsis
.
The style
attribute takes a space-separated list of
+ style hints. Processing tools should adjust their behavior according to
+ those style hints they understand.
The desc
element can have attributes from external
+ namespaces. See for more information
+ on external-namespace attributes.
The desc
element can also be used in an informational
+ context. See for more information.
Use desc
to provide a caption for a figure:
Use desc
to provide a caption for a
+ figure:
-
Drake, the Mallard mascot
+
]]>
More exaples of figures can be found on the page .
+Use desc
to provide a caption for a
+ listing:
+ A first Mallard page
+
+
+]]]>]>
+]]>
+
+ A first Mallard page
+
+
+]]>
+
+
More exaples can be found on the pages , + , and .
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 + element is displayed. A description is a block of text that is displayed directly above or below the normal contents of the enclosing element.
-Display tools should attempt to display the description in a way that makes it - clear that it belongs to the enclosing formal element. For example, if a display - tool draws a frame around an enclosing figure, it may choose to place the description - inside that frame. If the formal element is indented from its enclosing block, the - description should also be at the same indentation level.
+A description should be displayed in a way that makes its role clearn and + which clearly distinguishes it from the normal block content of the enclosing + element.
diff --git a/doc/mallard/C/mal_block_figure.xml b/doc/mallard/C/mal_block_figure.xml index 2920eb0..a9ad7f1 100644 --- a/doc/mallard/C/mal_block_figure.xml +++ b/doc/mallard/C/mal_block_figure.xml @@ -3,7 +3,23 @@ id="mal_block_figure">Add explanation, examples, processing expectations
-A way to float right, a'la wikipedia?
-Use the figure
element to provide a title or caption for a
+multimedia object or other block object.
+To provide a title for the contents of a file, such as a
+code block, use the
+listing
element instead.
Use figure
to provide a title and caption for an image:
+ Drake
+ Drake is the Mallard mascot.
+
+
+]]>
+
+ Figures are displayed as block elements, with each of their child elements + being interpreted as block elements. When present, the title and description + should be displayed in a way that makes their respective roles clear.
+The figure
is similar to the
+ figure
+ element in DocBook. DocBook only provides a title for figures, whereas
+ Mallard distinguishes between a title and a caption.