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

« back to all changes in this revision

Viewing changes to doc/mallard/C/mal_inline.page

  • Committer: Bazaar Package Importer
  • Author(s): Didier Roche
  • Date: 2009-06-15 11:03:13 UTC
  • mfrom: (1.1.24 upstream)
  • Revision ID: james.westby@ubuntu.com-20090615110313-b4vn2m00muam19tc
Tags: 0.17.1-0ubuntu1
* New upstream release: (LP: #387210)
  - Integrated Mallard support
  - Fix file-not-found warnings from config.status (Christian Persch)

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<page xmlns="http://projectmallard.org/1.0/"
 
2
      type="guide"
 
3
      id="mal_inline">
 
4
 
 
5
<info>
 
6
  <link type="guide" xref="spec"/>
 
7
 
 
8
  <revision version="0.1" date="2009-04-16" status="review"/>
 
9
 
 
10
  <credit type="author">
 
11
    <name>Shaun McCance</name>
 
12
    <email>shaunm@gnome.org</email>
 
13
  </credit>
 
14
  <copyright>
 
15
    <year>2009</year>
 
16
    <name>Shaun McCance</name>
 
17
  </copyright>
 
18
 
 
19
  <include href="legal.xml" xmlns="http://www.w3.org/2001/XInclude" />
 
20
 
 
21
  <desc>Rich semantic elements for marking up inline content.</desc>
 
22
</info>
 
23
 
 
24
<title>Inline Elements</title>
 
25
 
 
26
<synopsis><code mime="application/relax-ng-compact-syntax">
 
27
mal_inline = mixed {
 
28
  <link xref="mal_inline_app">mal_inline_app</link> *,
 
29
  <link xref="mal_inline_cmd">mal_inline_cmd</link> *,
 
30
  <link xref="mal_inline_code">mal_inline_code</link> *,
 
31
  <link xref="mal_inline_em">mal_inline_em</link> *,
 
32
  <link xref="mal_inline_file">mal_inline_file</link> *,
 
33
  <link xref="mal_inline_gui">mal_inline_gui</link> *,
 
34
  <link xref="mal_inline_guiseq">mal_inline_guiseq</link> *,
 
35
  <link xref="mal_inline_input">mal_inline_input</link> *,
 
36
  <link xref="mal_inline_key">mal_inline_key</link> *,
 
37
  <link xref="mal_inline_keyseq">mal_inline_keyseq</link> *,
 
38
  <link xref="mal_inline_link">mal_inline_link</link> *,
 
39
  <link xref="mal_inline_media">mal_inline_media</link> *,
 
40
  <link xref="mal_inline_output">mal_inline_output</link> *,
 
41
  <link xref="mal_inline_span">mal_inline_span</link> *,
 
42
  <link xref="mal_inline_sys">mal_inline_sys</link> *,
 
43
  <link xref="mal_inline_var">mal_inline_var</link> *,
 
44
  element * - (mal:* | local:*) { mal_inline } *
 
45
}
 
46
</code></synopsis>
 
47
 
 
48
<p>Mallard provides a small but rich set of semantic inline elements.
 
49
The elements provided are culled from first-hand experience with software
 
50
documentation and other document formats.  The inline elements defined in
 
51
this specification will serve most software documentation writers' needs
 
52
well.</p>
 
53
 
 
54
<p>Authors, editors, or other content producers sometimes need to supply
 
55
richer information in their documents.  While this information may not
 
56
be conveyed by display tools, it may be used for various internal tracking
 
57
purposes.  Mallard allows elements to be extended with attributes from
 
58
external namespaces.  See <link xref="mal_external"/> for more
 
59
information.</p>
 
60
 
 
61
<p>Furthermore, Mallard allows elements from external namespaces to be
 
62
used in any inline context.  See <link xref="#processing"/> below for
 
63
more information.</p>
 
64
 
 
65
 
 
66
<!-- BEGIN elements -->
 
67
<section id="elements" style="2column">
 
68
  <info>
 
69
    <title type="link">Inline Elements</title>
 
70
  </info>
 
71
  <title>Elements</title>
 
72
</section>
 
73
<!-- END elements -->
 
74
 
 
75
 
 
76
<!-- BEGIN processing -->
 
77
<section id="processing">
 
78
  <info>
 
79
    <title type="link">Inline Processing Instructions</title>
 
80
  </info>
 
81
  <title>Processing Expectations</title>
 
82
 
 
83
  <p>Inline elements occur within block elements or other inline elements.
 
84
  Mallard never allows block elements within inline elements.  Inline elements
 
85
  should never introduce a line break in the rendered output.</p>
 
86
 
 
87
  <p>Different inline elements may introduce different styling effects, such
 
88
  as font variations, text and background colors, and backgrounds.  Generally,
 
89
  if a styling effect is set for a particular element, it is in effect for all
 
90
  descendant elements, unless explicitly overridden.</p>
 
91
 
 
92
  <p>Mallard allows elements from external namespaces to be used in any inline
 
93
  context.  Processing tools may have special behavior for particular elements
 
94
  they understand.  Otherwise, an unknown inline element should be processed
 
95
  as if it were replaced by its child content.</p>
 
96
</section>
 
97
<!-- END processing -->
 
98
 
 
99
</page>