Revision: 2072
Author: jprantan
Date: Tue Jul 28 06:23:17 2009
Log: regen
http://code.google.com/p/robotframework/source/detail?r=2072
Modified:
/trunk/doc/libraries/BuiltIn.html
=======================================
--- /trunk/doc/libraries/BuiltIn.html Mon Apr 13 11:21:53 2009
+++ /trunk/doc/libraries/BuiltIn.html Tue Jul 28 06:23:17 2009
@@ -79,7 +79,7 @@
</head>
<body>
<h1>BuiltIn - Documentation</h1>
-<p><b>Version:</b> trunk 20090408</p>
+<p><b>Version:</b> trunk 20090420</p>
<h2 id="introduction">Introduction</h2>
<p class='libdoc'>An always available standard library with often needed
keywords.<br />
@@ -901,7 +901,30 @@
</tr>
</table>
<br />
-See also <a href="#Set Global Variable" class="name">Set Global
Variable</a> and <a href="#Set Test Variable" class="name">Set Test
Variable</a>.</td>
+<b>NOTE:</b> If the variable has value which itself is a variable (escaped
or not), you must always use the escaped format like in the example below.
This limitation applies to <span class="name">Set Test/Suite/Global
Variable</span> and <span class="name">Variable Should (Not) Exist</span>
keywords.<br />
+<br />
+Example:<br />
+<table border="1" class="doc">
+<tr>
+<td>${NAME} =</td>
+<td>Set Variable</td>
+<td>\${variable}</td>
+<td></td>
+</tr>
+<tr>
+<td>Set Suite Variable</td>
+<td>${NAME}</td>
+<td>new value</td>
+<td># Does not work</td>
+</tr>
+<tr>
+<td>Set Suite Variable</td>
+<td>\${NAME}</td>
+<td>new value</td>
+<td># This works</td>
+</tr>
+</table>
+</td>
</tr>
<tr>
<td class="kw"><a name="Set Tags"></a>Set Tags</td>
@@ -1402,7 +1425,7 @@
<td class="arg">name, msg=None</td>
<td class="doc">Fails unless the given variable exists within the
current scope.<br />
<br />
-The name of the variable can be given either as a normal variable name
(e.g. ${NAME}) or in escaped format (e.g. \${NAME}). Notice that the former
works only in Robot Framework 2.1 and newer.<br />
+The name of the variable can be given either as a normal variable name
(e.g. ${NAME}) or in escaped format (e.g. \${NAME}). Notice that the former
works only in Robot Framework 2.1 and newer, and it has some limitations
explained in <a href="#Set Suite Variable" class="name">Set Suite
Variable</a>.<br />
<br />
The default error message can be overridden with the <span
class="name">msg</span> argument.</td>
</tr>
@@ -1411,7 +1434,7 @@
<td class="arg">name, msg=None</td>
<td class="doc">Fails if the given variable exists within the current
scope.<br />
<br />
-The name of the variable can be given either as a normal variable name
(e.g. ${NAME}) or in escaped format (e.g. \${NAME}). Notice that the former
works only in Robot Framework 2.1 and newer.<br />
+The name of the variable can be given either as a normal variable name
(e.g. ${NAME}) or in escaped format (e.g. \${NAME}). Notice that the former
works only in Robot Framework 2.1 and newer, and it has some limitations
explained in <a href="#Set Suite Variable" class="name">Set Suite
Variable</a>.<br />
<br />
The default error message can be overridden with the <span
class="name">msg</span> argument.</td>
</tr>
@@ -1441,7 +1464,7 @@
<p class="footer">
Altogether 72 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-04-13 21:17:58.
+on 2009-07-28 16:21:36.
</p>
</body>
</html>
