Author: laukpe
Date: Sun Nov 23 12:48:29 2008
New Revision: 1067
Modified:
trunk/doc/libraries/BuiltIn.html
trunk/doc/libraries/Collections.html
trunk/doc/libraries/OperatingSystem.html
trunk/doc/libraries/Screenshot.html
trunk/doc/libraries/Telnet.html
trunk/tools/libdoc/doc/libdoc.html
Log:
regenerated
Modified: trunk/doc/libraries/BuiltIn.html
==============================================================================
--- trunk/doc/libraries/BuiltIn.html (original)
+++ trunk/doc/libraries/BuiltIn.html Sun Nov 23 12:48:29 2008
@@ -86,7 +86,7 @@
<br />
These keywords are available automatically without importing any library.
They allow functionality for verifications (e.g. <a href="#Should Be Equal"
class="name">Should Be Equal</a>), conversions (e.g. <a href="#Convert To
Integer" class="name">Convert To Integer</a>) and for various other
purposes (e.g. <a href="#Sleep" class="name">Sleep</a>, <a href="#Run
Keyword If" class="name">Run Keyword If</a>).</p>
-<h2 id="initialization">Initialization</h2>
+<h2 id="importing">Importing</h2>
<p>This test library does not take any arguments.</p>
<h2>Shortcuts</h2>
@@ -1351,7 +1351,7 @@
<p class="footer">
Altogether 68 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2008-11-21 15:03:40.
+on 2008-11-23 22:48:09.
</p>
</body>
</html>
Modified: trunk/doc/libraries/Collections.html
==============================================================================
--- trunk/doc/libraries/Collections.html (original)
+++ trunk/doc/libraries/Collections.html Sun Nov 23 12:48:29 2008
@@ -105,7 +105,7 @@
<hr />
</p>
-<h2 id="initialization">Initialization</h2>
+<h2 id="importing">Importing</h2>
<p>This test library does not take any arguments.</p>
<h2>Shortcuts</h2>
@@ -739,7 +739,7 @@
<p class="footer">
Altogether 35 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2008-11-21 15:03:40.
+on 2008-11-23 22:48:10.
</p>
</body>
</html>
Modified: trunk/doc/libraries/OperatingSystem.html
==============================================================================
--- trunk/doc/libraries/OperatingSystem.html (original)
+++ trunk/doc/libraries/OperatingSystem.html Sun Nov 23 12:48:29 2008
@@ -143,7 +143,7 @@
<br />
Starting from Robot Framework 2.0.2, all keywords expecting paths as
arguments accept a forward slash as a path separator regardless the
operating system. This only works if an argument is only a path, <b>not if
a path is part of an argument</b>, like it often is with <a href="#Run"
class="name">Run</a> and <a href="#Start Process" class="name">Start
Process</a> keywords. In these cases, and with earlier versions, built-in
variable ${/} can be used to keep the test data platform independent.</p>
-<h2 id="initialization">Initialization</h2>
+<h2 id="importing">Importing</h2>
<p>This test library does not take any arguments.</p>
<h2>Shortcuts</h2>
@@ -1193,7 +1193,7 @@
<p class="footer">
Altogether 53 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2008-11-21 15:03:41.
+on 2008-11-23 22:48:10.
</p>
</body>
</html>
Modified: trunk/doc/libraries/Screenshot.html
==============================================================================
--- trunk/doc/libraries/Screenshot.html (original)
+++ trunk/doc/libraries/Screenshot.html Sun Nov 23 12:48:29 2008
@@ -86,7 +86,7 @@
<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>
-<h2 id="initialization">Initialization</h2>
+<h2 id="importing">Importing</h2>
<table class="keywords">
<tr>
<th class="arg">Arguments</th>
@@ -94,9 +94,42 @@
</tr>
<tr>
<td class="arg">default_directory=None, log_file_directory=None</td>
- <td class="doc">The library can be initialized with two arguments: <span
class="name">default_directory</span> and <span
class="name">log_file_directory</span>. If the <span
class="name">default_directory</span> is provided, all the screenshots will
be saved under that directory by default. If the <span
class="name">default_directory</span> is not provided, the system temporary
directory is used as default.<br />
+ <td class="doc">Screenshot library can be imported with optional
arguments.<br />
<br />
-<span class="name">log_file_directory</span> is used to create relative
paths when screenshots are logged. By default, absolute paths are used.</td>
+If the <span class="name">default_directory</span> is provided, all the
screenshots are saved into that directory by default. Otherwise the default
location is the system temporary directory.<br />
+<br />
+<span class="name">log_file_directory</span> is used to create relative
paths when screenshots are logged. By default the paths to images in the
log file are absolute.<br />
+<br />
+Examples (use only one of these):<br />
+<br />
+<table border="1" class="doc">
+<tr>
+<td><b>Setting</b></td>
+<td><b>Value</b></td>
+<td><b>Value</b></td>
+<td><b>Value</b></td>
+</tr>
+<tr>
+<td>Library</td>
+<td>Screenshot</td>
+<td></td>
+<td></td>
+</tr>
+<tr>
+<td>Library</td>
+<td>Screenshot</td>
+<td>${CURDIR}/images</td>
+<td></td>
+</tr>
+<tr>
+<td>Library</td>
+<td>Screenshot</td>
+<td>${OUTPUTDIR}</td>
+<td>${OUTPUTDIR}</td>
+</tr>
+</table>
+<br />
+It is also possible to set these directories using <a href="#Set
Screenshot Directories" class="name">Set Screenshot Directories</a>
keyword.</td>
</tr>
</table>
@@ -171,13 +204,13 @@
<td class="arg">default_directory=None, log_file_directory=None</td>
<td class="doc">Used to set <span class="name">default_directory</span>
and <span class="name">log_file_directory</span>.<br />
<br />
-See the library documentation for details.</td>
+See the <a href="#importing" class="name">library importing</a> for
details.</td>
</tr>
</table>
<p class="footer">
Altogether 4 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2008-11-21 15:07:51.
+on 2008-11-23 22:48:10.
</p>
</body>
</html>
Modified: trunk/doc/libraries/Telnet.html
==============================================================================
--- trunk/doc/libraries/Telnet.html (original)
+++ trunk/doc/libraries/Telnet.html Sun Nov 23 12:48:29 2008
@@ -84,7 +84,7 @@
<h2 id="introduction">Introduction</h2>
<p class='libdoc'>A test library providing Telnet connections and
communicating with them.</p>
-<h2 id="initialization">Initialization</h2>
+<h2 id="importing">Importing</h2>
<table class="keywords">
<tr>
<th class="arg">Arguments</th>
@@ -92,7 +92,9 @@
</tr>
<tr>
<td class="arg">timeout=3.0, newline=CRLF, prompt=None,
prompt_is_regexp=False</td>
- <td class="doc">This library takes the optional arguments <span
class="name">timeout</span>, <span class="name">newline</span>, <span
class="name">prompt</span> and <span class="name">prompt_is_regexp</span>.
These are default values used when a new connection is opened with the
keyword <a href="#Open Connection" class="name">Open Connection</a>, and
they can be overridden. They can also be set after opening the connection
using the <a href="#Set Timeout" class="name">Set Timeout</a>, <a
href="#Set Newline" class="name">Set Newline</a> and <a href="#Set Prompt"
class="name">Set Prompt</a> keywords. See these keywords for more
information.<br />
+ <td class="doc">Telnet library can be imported with optional
arguments.<br />
+<br />
+Initialization parameters are used as default values when new connections
are opened with <a href="#Open Connection" class="name">Open Connection</a>
keyword. They can also be set after opening the connection using the <a
href="#Set Timeout" class="name">Set Timeout</a>, <a href="#Set Newline"
class="name">Set Newline</a> and <a href="#Set Prompt" class="name">Set
Prompt</a> keywords. See these keywords for more information.<br />
<br />
Examples (use only one of these):<br />
<br />
@@ -259,7 +261,7 @@
<br />
The optional <span class="name">alias</span> is a name for the connection,
and it can be used for switching between connections, similarly as the
index. See <a href="#Switch Connection" class="name">Switch Connection</a>
for more details about that.<br />
<br />
-The <span class="name">timeout</span>, <span class="name">newline</span>,
<span class="name">prompt</span> and <span
class="name">prompt_is_regexp</span> arguments get default values when the
library is taken into use, but setting them here overrides those values for
this connection. See <a href="#initialization" class="name">library
initialization</a> for more information.</td>
+The <span class="name">timeout</span>, <span class="name">newline</span>,
<span class="name">prompt</span> and <span
class="name">prompt_is_regexp</span> arguments get default values when the
library is taken into use, but setting them here overrides those values for
this connection. See <a href="#importing" class="name">importing</a> for
more information.</td>
</tr>
<tr>
<td class="kw"><a name="Read"></a>Read</td>
@@ -382,7 +384,7 @@
<td class="arg">timeout</td>
<td class="doc">Sets the timeout used in read operations to the given
value.<br />
<br />
-<span class="name">timeout</span> is given in Robot Framework's time
format (e.g. 1 minute 20 seconds).<br />
+<span class="name">timeout</span> is given in Robot Framework's time
format (e.g. 1 minute 20 seconds) that is explained in the User Guide.<br />
<br />
Read operations that expect some output to appear (<a href="#Read Until"
class="name">Read Until</a>, <a href="#Read Until Regexp" class="name">Read
Until Regexp</a>, <a href="#Read Until Prompt" class="name">Read Until
Prompt</a>) use this timeout and fail if the expected output has not
appeared when this timeout expires.<br />
<br />
@@ -565,7 +567,7 @@
<p class="footer">
Altogether 17 keywords.<br />
Generated by <a
href="http://code.google.com/p/robotframework/wiki/LibraryDocumentationTool";>libdoc.py</a>
-on 2008-11-21 15:03:41.
+on 2008-11-23 22:48:10.
</p>
</body>
</html>
Modified: trunk/tools/libdoc/doc/libdoc.html
==============================================================================
--- trunk/tools/libdoc/doc/libdoc.html (original)
+++ trunk/tools/libdoc/doc/libdoc.html Sun Nov 23 12:48:29 2008
@@ -499,7 +499,7 @@
<li><a class="reference internal" href="#python-libraries"
id="id10">Python libraries</a></li>
<li><a class="reference internal" href="#java-libraries" id="id11">Java
libraries</a></li>
<li><a class="reference internal" href="#dynamic-libraries"
id="id12">Dynamic libraries</a></li>
-<li><a class="reference internal" href="#initialization-section"
id="id13">Initialization section</a></li>
+<li><a class="reference internal" href="#importing-section"
id="id13">Importing section</a></li>
<li><a class="reference internal" href="#resource-files"
id="id14">Resource files</a></li>
<li><a class="reference internal" href="#documentation-formatting"
id="id15">Documentation formatting</a></li>
<li><a class="reference internal" href="#keyword-arguments"
id="id16">Keyword arguments</a></li>
@@ -662,10 +662,10 @@
information about how to create these methods and the dynamic library
API in general.</p>
</div>
-<div class="section" id="initialization-section">
-<h2><a class="toc-backref" href="#id13">Initialization section</a></h2>
-<p>An initialization section is created based on the initialization methods
-of the test library. For a Python library, if it has an <span
class="code">__init__</span> method
+<div class="section" id="importing-section">
+<h2><a class="toc-backref" href="#id13">Importing section</a></h2>
+<p>A separate section about how the library is imported is created based
on its
+initialization methods. For a Python library, if it has an <span
class="code">__init__</span> method
that takes arguments in addition to <span class="code">self</span>, the
documentation of that
method is shown. For a Java library, if it has a constructor that accepts
arguments, all its constructors and their javadocs are shown.</p>
@@ -727,8 +727,8 @@
</pre></div>
<p>Additionally, using <span class="code">`introduction`</span> or <span
class="code">`library introduction`</span>
(case insensitive) generates a link to the library introduction in the
beginneing
-of the generated documentation. Similarly <span
class="code">`initialization`</span>
-or <span class="code">`library initialization`</span> generates a link to
the <a class="reference internal"
href="#initialization-section">initialization section</a>.</p>
+of the generated documentation. Similarly <span
class="code">`importing`</span>
+or <span class="code">`library importing`</span> generates a link to the
<a class="reference internal" href="#importing-section">importing
section</a>.</p>
<p>Internal linking between keywords is used by all <a class="reference
external"
href="http://code.google.com/p/robotframework/wiki/TestLibraries";>standard
libraries</a>, so their documentation (and source) acts as a more
realistic example.</p>
@@ -748,7 +748,7 @@
</div>
<div class="footer">
<hr class="footer" />
-Generated on: 2008-11-21 12:59 UTC.
+Generated on: 2008-11-23 20:37 UTC.
</div>
</body>
