Author: pekka.klarck
Date: Sun Apr 12 15:20:40 2009
New Revision: 1788
Modified:
trunk/doc/userguide/src/CreatingTestData/UsingTestLibraries.txt
trunk/doc/userguide/src/RobotFrameworkUserGuide.txt
Log:
Added doc for String and Dialogs and updated docs of other standard libs
(issue 283)
Modified: trunk/doc/userguide/src/CreatingTestData/UsingTestLibraries.txt
==============================================================================
--- trunk/doc/userguide/src/CreatingTestData/UsingTestLibraries.txt
(original)
+++ trunk/doc/userguide/src/CreatingTestData/UsingTestLibraries.txt Sun Apr
12 15:20:40 2009
@@ -51,7 +51,6 @@
file. With resource files, those keywords are also available in other
files using them.
-
Using Import Library keyword
''''''''''''''''''''''''''''
@@ -75,7 +74,6 @@
\ KW From Mylibrary \ \ \
=========== ================= ========== ========== ==========
-
Library search path
'''''''''''''''''''
@@ -101,7 +99,6 @@
__ `Adjusting library search path`_
__ `Creating start-up scripts`_
-
Using physical path to library
''''''''''''''''''''''''''''''
@@ -137,6 +134,7 @@
__ `Test library names`_
+
Setting custom name to test library
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -177,7 +175,6 @@
Library ${LIBRARY} WITH NAME MyName
========= =================== ========= =========
-
Possible arguments to the library are placed into cells between the
original library name and the :code:`WITH NAME` text. The following example
illustrates how the same library can be imported several times with
@@ -204,7 +201,6 @@
\ LocalLib.Another Keyword \ \
=========== ======================== =========== ==========
-
Setting a custom name to a test library works both when importing a
library in the Setting table and when using the :name:`Import Library`
keyword.
@@ -216,11 +212,13 @@
libraries are called *standard libraries*. These are the available
standard libraries:
- - `BuiltIn library`_
- - `OperatingSystem library`_
- - `Telnet library`_
- - `Collections library`_
- - `Screenshot library`_
+ - `BuiltIn`_
+ - `OperatingSystem`_
+ - `Telnet`_
+ - `Collections`_
+ - `String`_
+ - `Dialogs`_
+ - `Screenshot`_
The BuiltIn library is special, because it is taken into use
automatically and thus its keywords are always available. Other
@@ -237,80 +235,91 @@
without any external dependencies, and is adequately tested and
documented.
-
BuiltIn library
'''''''''''''''
The BuiltIn library provides a set of generic keywords needed
-often. The provided keywords allow functions for verifications (for
-example, :name:`Should Be Equal`), conversions (for example, :name:`Convert
-To Integer`) and for various other purposes (for example, :name:`Log` and
-:name:`Sleep`).
+often. It is imported automatically and thus always available. The
+provided keywords can be used, for example, for verifications
+(e.g. :name:`Should Be Equal`, :name:`Should Contain`), conversions
+(e.g. :name:`Convert To Integer`) and for various other purposes
+(e.g. :name:`Log`, :name:`Sleep`, :name:`Run Keyword If`, :name:`Set
+Global Variable`).
-The names of the keywords in the BuiltIn library have been renamed for
+The names of the keywords in the BuiltIn library have been renamed in
Robot Framework version 1.8. All the old keywords still work, but the
long names (the names visible in log files) of the keywords that are
deprecated begin with :name:`DeprecatedBuiltIn.` (for example,
-:name:`DeprecatedBuiltIn.Equals`).
+:name:`DeprecatedBuiltIn.Equals`). It is highly recommended to use the
+new names of the keywords as the old versions will be removed
+altogether in the future.
For more information, see the `BuiltIn library documentation`_.
-
OperatingSystem library
'''''''''''''''''''''''
-The OperatingSystem library enables various operating-system-related
-tasks to be performed in the system running Robot Framework. It can,
-among other things, execute commands (for example, :name:`Run`) and
-check whether files exist or not (for example, :name:`File Should
-Exist`). The idea of the library is to wrap all relevant functions
-from the standard Python modules :code:`os`, :code:`os.path` and
-:code:`shutil`, but other related functions can also be added.
+The OperatingSystem library enables various operating system related
+tasks to be performed in the system where Robot Framework is
+running. It can, among other things, execute commands
+(e.g. :name:`Run`), create and remove files and directories
+(e.g. :name:`Create File`, :name:`Remove Directory`), check whether
+files or directories exists or contain something (e.g. :name:`File
+Should Exist`, :name:`Directory Should Be Empty`) and manipulate
+environment variables (e.g. :name:`Set Environment Variable`).
The names of the keywords in the OperatingSystem library have been
-renamed for Robot Framework version 1.8. All the old keywords still
-work, but the long names (names visible in log files) of the keywords
-that are deprecated begin with :name:`DeprecatedOperatingSystem.` (for
-example, :name:`DeprecatedOperatingSystem.Fail Unless File Empty`).
+renamed in Robot Framework 1.8 similarly as the names of the BuiltIn
+keywords.
For more information, see the `OperatingSystem library documentation`_.
-
Telnet library
''''''''''''''
-The Telnet library enables testing over a Telnet connection. It
-has functions for logging into a Telnet server, running commands on
-the server and returning the output. The Telnet library extends
-Python's own :code:`telnetlib` module and it supports several
-simultaneous connections.
+The Telnet library makes it possible to connect to Telnet servers and
+execute commands on the opened connections.
For more information, see the `Telnet library documentation`_.
-
Collections library
'''''''''''''''''''
-The Collections library provides a set of keywords for handling
-Python's standard list and dictionary data structures. For more
-information about lists and dictionaries, see `Python Library
-Reference`_ . The provided keywords allow functions for creating
-dictionaries (:name:`Create Dictionary`), modifying lists and
-dictionaries (for example, :name:`Append To List`), and checking the
-equality of lists and dictionaries (for example, :name:`Dictionaries
-Should Be Equal`).
+The Collections library 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. :name:`Append To List`, :name:`Get From Dictionary`) and for
+verifying their contents (e.g. :name:`Lists Should Be Equal`,
+:name:`Dictionary Should Contain Value`).
For more information, see the `Collections library documentation`_.
-.. _Python Library Reference: http://docs.python.org/lib/lib.html
+String library
+''''''''''''''
+
+The String library enables manipulating strings (e.g. :name:`Replace
+String With Regexp`, :name:`Split To Lines`) and verifying their
+contents (e.g. :name:`Should Be String`). This library is new in Robot
+Framework 2.1.
+
+For more information, see the `String library documentation`_.
+
+Dialogs library
+'''''''''''''''
+
+The Dialogs library 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. This library is new in Robot Framework 2.1.
+For more information, see the `Dialogs library documentation`_.
Screenshot library
''''''''''''''''''
-The Screenshot library provides a way to capture and store screenshots
+The Screenshot library has 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 with Jython.
+so it can be used only when running Robot Framework on Jython.
For more information, see the `Screenshot library documentation`_.
Modified: trunk/doc/userguide/src/RobotFrameworkUserGuide.txt
==============================================================================
--- trunk/doc/userguide/src/RobotFrameworkUserGuide.txt (original)
+++ trunk/doc/userguide/src/RobotFrameworkUserGuide.txt Sun Apr 12 15:20:40
2009
@@ -141,12 +141,19 @@
.. _`With Name syntax`: `Setting custom name to test library`_
.. _BuiltIn keyword: `BuiltIn library`_
.. _BuiltIn keywords: `BuiltIn library`_
-.. _BuiltIn: `Builtin library`_
+.. _BuiltIn: `BuiltIn library`_
+.. _OperatingSystem: `OperatingSystem library`_
+.. _Telnet: `Telnet library`_
.. _Collections: `Collections library`_
+.. _String: `String library`_
+.. _Dialogs: `Dialogs library`_
+.. _Screenshot: `Screenshot library`_
.. _BuiltIn library documentation: ../libraries/BuiltIn.html
.. _OperatingSystem library
documentation: ../libraries/OperatingSystem.html
.. _Telnet library documentation: ../libraries/Telnet.html
.. _Collections library documentation: ../libraries/Collections.html
+.. _String library documentation: ../libraries/String.html
+.. _Dialogs library documentation: ../libraries/Dialogs.html
.. _Screenshot library documentation: ../libraries/Screenshot.html
.. _SeleniumLibrary:
http://code.google.com/p/robotframework-seleniumlibrary
.. _SwingLibrary: http://code.google.com/p/robotframework-swinglibrary
