blob: 184f4b2976d96a3f591a6adb1d52a348a1001c6f (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
|
<topic xmlns="http://www.gnome.org/~shaunm/mallard"
id="mal_synopsis">
<info>
<link type="guide" xref="mal_block#containers"/>
</info>
<title>Synopses</title>
<synopsis><code mime="application/relax-ng-compact-syntax">
mal_synopsis = element synopsis {
<link xref="mal_attr">mal_attr_common</link>,
<link xref="mal_title">mal_title</link> ?,
<link xref="mal_block#simple">mal_block_simple</link> +
}</code></synopsis>
<p>The <code>synopsis</code> element allows you to mark up a block as
providing an overview of the material being presented. It is useful
for providing a listing of functions, commands, or options in reference
material, or for enumerating the items in a menu or other graphical
control element.</p>
<comment>
<cite><name>Shaun McCance</name><date>2006-11-16</date></cite>
<p>Add explanation, examples</p>
</comment>
<section>
<title>Processing Expectations</title>
<p>A <code>synopsis</code> element is rendered as a displayed block,
with each of its child elements interpreted as block elements. Since
a <code>synopsis</code> element often contains large blocks, and is
generally offset from the running text, processing tools may opt to
render it inside a colored or screened box, with a border, or
otherwise differently from the surrounding text.</p>
<p>If a <code xref="mal_title">title</code> element is provided, it
should appear at the top of the block and be clearly marked as the
title using font variations or other stylistic means.</p>
</section>
</topic>
|
