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

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 90767 - (show annotations)
Tue Jan 22 00:56:30 2013 UTC (6 years, 9 months ago) by manus
File MIME type: text/xml
File size: 3038 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 "Available 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="available_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>available</title>
29
30 <section id="available_description">
31 <title>Description</title>
32 <para>
33 Checks if specified resource is available and sets the value of a variable depending on the result.
34 </para>
35 </section>
36
37 <section id="available_parameters">
38 <title>Parameters</title>
39
40 <variablelist>
41 <varlistentry>
42 <term>resource</term>
43 <listitem>
44 <para><emphasis>Description: </emphasis>Name of a resource. Currently files and directories are supported</para>
45 </listitem>
46 <listitem>
47 <para><emphasis>Domain: </emphasis>Valid filename/directoryname</para>
48 </listitem>
49 <listitem>
50 <para><emphasis>Default: </emphasis>-</para>
51 </listitem>
52 </varlistentry>
53
54 <varlistentry>
55 <term>variable</term>
56 <listitem>
57 <para><emphasis>Description: </emphasis>variable which reflects the result</para>
58 </listitem>
59 <listitem>
60 <para><emphasis>Domain: </emphasis>valid variable name</para>
61 </listitem>
62 <listitem>
63 <para><emphasis>Default: </emphasis>-</para>
64 </listitem>
65 </varlistentry>
66
67 <varlistentry>
68 <term>true_value</term>
69 <listitem>
70 <para><emphasis>Description: </emphasis>result value of positive comparison</para>
71 </listitem>
72 <listitem>
73 <para><emphasis>Domain: </emphasis>-</para>
74 </listitem>
75 <listitem>
76 <para><emphasis>Default: </emphasis>true</para>
77 </listitem>
78 </varlistentry>
79
80 <varlistentry>
81 <term>false_value</term>
82 <listitem>
83 <para><emphasis>Description: </emphasis>result value of negative comparison</para>
84 </listitem>
85 <listitem>
86 <para><emphasis>Domain: </emphasis>-</para>
87 </listitem>
88 <listitem>
89 <para><emphasis>Default: </emphasis>false</para>
90 </listitem>
91 </varlistentry>
92
93 </variablelist>
94 </section>
95
96 <section id="available_specification">
97 <title>RNG Specification</title>
98
99 <programlisting><![CDATA[
100 <define name="available">
101 <element name="available">
102 <ref name="dir_if_unless"/>
103 <attribute name="resource"/>
104 <attribute name="variable"/>
105 <optional>
106 <attribute name="true_value"/>
107 </optional>
108 <optional>
109 <attribute name="false_value"/>
110 </optional>
111 </element>
112 </define>
113 ]]>
114 </programlisting>
115 </section>
116
117 <section id="available_examples">
118 <title>Examples</title>
119 <programlisting><![CDATA[
120 <available resource="${GOBO}/readme.txt" variable="available"/>
121 ]]>
122 </programlisting>
123 </section>
124
125 </chapter>

Properties

Name Value
svn:mime-type text/xml

  ViewVC Help
Powered by ViewVC 1.1.23