1
<?xml version="1.0" encoding="utf-8"?>
2
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="mal_info_desc">
5
<link type="guide" xref="mal_info#elements"/>
7
<revision version="0.1" date="2009-05-29" status="review"/>
10
<name>Shaun McCance</name>
11
<email>shaunm@gnome.org</email>
12
<years>2008-2009</years>
15
<include xmlns="http://www.w3.org/2001/XInclude" href="legal.xml"/>
17
<desc>Provide a short description of a page or section.</desc>
20
<title>Page Descriptions</title>
22
<synopsis><code mime="application/relax-ng-compact-syntax">
23
mal_info_desc = element desc {
24
attribute * - (mal:* | local:*) { text } *,
26
<link xref="mal_inline">mal_inline</link>
30
<p>The <code>desc</code> element can be used to provide a short description
31
for a page or section. While this description is generally not shown on the
32
page itself, it is used in automatic links to the page or section. It may
33
also be used for various other purposes by different tools.</p>
40
<item><p>The <code>desc</code> element can contain a mixture of text and
41
any <link xref="mal_inline">general inline elements</link>.</p></item>
43
<item><p>The <code>desc</code> element can occur in any
44
<code xref="mal_info">info</code> element.</p></item>
46
<item><p>The <code>desc</code> element can have attributes from external
47
namespaces. See <link xref="mal_external"/> for more information
48
on external-namespace attributes.</p></item>
50
<item><p>The <code>desc</code> element can also be used in a block context.
51
See <link xref="mal_block_desc"/> for more information.</p></item>
57
<!-- BEGIN processing -->
58
<section id="processing">
59
<title>Processing Expectations</title>
61
<p>The <code>desc</code> is not necessarily displayed on the page in which it
62
appears. It is, however, used for <link xref="links">automatic links</link>,
63
which usually display a link block showing the title and description of the
64
linked-to page or section. When it is displayed, its contents are treated
65
as inline content.</p>
67
<!-- END processing -->