/[eiffelstudio]/vendor/gobosoft.com/gobo/current/doc/geant/input_task.xml
ViewVC logotype

Contents of /vendor/gobosoft.com/gobo/current/doc/geant/input_task.xml

Parent Directory Parent Directory | Revision Log Revision Log


Revision 90767 - (show annotations)
Tue Jan 22 00:56:30 2013 UTC (6 years, 8 months ago) by manus
File MIME type: text/xml
File size: 4197 byte(s)
Updated svn:eol-style to be native and svn:mime-style to be text/xml

1 <?xml version="1.0"?>
2
3 <!--
4 description:
5
6 "Input Tasks"
7
8 library: "Gobo Eiffel Ant"
9 copyright: "Copyright (c) 2002, Sven Ehrke and others"
10 license: "MIT License"
11 date: "$Date$"
12 revision: "$Revision$"
13 -->
14
15 <chapter xmlns="http://www.gobosoft.com/eiffel/gobo/documentation" id="input_task">
16 <chapterinfo>
17 <copyright>
18 <year>2002-2006</year>
19 <holder>Sven Ehrke</holder>
20 </copyright>
21 <author>
22 <firstname>Jocelyn</firstname><surname>Fiat</surname>
23 </author>
24 <email>ericb@gobosoft.com</email>
25 <date>7 July 2005</date>
26 </chapterinfo>
27
28 <title>input</title>
29
30 <section id="input_description">
31 <title>Description</title>
32 <para>
33 Input a message from stdin.
34 </para>
35 </section>
36
37 <section id="input_parameters">
38 <title>Parameters</title>
39
40 <variablelist>
41 <varlistentry>
42 <term>message</term>
43 <listitem>
44 <para><emphasis>Description: </emphasis>Message to be echoed</para>
45 </listitem>
46 <listitem>
47 <para><emphasis>Domain: </emphasis>-</para>
48 </listitem>
49 <listitem>
50 <para><emphasis>Default: </emphasis>-</para>
51 </listitem>
52 </varlistentry>
53 <varlistentry>
54 <term>variable</term>
55 <listitem>
56 <para><emphasis>Description: </emphasis>variable which will hold the input value</para>
57 </listitem>
58 <listitem>
59 <para><emphasis>Domain: </emphasis>valid variable name</para>
60 </listitem>
61 <listitem>
62 <para><emphasis>Default: </emphasis>-</para>
63 </listitem>
64 </varlistentry>
65 <varlistentry>
66 <term>defaultvalue</term>
67 <listitem>
68 <para><emphasis>Description: </emphasis>If defined, this value is the default input value</para>
69 </listitem>
70 <listitem>
71 <para><emphasis>Domain: </emphasis>valid value (text)</para>
72 </listitem>
73 <listitem>
74 <para><emphasis>Default: </emphasis>-</para>
75 </listitem>
76 </varlistentry>
77 <varlistentry>
78 <term>validargs</term>
79 <listitem>
80 <para><emphasis>Description: </emphasis>If defined, this value defines the valid input values</para>
81 </listitem>
82 <listitem>
83 <para><emphasis>Domain: </emphasis>comma separated string containing valid input values</para>
84 </listitem>
85 <listitem>
86 <para><emphasis>Default: </emphasis>-</para>
87 </listitem>
88 </varlistentry>
89 <varlistentry>
90 <term>validregexp</term>
91 <listitem>
92 <para><emphasis>Description: </emphasis>If defined, this input value must be matched by the regular expression</para>
93 </listitem>
94 <listitem>
95 <para><emphasis>Domain: </emphasis>regular expression (text)</para>
96 </listitem>
97 <listitem>
98 <para><emphasis>Default: </emphasis>-</para>
99 </listitem>
100 </varlistentry>
101 <varlistentry>
102 <term>answer_required</term>
103 <listitem>
104 <para><emphasis>Description: </emphasis>If False, an empty input value is valid, otherwise the input value must be non empty</para>
105 </listitem>
106 <listitem>
107 <para><emphasis>Domain: </emphasis>valid boolean (True|False)</para>
108 </listitem>
109 <listitem>
110 <para><emphasis>Default: </emphasis>True</para>
111 </listitem>
112 </varlistentry>
113 </variablelist>
114 </section>
115
116 <section id="input_specification">
117 <title>RNG Specification</title>
118
119 <programlisting><![CDATA[
120 <define name="input">
121 <element name="input">
122 <ref name="dir_if_unless"/>
123 <attribute name="message"/>
124 <attribute name="variable"/>
125 <optional>
126 <attribute name="defaultvalue"/>
127 <attribute name="validargs"/>
128 <attribute name="validregexp"/>
129 <attribute name="answer_required">
130 <!-- runtime evaluation
131 <choice>
132 <value>true</value>
133 <value>false</value>
134 </choice>
135 -->
136 </attribute>
137 </optional>
138 </element>
139 </define>
140 ]]>
141 </programlisting>
142 </section>
143
144 <section id="input_examples">
145 <title>Examples</title>
146
147 <programlisting><![CDATA[
148 <input message="Do you want to continue ?" variable="answer" defaultvalue="y" validargs="y,n" />
149 <input message="Enter a string :" variable="answer" answer_required="true" />
150 <input message="Enter a number :" variable="answer" validregexp="^[0-9]+$" answer_required="true" />
151 ]]>
152 </programlisting>
153 </section>
154
155 </chapter>

Properties

Name Value
svn:mime-type text/xml

  ViewVC Help
Powered by ViewVC 1.1.23