~ubuntu-branches/ubuntu/trusty/gnome-doc-utils/trusty-proposed

« back to all changes in this revision

Viewing changes to doc/mallard/es/mal_info_desc.page

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2010-02-23 15:55:38 UTC
  • mfrom: (1.1.29 upstream)
  • Revision ID: james.westby@ubuntu.com-20100223155538-odq0bbr5tl0p2lpv
Tags: 0.19.5-0ubuntu1
* New upstream release:
  - Updated the Mallard RNG schema (Shaun McCance)
  - Bold userinput inside programlisting (Shaun McCance)
  - Updated translations
* debian/control.in:
  - bump Standards-Version

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
<?xml version="1.0" encoding="utf-8"?>
2
 
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="mal_info_desc">
3
 
 
4
 
<info>
5
 
  <link type="guide" xref="mal_info#elements"/>
6
 
 
7
 
  <revision version="0.1" date="2009-05-29" status="review"/>
8
 
 
9
 
  <credit type="author">
10
 
    <name>Shaun McCance</name>
11
 
    <email>shaunm@gnome.org</email>
12
 
    <years>2008-2009</years>
13
 
  </credit>
14
 
 
15
 
  <include xmlns="http://www.w3.org/2001/XInclude" href="legal.xml"/>
16
 
 
17
 
  <desc>Provide a short description of a page or section.</desc>
18
 
</info>
19
 
 
20
 
<title>Page Descriptions</title>
21
 
 
22
 
<synopsis><code mime="application/relax-ng-compact-syntax">
23
 
mal_info_desc = element desc {
24
 
  attribute * - (mal:* | local:*) { text } *,
25
 
 
26
 
  <link xref="mal_inline">mal_inline</link>
27
 
}
28
 
</code></synopsis>
29
 
 
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>
34
 
 
35
 
<!-- BEGIN notes -->
36
 
<section id="notes">
37
 
  <title>Notas</title>
38
 
 
39
 
  <list>
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>
42
 
 
43
 
    <item><p>The <code>desc</code> element can occur in any
44
 
    <code xref="mal_info">info</code> element.</p></item>
45
 
 
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>
49
 
 
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>
52
 
  </list>
53
 
</section>
54
 
<!-- END notes -->
55
 
 
56
 
 
57
 
<!-- BEGIN processing -->
58
 
<section id="processing">
59
 
  <title>Processing Expectations</title>
60
 
 
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>
66
 
</section>
67
 
<!-- END processing -->
68
 
 
69
 
</page>