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
|
<refentry id="note.element">
<?dbhtml filename="note.html"?>
<refentryinfo>
<pubdate>$Date$</pubdate>
<releaseinfo>$Revision$</releaseinfo>
</refentryinfo>
<refmeta>
<indexterm><primary>elements</primary>
<secondary>note</secondary></indexterm>
<refentrytitle>note</refentrytitle>
<refmiscinfo>Element</refmiscinfo>
</refmeta>
<refnamediv>
<refname>note</refname>
<refpurpose>¬e.purpose;</refpurpose>
</refnamediv>
¬e.synopsis.gen;
<refsect1 condition='ref.description'><title>Description</title>
<para>
A <sgmltag>Note</sgmltag> is an admonition set off
from the main text.
</para>
<para>
In some types of documentation, the semantics of admonitions are clearly
defined (<sgmltag>Caution</sgmltag> might imply the possibility of harm to
equipement whereas <sgmltag>Warning</sgmltag> might imply harm to a person),
but DocBook makes no such assertions.
</para>
<refsect2><title>Processing expectations</title>
<para>
&format.block; Often outputs the generated text <quote>Note</quote>
or some other visible indication of the type of admonition,
especially if a <sgmltag>Title</sgmltag> is not present. Sometimes
outputs a graphical icon or another symbol as well.
</para>
</refsect2>
¬e.parents.gen;
¬e.children.gen;
</refsect1>
<refsect1 condition='ref.elem.seealso'><title>See Also</title>
¬e.seealso.gen;
</refsect1>
<refsect1><title>Examples</title>
<informalexample role="example-source">
<programlisting>¬e.example.1.txt;</programlisting>
</informalexample>
<anchor id="ex.os.note.1" role="HACK-ex.out.start"/>
¬e.example.1.gen;
<anchor id="ex.oe.note.1" role="HACK-ex.out.end"/>
¬e.example.seealso.gen;
</refsect1>
</refentry>
|
