← 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/de/mal_block_example.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/de/mal_block_example.page
1
 
<?xml version="1.0" encoding="utf-8"?>
2
 
<page xmlns="http://projectmallard.org/1.0/" type="topic" id="mal_block_example">
3
 
 
4
 
<info>
5
 
  <revision version="0.1" date="2009-05-06" status="review"/>
6
 
 
7
 
  <credit type="author">
8
 
    <name>Shaun McCance</name>
9
 
    <email>shaunm@gnome.org</email>
10
 
    <years>2008-2009</years>
11
 
  </credit>
12
 
 
13
 
  <include xmlns="http://www.w3.org/2001/XInclude" href="legal.xml"/>
14
 
 
15
 
  <desc>Mark a group of block elements as being part of a single example.</desc>
16
 
</info>
17
 
 
18
 
<title>Beispiele</title>
19
 
 
20
 
<synopsis><code mime="application/relax-ng-compact-syntax">
21
 
mal_block_example = element example {
22
 
  attribute style { xsd:NMTOKENS } ?,
23
 
  attribute * - (mal:* | local:*) { text } *,
24
 
 
25
 
  <link xref="mal_block">mal_block</link> +
26
 
}
27
 
</code></synopsis>
28
 
 
29
 
<p>Use the <code>example</code> element to place block elements into a
30
 
logical group, indicating that they are part of a single example.  This
31
 
may be used to group example input with its result, to show different
32
 
steps with different types of block elements, or simply to group some
33
 
paragraphs together.</p>
34
 
 
35
 
 
36
 
<!-- BEGIN notes -->
37
 
<section id="notes">
38
 
  <title>Anmerkungen</title>
39
 
  <list>
40
 
    <item><p>The <code>example</code> element can contain any
41
 
    <link xref="mal_block">general block content</link>.</p></item>
42
 
 
43
 
    <item><p>The <code>example</code> element can occur in any
44
 
    general block context, including inside
45
 
    <link xref="mal_page">pages</link>, <link xref="mal_section">sections</link>,
46
 
    and certain <link xref="mal_block">block elements</link>.</p></item>
47
 
 
48
 
    <item><p>The <code>style</code> attribute takes a space-separated list of
49
 
    style hints.  Processing tools should adjust their behavior according to
50
 
    those style hints they understand.</p></item>
51
 
 
52
 
    <item><p>The <code>example</code> element can have attributes from external
53
 
    namespaces.  See <link xref="mal_external"/> for more information
54
 
    on external-namespace attributes.</p></item>
55
 
  </list>
56
 
</section>
57
 
<!-- END notes -->
58
 
 
59
 
 
60
 
<!-- BEGIN examples -->
61
 
<section id="examples">
62
 
  <title>Beispiele</title>
63
 
 
64
 
  <p>Use <code>example</code> to show how to use the <code>screen</code>
65
 
  element, grouping the input and formatted result:</p>
66
 
 
67
 
  <example>
68
 
    <code><![CDATA[
69
 
<example>
70
 
<code><![CDATA[
71
 
<screen>
72
 
xsltproc -o mal_block_screen.html \
73
 
  --stringparam mal.cache.file `pwd`/mallard.cache \
74
 
  `pkg-config --variable mal2html gnome-doc-utils` \
75
 
  mal_block_screen.html
76
 
</screen>
77
 
]]>]<![CDATA[]></code>
78
 
<screen>
79
 
xsltproc -o mal_block_screen.html \
80
 
  --stringparam mal.cache.file `pwd`/mallard.cache \
81
 
  `pkg-config --variable mal2html gnome-doc-utils` \
82
 
  mal_block_screen.html
83
 
</screen>
84
 
</example>
85
 
]]></code>
86
 
    <example>
87
 
      <code><![CDATA[
88
 
<screen>
89
 
xsltproc -o mal_block_screen.html \
90
 
  --stringparam mal.cache.file `pwd`/mallard.cache \
91
 
  `pkg-config --variable mal2html gnome-doc-utils` \
92
 
  mal_block_screen.html
93
 
</screen>
94
 
]]></code>
95
 
      <screen>
96
 
xsltproc -o mal_block_screen.html \
97
 
  --stringparam mal.cache.file `pwd`/mallard.cache \
98
 
  `pkg-config --variable mal2html gnome-doc-utils` \
99
 
  mal_block_screen.html
100
 
</screen></example>
101
 
  </example>
102
 
</section>
103
 
<!-- END examples -->
104
 
 
105
 
 
106
 
<!-- BEGIN processing -->
107
 
<section id="processing">
108
 
  <title>Processing Expectations</title>
109
 
 
110
 
  <p>The contents of an <code>example</code> element should each be rendered
111
 
  as block elements as normal.  Example should use margins, borders, or other
112
 
  stylistic effects to provide a clear visual indication of the grouping.</p>
113
 
</section>
114
 
<!-- END processing -->
115
 
 
116
 
 
117
 
<!-- BEGIN comparison -->
118
 
<section id="comparison">
119
 
  <title>Vergleich mit anderen Formaten</title>
120
 
 
121
 
  <p>The <code>example</code> element is similar to the
122
 
  <code href="http://www.docbook.org/tdg/en/html/example.html">example</code>
123
 
  element in DocBook.  In DocBook, the <code>example</code> element is a
124
 
  formal element.  In Mallard, <code>example</code> is a simple container
125
 
  element, and does not allow a <code xref="mal_block_title">title</code>
126
 
  element.</p>
127
 
</section>
128
 
<!-- END comparison -->
129
 
 
130
 
</page>