Author: pekka.klarck
Date: Sun Apr 12 14:40:42 2009
New Revision: 1785
Modified:
trunk/doc/libraries/BuiltIn.html
trunk/doc/libraries/Collections.html
trunk/doc/libraries/Dialogs.html
trunk/doc/libraries/OperatingSystem.html
trunk/doc/libraries/Screenshot.html
trunk/doc/libraries/String.html
trunk/doc/libraries/Telnet.html
Log:
regen
Modified: trunk/doc/libraries/BuiltIn.html
==============================================================================
--- trunk/doc/libraries/BuiltIn.html (original)
+++ trunk/doc/libraries/BuiltIn.html Sun Apr 12 14:40:42 2009
@@ -84,7 +84,7 @@
<h2 id="introduction">Introduction</h2>
<p class='libdoc'>An always available standard library with often needed
keywords.<br />
<br />
-<span class="name">BuiltIn</span> is Robot Framework's standard library
that provides a set of generic keywords needed often. It is imported
automatically and thus always available. The provided keywords can be
used, for example, for verifications (e.g. <a href="#Should Be Equal"
class="name">Should Be Equal</a>, <a href="#Should Contain"
class="name">Should Contain</a>), conversions (e.g. <a href="#Convert To
Integer" class="name">Convert To Integer</a>) and for various other
purposes (e.g. <a href="#Log" class="name">Log</a>, <a href="#Sleep"
class="name">Sleep</a>, <a href="#Run Keyword If" class="name">Run Keyword
If</a>, <a href="#Set Global Variable" class="name">Set Global
Variable</a>).</p>
+<span class="name">BuiltIn</span> is Robot Framework's standard library
that provides a set of generic keywords needed often. It is imported
automatically and thus always available. The provided keywords can be used,
for example, for verifications (e.g. <a href="#Should Be Equal"
class="name">Should Be Equal</a>, <a href="#Should Contain"
class="name">Should Contain</a>), conversions (e.g. <a href="#Convert To
Integer" class="name">Convert To Integer</a>) and for various other
purposes (e.g. <a href="#Log" class="name">Log</a>, <a href="#Sleep"
class="name">Sleep</a>, <a href="#Run Keyword If" class="name">Run Keyword
If</a>, <a href="#Set Global Variable" class="name">Set Global
Variable</a>).</p>
<h2>Shortcuts</h2>
@@ -151,7 +151,6 @@
<a href="#Should Not Be Equal As Strings" title="Fails if objects are
equal after converting them to
strings.">Should Not Be Equal As Strings</a>
<a href="#Should Not Be True" title="Fails if the given condition is
true.">Should Not Be True</a>
<a href="#Should Not Contain" title="Fails if `item1` contains `item2` one
or more times.">Should Not Contain</a>
-<a href="#Should Not Contain X Times" title="Fails if `item1` contains
`item2` `count`
times.">Should Not Contain X Times</a>
<a href="#Should Not End With" title="Fails if the string `str1` ends with
the string `str2`.">Should Not End With</a>
<a href="#Should Not Match" title="Fails if the given `string` matches the
given `pattern`.">Should Not Match</a>
<a href="#Should Not Match Regexp" title="Fails if `string` matches
`pattern` as a regular
expression.">Should Not Match Regexp</a>
@@ -1355,30 +1354,6 @@
</td>
</tr>
<tr>
- <td class="kw"><a name="Should Not Contain X Times"></a>Should Not
Contain X Times</td>
- <td class="arg">item1, item2, count, msg=None</td>
- <td class="doc">Fails if <span class="name">item1</span> contains <span
class="name">item2</span> <span class="name">count</span> times.<br />
-<br />
-Works with strings, lists and all objects that <a href="#Get Count"
class="name">Get Count</a> works with. The default error message can be
overridden with <span class="name">msg</span> and the actual count is
always logged.<br />
-<br />
-Examples:<br />
-<table border="1" class="doc">
-<tr>
-<td>Should Not Contain X Times</td>
-<td>${output}</td>
-<td>hello</td>
-<td>3</td>
-</tr>
-<tr>
-<td>Should Not Contain X Times</td>
-<td>${some list}</td>
-<td>value</td>
-<td>2</td>
-</tr>
-</table>
-</td>
-</tr>
-<tr>
<td class="kw"><a name="Should Not End With"></a>Should Not End With</td>
<td class="arg">str1, str2, msg=None, values=True</td>
<td class="doc">Fails if the string <span class="name">str1</span> ends
with the string <span class="name">str2</span>.<br />
@@ -1494,9 +1469,9 @@
</tr>
</table>
<p class="footer">
-Altogether 73 keywords.<br />
+Altogether 72 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-04-09 11:48:06.
+on 2009-04-13 00:38:35.
</p>
</body>
</html>
Modified: trunk/doc/libraries/Collections.html
==============================================================================
--- trunk/doc/libraries/Collections.html (original)
+++ trunk/doc/libraries/Collections.html Sun Apr 12 14:40:42 2009
@@ -84,7 +84,7 @@
<h2 id="introduction">Introduction</h2>
<p class='libdoc'>A test library providing keywords for handling lists and
dictionaries.<br />
<br />
-Collections is Robot Framework's standard library that provides a set of
keywords for handling Python lists and dictionaries. This library has
keywords, for example, for modifying and getting values from lists and
dictionaries (e.g. <a href="#Append To List" class="name">Append To
List</a>, <a href="#Get From Dictionary" class="name">Get From
Dictionary</a>) and for verifying their contents (e.g. <a href="#Lists
Should Be Equal" class="name">Lists Should Be Equal</a>, <a
href="#Dictionary Should Contain Value" class="name">Dictionary Should
Contain Value</a>).<br />
+<span class="name">Collections</span> is Robot Framework's standard
library that provides a set of keywords for handling Python lists and
dictionaries. This library has keywords, for example, for modifying and
getting values from lists and dictionaries (e.g. <a href="#Append To List"
class="name">Append To List</a>, <a href="#Get From Dictionary"
class="name">Get From Dictionary</a>) and for verifying their contents
(e.g. <a href="#Lists Should Be Equal" class="name">Lists Should Be
Equal</a>, <a href="#Dictionary Should Contain Value"
class="name">Dictionary Should Contain Value</a>).<br />
<br />
Following keywords from the BuiltIn library can also be used with lists
and dictionaries:<br />
<table border="1" class="doc">
@@ -174,6 +174,7 @@
<a href="#Keep In Dictionary" title="Keeps the given `keys` in the
`dictionary` and removes all other.">Keep In Dictionary</a>
<a href="#List Should Contain Sub List" title="Fails if not all of the
elements in `list2` are found in
`list1`.">List Should Contain Sub List</a>
<a href="#List Should Contain Value" title="Fails if the `value` is not
found from `list`.">List Should Contain Value</a>
+<a href="#List Should Not Contain Duplicates" title="Fails if any element
in the `list` is found from it more than
once.">List Should Not Contain Duplicates</a>
<a href="#List Should Not Contain Value" title="Fails if the `value` is
not found from
`list`.">List Should Not Contain Value</a>
<a href="#Lists Should Be Equal" title="Fails if given lists are
unequal.">Lists Should Be Equal</a>
<a href="#Log Dictionary" title="Logs the size and contents of the
`dictionary` using given `level`.">Log Dictionary</a>
@@ -614,6 +615,15 @@
If <span class="name">msg</span> is not given, the default error
message "[ a | b | c ] does not contain the value 'x'" is shown in case of
a failure. Otherwise, the given <span class="name">msg</span> is used in
case of a failure.</td>
</tr>
<tr>
+ <td class="kw"><a name="List Should Not Contain Duplicates"></a>List
Should Not Contain Duplicates</td>
+ <td class="arg">list, msg=None</td>
+ <td class="doc">Fails if any element in the <span
class="name">list</span> is found from it more than once.<br />
+<br />
+The default error message lists all the elements that were found from the
<span class="name">list</span> multiple times, but it can be overridded by
giving a custom <span class="name">msg</span>. All multiple times found
items and their counts are also logged.<br />
+<br />
+This keyword works with all iterables that can be converted to a list. The
original iterable is never altered.</td>
+</tr>
+<tr>
<td class="kw"><a name="List Should Not Contain Value"></a>List Should
Not Contain Value</td>
<td class="arg">list, value, msg=None</td>
<td class="doc">Fails if the <span class="name">value</span> is not
found from <span class="name">list</span>.<br />
@@ -789,9 +799,9 @@
</tr>
</table>
<p class="footer">
-Altogether 35 keywords.<br />
+Altogether 36 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-04-08 11:47:23.
+on 2009-04-13 00:38:35.
</p>
</body>
</html>
Modified: trunk/doc/libraries/Dialogs.html
==============================================================================
--- trunk/doc/libraries/Dialogs.html (original)
+++ trunk/doc/libraries/Dialogs.html Sun Apr 12 14:40:42 2009
@@ -84,7 +84,7 @@
<h2 id="introduction">Introduction</h2>
<p class='libdoc'>A test library providing dialogs for interacting with
users.<br />
<br />
-Dialogs is a test library that provides means for pausing the test
execution and getting input from users. The dialogs are slightly different
depending on are tests run on Python or Jython but they provide the same
functionality.</p>
+<span class="name">Dialogs</span> is Robot Framework's standard library
that provides means for pausing the test execution and getting input from
users. The dialogs are slightly different depending on are tests run on
Python or Jython but they provide the same functionality.</p>
<h2>Shortcuts</h2>
@@ -124,7 +124,7 @@
<p class="footer">
Altogether 3 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-04-08 11:47:23.
+on 2009-04-13 00:38:35.
</p>
</body>
</html>
Modified: trunk/doc/libraries/OperatingSystem.html
==============================================================================
--- trunk/doc/libraries/OperatingSystem.html (original)
+++ trunk/doc/libraries/OperatingSystem.html Sun Apr 12 14:40:42 2009
@@ -1181,7 +1181,7 @@
<p class="footer">
Altogether 55 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-04-09 13:01:16.
+on 2009-04-13 00:38:35.
</p>
</body>
</html>
Modified: trunk/doc/libraries/Screenshot.html
==============================================================================
--- trunk/doc/libraries/Screenshot.html (original)
+++ trunk/doc/libraries/Screenshot.html Sun Apr 12 14:40:42 2009
@@ -82,9 +82,9 @@
<p><b>Version:</b> trunk 20090408</p>
<h2 id="introduction">Introduction</h2>
-<p class='libdoc'>This library supports taking full-screen screenshots of
the desktop.<br />
+<p class='libdoc'>A test library for taking full-screen screenshots of the
desktop.<br />
<br />
-The library depends on standard Java APIs and thus requires a Jython
runtime environment. The library does not, however, require any specific
operating system. While the library has been tested on Windows and Linux,
any operating system for which the JDK is available, should be
sufficient.</p>
+<span class="name">Screenshot</span> is Robot Framework's standard library
that provides keywords to capture and store screenshots of the whole
desktop. This library is implemented with Java AWT APIs, so it can be used
only when running Robot Framework on Jython.</p>
<h2 id="importing">Importing</h2>
<table class="keywords">
@@ -210,7 +210,7 @@
<p class="footer">
Altogether 4 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-04-08 11:47:23.
+on 2009-04-13 00:38:36.
</p>
</body>
</html>
Modified: trunk/doc/libraries/String.html
==============================================================================
--- trunk/doc/libraries/String.html (original)
+++ trunk/doc/libraries/String.html Sun Apr 12 14:40:42 2009
@@ -82,21 +82,20 @@
<p><b>Version:</b> trunk 20090408</p>
<h2 id="introduction">Introduction</h2>
-<p class='libdoc'>This library contains keywords related to string
manipulation.<br />
+<p class='libdoc'>A test library for string manipulation and
verification.<br />
<br />
-Following keywords from the BuiltIn library can be used with strings:<br />
+<span class="name">String</span> is Robot Framework's standard library for
manipulating strings (e.g. <a href="#Replace String With Regexp"
class="name">Replace String With Regexp</a>, <a href="#Split To Lines"
class="name">Split To Lines</a>) and verifying their contents (e.g. <a
href="#Should Be String" class="name">Should Be String</a>).<br />
<br />
+Following keywords from the BuiltIn library can also be used with
strings:<br />
- <span class="name">Catenate</span><br />
- <span class="name">Get Length</span><br />
-- <span class="name">Grep</span><br />
+- <span class="name">Length Should Be</span><br />
- <span class="name">Should (Not) Match (Regexp)</span><br />
- <span class="name">Should (Not) Be Empty</span><br />
-- <span class="name">Should (Not) Be Equal As Strings</span><br />
+- <span class="name">Should (Not) Be Equal (As Strings)</span><br />
- <span class="name">Should (Not) Contain</span><br />
-- <span class="name">Should (Not) End With</span><br />
- <span class="name">Should (Not) Start With</span><br />
-<br />
-From Collections library, <span class="name">Length Should Be</span> can
be used with strings as well.</p>
+- <span class="name">Should (Not) End With</span></p>
<h2>Shortcuts</h2>
@@ -104,16 +103,16 @@
<a href="#Fetch From Left" title="Fetches the `string` part before the
FIRST occurrence of `to_find`.">Fetch From Left</a>
<a href="#Fetch From Right" title="Fetches the `string` after the LAST
occurence of `to_find`.">Fetch From Right</a>
<a href="#Generate Random String" title="Generates a random string of the
required `length` (8 by
default).">Generate Random String</a>
-<a href="#Get Columns" title="Takes `string`, splits into columns using
delimiter">Get Columns</a>
+<a href="#Get Columns" title="Takes `string`, splits into columns using
delimiter.">Get Columns</a>
<a href="#Get Line" title="From given `string`, extracts line with given
`number`.">Get Line</a>
<a href="#Get Line Count" title="Returns the number of
lines.">Get Line Count</a>
<a href="#Get Substring" title="Returns a substring from `start` index to
`end` index.">Get Substring</a>
<a href="#Replace String" title="Replaces `search_for` in `string` with
`replace_with`.">Replace String</a>
<a href="#Replace String With Regexp" title="Replaces matches with
`pattern` in `string` with
`replace_with`.">Replace String With Regexp</a>
-<a href="#Should Be String" title="Fails if item is not a string (e.g.
list, number)">Should Be String</a>
+<a href="#Should Be String" title="Fails if item is not a string (e.g.
boolean, number)">Should Be String</a>
<a href="#Should Not Be String" title="Fails if item is a
string">Should Not Be String</a>
-<a href="#Split String" title="Return a list of the words in the
`string`,">Split String</a>
-<a href="#Split String From Right" title="Return a list of the words in
the `string`,">Split String From Right</a>
+<a href="#Split String" title="Return a list of the words in the
`string`.">Split String</a>
+<a href="#Split String From Right" title="Return a list of the words in
the `string`, starting from
right.">Split String From Right</a>
<a href="#Split To Lines" title="Converts `string` to list of
lines.">Split To Lines</a>
</div>
@@ -127,27 +126,37 @@
<tr>
<td class="kw"><a name="Fetch From Left"></a>Fetch From Left</td>
<td class="arg">string, to_find</td>
- <td class="doc">Fetches the <span class="name">string</span> part before
the FIRST occurrence of <span class="name">to_find</span>. If <span
class="name">to_find</span> is not found, whole string is returned.</td>
+ <td class="doc">Fetches the <span class="name">string</span> part before
the FIRST occurrence of <span class="name">to_find</span>.<br />
+<br />
+If <span class="name">to_find</span> is not found, whole string is
returned.</td>
</tr>
<tr>
<td class="kw"><a name="Fetch From Right"></a>Fetch From Right</td>
<td class="arg">string, to_find</td>
- <td class="doc">Fetches the <span class="name">string</span> after the
LAST occurence of <span class="name">to_find</span>. If <span
class="name">to_find</span> not found within <span
class="name">string</span>, whole string is returned.</td>
+ <td class="doc">Fetches the <span class="name">string</span> after the
LAST occurence of <span class="name">to_find</span>.<br />
+<br />
+If <span class="name">to_find</span> not found within <span
class="name">string</span>, whole string is returned.</td>
</tr>
<tr>
<td class="kw"><a name="Generate Random String"></a>Generate Random
String</td>
<td class="arg">length=8,
chars=abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789</td>
- <td class="doc">Generates a random string of the required <span
class="name">length</span> (8 by default). Second argument is a set of
characters to draw from, lower and upper case letters, and digits by
default.</td>
+ <td class="doc">Generates a random string of the required <span
class="name">length</span> (8 by default).<br />
+<br />
+Second argument is a set of characters to draw from, lower and upper case
letters, and digits by default.</td>
</tr>
<tr>
<td class="kw"><a name="Get Columns"></a>Get Columns</td>
- <td class="arg">string, column_number, delimiter= </td>
- <td class="doc">Takes <span class="name">string</span>, splits into
columns using delimiter and returns the <span
class="name">column_number</span> column. Column numbering starts from 0.
Default delimiter is single space.</td>
+ <td class="arg">string, column_number, delimiter=None</td>
+ <td class="doc">Takes <span class="name">string</span>, splits into
columns using delimiter.<br />
+<br />
+Returns the columns as list. See <span class="name">split_string</span>
for the description of default delimiter.</td>
</tr>
<tr>
<td class="kw"><a name="Get Line"></a>Get Line</td>
<td class="arg">string, number</td>
- <td class="doc">From given <span class="name">string</span>, extracts
line with given <span class="name">number</span>. '0' is the first
line. '-1' is the last line. Line is returned without the end-of-line
character.<br />
+ <td class="doc">From given <span class="name">string</span>, extracts
line with given <span class="name">number</span>.<br />
+<br />
+'0' is the first line. '-1' is the last line. Line is returned without the
end-of-line character.<br />
<br />
Example:<br />
<table border="1" class="doc">
@@ -168,7 +177,9 @@
<tr>
<td class="kw"><a name="Get Substring"></a>Get Substring</td>
<td class="arg">string, start, end=None</td>
- <td class="doc">Returns a substring from <span class="name">start</span>
index to <span class="name">end</span> index. First item's index is 0. it
is possible to use also negative <span class="name">start</span> and end
indexes which means Example:<br />
+ <td class="doc">Returns a substring from <span class="name">start</span>
index to <span class="name">end</span> index.<br />
+<br />
+First item's index is 0. it is possible to use also negative <span
class="name">start</span> and end indexes which means Example:<br />
<table border="1" class="doc">
<tr>
<td>${first two} =</td>
@@ -222,7 +233,7 @@
<tr>
<td class="kw"><a name="Should Be String"></a>Should Be String</td>
<td class="arg">item, msg=None</td>
- <td class="doc">Fails if item is not a string (e.g. list, number)</td>
+ <td class="doc">Fails if item is not a string (e.g. boolean, number)</td>
</tr>
<tr>
<td class="kw"><a name="Should Not Be String"></a>Should Not Be
String</td>
@@ -232,12 +243,18 @@
<tr>
<td class="kw"><a name="Split String"></a>Split String</td>
<td class="arg">string, separator=None, max_split=-1</td>
- <td class="doc">Return a list of the words in the <span
class="name">string</span>, using <span class="name">split_with</span> as
the delimiter string. If max_split is given, at most <span
class="name">max_split</span> splits are done (thus, the list will have at
most 'max_split+1' elements)</td>
+ <td class="doc">Return a list of the words in the <span
class="name">string</span>.<br />
+<br />
+Uses <span class="name">separator</span> as the delimiter string. If <span
class="name">separator</span> is not specified: runs of consecutive
whitespace are regarded as a single separator, and the result will contain
no empty strings at the start or end if the string has leading or trailing
whitespace.<br />
+<br />
+If max_split is given, at most <span class="name">max_split</span> splits
are done (thus, the list will have at most 'max_split+1' elements)</td>
</tr>
<tr>
<td class="kw"><a name="Split String From Right"></a>Split String From
Right</td>
<td class="arg">string, separator=None, max_split=-1</td>
- <td class="doc">Return a list of the words in the <span
class="name">string</span>, using <span class="name">split_with</span> as
the delimiter string. If max_split is given, at most <span
class="name">max_split</span> splits are done from right. (thus, the list
will have at most 'max_split+1' elements)</td>
+ <td class="doc">Return a list of the words in the <span
class="name">string</span>, starting from right.<br />
+<br />
+Uses <span class="name">split_with</span> as the delimiter string. If
max_split is given, at most <span class="name">max_split</span> splits are
done from right. (thus, the list will have at most 'max_split+1'
elements)</td>
</tr>
<tr>
<td class="kw"><a name="Split To Lines"></a>Split To Lines</td>
@@ -250,15 +267,15 @@
<table border="1" class="doc">
<tr>
<td>@{lines} =</td>
-<td>Get Lines as List</td>
-<td>${multilines}</td>
+<td>Split to lines</td>
+<td>${manylines}</td>
<td></td>
<td></td>
</tr>
<tr>
<td>@{first two lines} =</td>
-<td>Get Lines as List</td>
-<td>${multilines}</td>
+<td>Split to lines</td>
+<td>${manylines}</td>
<td>0</td>
<td>1</td>
</tr>
@@ -269,7 +286,7 @@
<p class="footer">
Altogether 14 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-04-08 11:47:23.
+on 2009-04-13 00:38:36.
</p>
</body>
</html>
Modified: trunk/doc/libraries/Telnet.html
==============================================================================
--- trunk/doc/libraries/Telnet.html (original)
+++ trunk/doc/libraries/Telnet.html Sun Apr 12 14:40:42 2009
@@ -82,11 +82,11 @@
<p><b>Version:</b> trunk 20090408</p>
<h2 id="introduction">Introduction</h2>
-<p class='libdoc'>A test library providing Telnet connections and
communicating with them.<br />
+<p class='libdoc'>A test library providing communication over Telnet
connections.<br />
<br />
-This library supports multiple simultaneous connections, see <a
href="#Open Connection" class="name">Open Connection</a> and <a
href="#Switch Connection" class="name">Switch Connection</a> for
details.<br />
+<span class="name">Telnet</span> is Robot Framework's standard library
that makes it possible to connect to Telnet servers and execute commands on
the opened connections.<br />
<br />
-The responses from the server are expected to be ASCII, all characters
with different encodings are ignored.</p>
+See <a href="#Open Connection" class="name">Open Connection</a> and <a
href="#Switch Connection" class="name">Switch Connection</a> for details on
how to handle multiple simultaneous connections. The responses are expected
to be ASCII encoded and all non-ASCII characters are silently ignored.</p>
<h2 id="importing">Importing</h2>
<table class="keywords">
@@ -569,7 +569,7 @@
<p class="footer">
Altogether 17 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2009-04-08 11:47:23.
+on 2009-04-13 00:38:36.
</p>
</body>
</html>
