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

<info>
  <version number="0.1" date="2007-02-21" status="stub"/>
</info>

<title>Notes</title>

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

  <link xref="mal_title">mal_title</link> ?,
  <link xref="mal_block">mal_block</link> +
}
</code></synopsis>

<!-- BEGIN notes -->
<section id="notes">
  <title>Notes</title>
  <list type="bullet">
    <item><p>The <code>note</code> element contains an optional
    <link xref="mal_title">title</link> element and  any
    <link xref="mal_block">general block content</link>.</p></item>

    <item><p>The <code>note</code> element can occur in any
    general block context, including inside
    <link xref="mal_page">pages</link>, <link xref="mal_section">sections</link>,
    and certain <link xref="mal_block">block elements</link>.</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 following style hints are recommended:</p>
      <table rules="rows">
        <tr>
          <td><p><code>"advanced"</code></p></td>
          <td><p>information that advanced users may find useful</p></td>
        </tr>
        <tr>
          <td><p><code>"bug"</code></p></td>
          <td><p>a note about a known bug in the software</p></td>
        </tr>
        <tr>
          <td><p><code>"tip"</code></p></td>
          <td><p>a general tip that may help the reader perform an operation better</p></td>
        </tr>
        <tr>
          <td><p><code>"warning"</code></p></td>
          <td><p>a warning to the reader about a potentially dangerous operation</p></td>
        </tr>
      </table>
    </item>

    <item><p>The <code>note</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>
</section>
<!-- END examples -->

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

<!-- BEGIN docbook -->
<section id="docbook">
  <title>Comparison to DocBook</title>
</section>
<!-- END docbook -->

</page>