Author: pekka.klarck
Date: Wed Mar 25 13:53:02 2009
New Revision: 1548
Modified:
trunk/doc/libraries/BuiltIn.html
Log:
regen
Modified: trunk/doc/libraries/BuiltIn.html
==============================================================================
--- trunk/doc/libraries/BuiltIn.html (original)
+++ trunk/doc/libraries/BuiltIn.html Wed Mar 25 13:53:02 2009
@@ -125,7 +125,7 @@
<a href="#Run Keyword If Test Passed" title="Runs the given keyword with
the given arguments, if the test
passed.">Run Keyword If Test Passed</a>
<a href="#Run Keyword Unless" title="Runs the given keyword with the given
arguments, if `condition` is false.">Run Keyword Unless</a>
<a href="#Set Global Variable" title="Makes a variable available globally
in all tests and suites.">Set Global Variable</a>
-<a href="#Set Library Order" title="Sets order in which keywords are
looked from libraries.">Set Library Order</a>
+<a href="#Set Library Search Order" title="Sets the resolution order to
use when a name matches multiple
keywords.">Set Library Search Order</a>
<a href="#Set Log Level" title="Sets the log threshold to the specified
level and returns the old level.">Set Log Level</a>
<a href="#Set Suite Variable" title="Makes a variable available everywhere
within the scope of the current
suite.">Set Suite Variable</a>
<a href="#Set Tags" title="Adds given `tags` for the current test or all
tests in a suite.">Set Tags</a>
@@ -820,71 +820,51 @@
See <a href="#Set Suite Variable" class="name">Set Suite Variable</a> for
more information and examples.</td>
</tr>
<tr>
- <td class="kw"><a name="Set Library Order"></a>Set Library Order</td>
+ <td class="kw"><a name="Set Library Search Order"></a>Set Library Search
Order</td>
<td class="arg">*libraries</td>
- <td class="doc">Sets order in which keywords are looked from
libraries.<br />
+ <td class="doc">Sets the resolution order to use when a name matches
multiple keywords.<br />
<br />
-By setting order in which keywords are serached it is possible to use
libraries providing keywords with same name without using long format
LibraryName.Keyword Name notation. This keyword is usefull in case there is
need to use multiple applications through the same library. By changing
library which is used, it is possible to use same resources instead
dublicating the keywords for all the applications.<br />
+The library search order is used to resolve conflicts when a keyword name
in the test data matches multiple keywords. The first library containing
the keyword is selected and that keyword implementation used. If keyword is
not found from any library, or the library search order is not set,
executing the specified keyword fails.<br />
+<br />
+When this keyword is used, there is no need to use the long <span
class="name">LibraryName.Keyword Name</span> notation. For example,
instead of having<br />
<br />
-Examples:<br />
<table border="1" class="doc">
<tr>
-<td>Import Library</td>
-<td>MyLibrary</td>
-<td>WITH NAME</td>
-<td>application1</td>
-</tr>
-<tr>
-<td>Import Library</td>
-<td>MyLibrary</td>
-<td>WITH NAME</td>
-<td>application2</td>
+<td>MyLibrary.Keyword</td>
+<td>arg</td>
</tr>
<tr>
-<td>Set Default Library</td>
-<td>application1</td>
-<td></td>
+<td>MyLibrary.Another Keyword</td>
<td></td>
</tr>
<tr>
-<td>Comment</td>
-<td>Next step opens application1 using User Keyword</td>
-<td></td>
-<td></td>
-</tr>
-<tr>
-<td>Comment</td>
-<td>Open Application which contains multiple keywords from MyLibrary</td>
-<td></td>
-<td></td>
+<td>MyLibrary.Keyword</td>
+<td>xxx</td>
</tr>
+</table>
+<br />
+you can have<br />
+<br />
+<table border="1" class="doc">
<tr>
-<td>Open Application</td>
-<td></td>
-<td></td>
-<td></td>
+<td>Set Library Search Order</td>
+<td>MyLibrary</td>
</tr>
<tr>
-<td>Set Default Library</td>
-<td>application2</td>
-<td></td>
-<td></td>
+<td>Keyword</td>
+<td>arg</td>
</tr>
<tr>
-<td>Comment</td>
-<td>Now the same keyword is used for opening application2</td>
-<td></td>
+<td>Another Keyword</td>
<td></td>
</tr>
<tr>
-<td>Open Application</td>
-<td></td>
-<td></td>
-<td></td>
+<td>Keyword</td>
+<td>xxx</td>
</tr>
</table>
<br />
-Note: Set Library Order keyword cannot be used inside parallel
keywords.</td>
+The library search order is valid only in the suite where this keyword is
used in. The old order is returned and can be used to reset the search
order later.</td>
</tr>
<tr>
<td class="kw"><a name="Set Log Level"></a>Set Log Level</td>
@@ -1441,7 +1421,7 @@
<p class="footer">
Altogether 70 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-03-24 20:38:21.
+on 2009-03-25 22:52:34.
</p>
</body>
</html>
