summaryrefslogtreecommitdiff
path: root/doc/mallard/C/mal_inline_span.xml
blob: 5749c6bcedc4a4b6bc91a0ee56609834fca724d8 (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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
<page xmlns="http://www.gnome.org/~shaunm/mallard"
      type="topic"
      id="mal_inline_span">

<info>
  <link type="guide" xref="mal_inline#elements"/>
  <link type="seealso" xref="mal_attr_link"/>

  <version number="0.1" date="2009-05-13" status="review"/>

  <credit type="author">
    <name>Shaun McCance</name>
    <email>shaunm@gnome.org</email>
  </credit>
  <copyright>
    <year>2007-2009</year>
    <name>Shaun McCance</name>
  </copyright>

  <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" />

  <desc>A generic inline element that can be used for semantic,
  localization, and styling purpose.</desc>
</info>

<title>Spans</title>

<synopsis><code mime="application/relax-ng-compact-syntax">
mal_inline_span = element span {
  <link xref="mal_attr_link">mal_attr_link</link> ?,
  attribute style { xsd:NMTOKENS } ?,
  attribute * - (mal:* | local:*) { text } *,

  <link xref="mal_inline">mal_inline</link>
}
</code></synopsis>

<p>Use the <code>span</code> element to surround a run of text
without using any of the semantic <link xref="mal_inline">inline
elements</link>.  This is frequently necessary for extensions
using attributes from external namespaces.</p>


<!-- BEGIN notes -->
<section id="notes">
  <title>Notes</title>
  <list type="bullet">
    <item><p>The <code>span</code> element can contain a mixture of text and
    any <link xref="mal_inline">general inline elements</link>.</p></item>

    <item><p>The <code>span</code> element can occur in any
    general inline context, including inside most
    <link xref="mal_inline">inline elements</link>, some
    <link xref="mal_block#basic">basic block elements</link>, and certain
    <link xref="mal_info">informational elements</link>.</p></item>

    <item><p>The <code>span</code> element can link to other pages or documents.
    See <link xref="mal_attr_link"/> for more information.</p></item>

    <item><p>The <code>style</code> attribute takes a space-separated list of
    style hints.  Processing tools should adjust their behavior according to
    those style hints they understand.</p></item>

    <item><p>The <code>span</code> element can have attributes from external
    namespaces.  See <link xref="mal_external"/> for more information
    on external-namespace attributes.</p></item>
  </list>
</section>
<!-- END notes -->


<!-- BEGIN examples -->
<section id="examples">
  <title>Examples</title>

  <p>Use <code>span</code> with an external-namespace attribute to mark a word
  as untranslatable using the
  <link href="http://www.w3.org/TR/its/">Internationalization Tag Set</link>:</p>

  <example>
    <code><![CDATA[
This <phrase its:translate="no">word</phrase> should not be translated.]]></code>
    <p>This <phrase xmlns:its="http://www.w3.org/2005/11/its" its:version="1.0"
    its:translate="no">word</phrase> should not be translated.</p>
  </example>
</section>
<!-- END examples -->


<!-- BEGIN processing -->
<section id="processing">
  <title>Processing Expectations</title>

  <p>No particular special rendering is required for <code>span</code> elements.
  Processing tools may have special processing rules for certain style hints or
  external-namespace attributes.</p>
</section>
<!-- END processing -->


<!-- BEGIN comparison -->
<section id="comparison">
  <title>Comparison to Other Formats</title>
  <p>The <code>span</code> element is similar to the
  <code href="http://www.docbook.org/tdg/en/html/phrase.html">phrase</code>
  element in DocBook.</p>
</section>
<!-- END comparison -->

</page>