← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/mallard/es/mal_block_listing.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:
doc/mallard/es/mal_block_listing.page
1
 
<?xml version="1.0" encoding="utf-8"?>
2
 
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="mal_block_listing">
3
 
 
4
 
<info>
5
 
  <link type="seealso" xref="mal_block_code"/>
6
 
  <link type="seealso" xref="mal_block_figure"/>
7
 
 
8
 
  <revision version="0.1" date="2009-05-19" status="review"/>
9
 
 
10
 
  <credit type="author">
11
 
    <name>Shaun McCance</name>
12
 
    <email>shaunm@gnome.org</email>
13
 
    <years>2008-2009</years>
14
 
  </credit>
15
 
 
16
 
  <include xmlns="http://www.w3.org/2001/XInclude" href="legal.xml"/>
17
 
 
18
 
  <desc>Provide a name and description for a code block or other content.</desc>
19
 
</info>
20
 
 
21
 
<title>Listings</title>
22
 
 
23
 
<synopsis><code mime="application/relax-ng-compact-syntax">
24
 
mal_block_listing = element listing {
25
 
  attribute style { xsd:NMTOKENS } ?,
26
 
  attribute * - (mal:* | local:*) { text } *,
27
 
 
28
 
  <link xref="mal_block_title">mal_block_title</link> ?,
29
 
  <link xref="mal_block_desc">mal_block_desc</link> ?,
30
 
  <link xref="mal_block">mal_block</link> +
31
 
}
32
 
</code></synopsis>
33
 
 
34
 
<p>Use the <code>listing</code> element to create named listing of file contents
35
 
or other content.  Listings are usually used with <link xref="mal_block_code">code
36
 
blocks</link> to provide a name for the file to enter the content into.  They may
37
 
also be used to provide a name for an <link xref="mal_block_screen">interactive
38
 
shell session</link> or any other type of content.  To provide a title for images
39
 
or other multimedia objects, use the <link xref="mal_block_figure">figure</link>
40
 
element.</p>
41
 
 
42
 
<!-- BEGIN notes -->
43
 
<section id="notes">
44
 
  <title>Notas</title>
45
 
  <list>
46
 
    <item><p>The <code>listing</code> element contains an optional
47
 
    <link xref="mal_block_title">title</link> element, an optional
48
 
    <link xref="mal_block_desc">desc</link> element, and  any
49
 
    <link xref="mal_block">general block content</link>.</p></item>
50
 
 
51
 
    <item><p>The <code>listing</code> element can occur in any
52
 
    general block context, including inside
53
 
    <link xref="mal_page">pages</link>, <link xref="mal_section">sections</link>,
54
 
    and certain <link xref="mal_block">block elements</link>.</p></item>
55
 
 
56
 
    <item><p>The <code>style</code> attribute takes a space-separated list of
57
 
    style hints.  Processing tools should adjust their behavior according to
58
 
    those style hints they understand.</p></item>
59
 
 
60
 
    <item><p>The <code>listing</code> element can have attributes from external
61
 
    namespaces.  See <link xref="mal_external"/> for more information
62
 
    on external-namespace attributes.</p></item>
63
 
  </list>
64
 
</section>
65
 
<!-- END notes -->
66
 
 
67
 
 
68
 
<!-- BEGIN examples -->
69
 
<section id="examples">
70
 
  <title>Ejemplos</title>
71
 
 
72
 
  <p>Use <code>listing</code> to provide a file name and description for a
73
 
  code block:</p>
74
 
 
75
 
  <example>
76
 
    <code><![CDATA[
77
 
<listing>
78
 
  <title><file>index.page</file></title>
79
 
  <desc>A first Mallard page</desc>
80
 
  <code><![CDATA[
81
 
<page xmlns="http://projectmallard.org/1.0/"
82
 
      type="guide"
83
 
      id="index">
84
 
  <!-- Content goes here -->
85
 
</page>]]]>]&gt;<![CDATA[</code>
86
 
</listing>]]></code>
87
 
    <listing>
88
 
      <title><file>index.page</file></title>
89
 
      <desc>A first Mallard page</desc>
90
 
      <code><![CDATA[
91
 
<page xmlns="http://projectmallard.org/1.0/"
92
 
      type="guide"
93
 
      id="index">
94
 
  <!-- Content goes here -->
95
 
</page>]]></code>
96
 
    </listing>
97
 
  </example>
98
 
</section>
99
 
<!-- END examples -->
100
 
 
101
 
 
102
 
<!-- BEGIN processing -->
103
 
<section id="processing">
104
 
  <title>Processing Expectations</title>
105
 
 
106
 
  <p>Listings are displayed as block elements, with each of their child elements
107
 
  being interpreted as block elements.  When present, the title and description
108
 
  should be displayed in a way that makes their respective roles clear.</p>
109
 
</section>
110
 
<!-- END processing -->
111
 
 
112
 
 
113
 
<!-- BEGIN comparison -->
114
 
<!--
115
 
No direct analog in DocBook.  I'm sure people accomplish the same thing somehow,
116
 
but my brain isn't working right now.  Also check DITA.
117
 
<section id="comparison">
118
 
  <title>Comparison to Other Formats</title>
119
 
</section>
120
 
-->
121
 
<!-- END comparison -->
122
 
 
123
 
</page>