summaryrefslogtreecommitdiff
path: root/doc/mallard/C/mal_external.xml
blob: d07aa30f748017bb6b08037bf657a1f6d07f6dc7 (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
<page xmlns="http://www.gnome.org/~shaunm/mallard"
      type="topic"
      id="mal_external">

<info>
  <link type="seealso" xref="mal_inline"/>

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

  <revision version="0.1" date="2008-02-19" status="incomplete"/>

  <desc>Use elements and attributes from other namespaces in Mallard
  documents.</desc>
</info>

<title>External Namespaces</title>

<comment>
  <cite date="2008-12-01"><name>Shaun McCance</name></cite>
  <p>Add content</p>
</comment>


<!-- BEGIN attributes -->
<section id="attributes">
  <info>
    <title type="link">External Namespace Attributes</title>
  </info>
  <title>Attributes</title>

  <p>All elements in Mallard can have attributes from external namespaces.
  This can be used to clarify the meaning of an element in a particular
  context, to provide additional information to processing tools, or to
  embed richer semantic data in a document.</p>

  <p>For example, a translation tool might copy
  <link xref="mal_block_code">code blocks</link> directly into the translated
  document without presenting them to translators.  Some code blocks, however,
  may contain human-readable comments which should be translated.  In order to
  force translation tools to present these code blocks for translation, authors
  could use the <code>its:translate</code> attribute from the
  <link href="http://www.w3.org/TR/its/">Internationalization Tag Set</link>,
  as in the following:</p>

  <code><![CDATA[
<code xmlns:its="http://www.w3.org/2005/11/its" 
      its:version="1.0" its:translate="yes">
// This code block should be translated because it contains this comment.
some_code ()
</code>
]]></code>

  <p>Processing tools should ignore any attributes from external namespaces
  they do not understand.</p>
</section>
<!-- END attributes -->


<!-- BEGIN elements -->
<section id="elements">
  <info>
    <title type="link">External Namespace Elements</title>
  </info>
  <title>Elements</title>
</section>
<!-- END elements -->

</page>