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

Contents of /vendor/gobosoft.com/gobo/current/doc/geant/echo_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: 2899 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 "Echo 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="echo_task">
16 <chapterinfo>
17 <copyright>
18 <year>2002-2005</year>
19 <holder>Sven Ehrke</holder>
20 </copyright>
21 <author>
22 <firstname>Sven</firstname><surname>Ehrke</surname>
23 </author>
24 <email>ericb@gobosoft.com</email>
25 <date>7 July 2005</date>
26 </chapterinfo>
27
28 <title>echo</title>
29
30 <section id="echo_description">
31 <title>Description</title>
32 <para>
33 Echo a message to stdout.
34 </para>
35 </section>
36
37 <section id="echo_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>to_file</term>
55 <listitem>
56 <para><emphasis>Description: </emphasis>if specified this attribute defines the name of the file the message will be written to</para>
57 </listitem>
58 <listitem>
59 <para><emphasis>Domain: </emphasis>valid filename</para>
60 </listitem>
61 <listitem>
62 <para><emphasis>Default: </emphasis>-</para>
63 </listitem>
64 </varlistentry>
65 <varlistentry>
66 <term>append</term>
67 <listitem>
68 <para><emphasis>Description: </emphasis>This attribute applies only if attribute 'to'file' was specified.
69 If set to 'true' 'message' will be appended to the file. Otherwise the file will be overwritten with 'message'
70 </para>
71 </listitem>
72 <listitem>
73 <para><emphasis>Domain: </emphasis>Boolean (true|false)</para>
74 </listitem>
75 <listitem>
76 <para><emphasis>Default: </emphasis>false</para>
77 </listitem>
78 </varlistentry>
79 </variablelist>
80 </section>
81
82 <section id="echo_specification">
83 <title>RNG Specification</title>
84
85 <programlisting><![CDATA[
86 <define name="echo">
87 <element name="echo">
88 <ref name="dir_if_unless"/>
89 <choice>
90 <text/>
91 <attribute name="message"/>
92 </choice>
93 <optional>
94 <attribute name="to_file"/>
95 <optional>
96 <attribute name="append"/>
97 </optional>
98 </optional>
99 </element>
100 </define>
101 ]]>
102 </programlisting>
103 </section>
104
105 <section id="echo_examples">
106 <title>Examples</title>
107
108 <programlisting><![CDATA[
109 <echo message="Hello world!"/>
110 <echo message="Hello world!" to_file="messages.txt"/>
111 <echo message="Hello world again!" to_file="messages.txt" append="true"/>
112 <echo>Hello from inside 'echo'</echo>
113 <echo>Hello from inside 'echo'
114 using more than one line</echo>
115 ]]>
116 </programlisting>
117 </section>
118
119 </chapter>

Properties

Name Value
svn:mime-type text/xml

  ViewVC Help
Powered by ViewVC 1.1.23