blob: 1b49bdc3d97353dc6fd7cda947dc3c0b826e3476 (
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
|
<page xmlns="http://www.gnome.org/~shaunm/mallard"
type="topic"
id="mal_inline_input">
<info>
<link type="guide" xref="mal_inline#elements"/>
<link type="seealso" xref="mal_inline_output"/>
<credit type="author">
<name>Shaun McCance</name>
<email>shaunm@gnome.org</email>
</credit>
<copyright>
<year>2008-2009</year>
<name>Shaun McCance</name>
</copyright>
<version number="0.1" date="2009-06-13" status="review"/>
<desc>Mark up text the user should input into a computer program.</desc>
</info>
<title>User Input</title>
<synopsis><code mime="application/relax-ng-compact-syntax">
mal_inline_input = element input {
<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>input</code> element to mark up text that is input by
the user. This may be text entered into a command-line environment
or into a text field in a graphical application.</p>
<!-- BEGIN notes -->
<section id="notes">
<title>Notes</title>
<list type="bullet">
<item><p>The <code>input</code> element can contain a mixture of text and
any <link xref="mal_inline">general inline elements</link>.</p></item>
<item><p>The <code>input</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>input</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>input</code> element can have attributes from external
namespaces. See <link xref="mal_external"/> for more information
on external-namespace attributes.</p></item>
<item><p>The <code>input</code> element, together with the
<code xref="mal_inline_output">output</code> element, may be used to mark up
the contents of a <code xref="mal_block_screen">screen</code> element,
allowing processing tools to treat them differently.</p></item>
</list>
</section>
<!-- END notes -->
<!-- BEGIN examples -->
<section id="examples">
<title>Examples</title>
<p>Use <code>input</code> to mark up a user response to a prompt:</p>
<example>
<code><![CDATA[Type <input>Y</input> at the prompt to proceed.]]></code>
<p>Type <input>Y</input> at the prompt to proceed.</p>
</example>
<p>Use <code>input</code> and <code xref="mal_inline_output">output</code>
inside a <code xref="mal_block_screen">screen</code> element:</p>
<example>
<code><![CDATA[
<screen>
<output style="prompt">$ </output><input>ls mal_inline_output.xml</input>
<output>mal_inline_output.xml</output>
</screen>
]]></code>
<screen>
<output style="prompt">$ </output><input>ls mal_inline_output.xml</input>
<output>mal_inline_output.xml</output>
</screen>
</example>
</section>
<!-- END examples -->
<!-- BEGIN processing -->
<section id="processing">
<title>Processing Expectations</title>
<p>User input is displayed in a fixed-width or wide font. Fixed-width
fonts tend to have more distinction between visually similar characters.
A border or background color may be used to make the beginning and end of
the intput clear.</p>
</section>
<!-- END processing -->
<!-- BEGIN comparison -->
<section id="comparison">
<title>Comparison to Other Formats</title>
<p>The <code>input</code> element is similar to the
<code href="http://www.docbook.org/tdg/en/html/userinput.html">userinput</code>
element in DocBook.</p>
</section>
<!-- END comparison -->
</page>
|
