Revision: 2461
Author: pekka.klarck
Date: Wed Feb 17 07:21:22 2010
Log: regen
http://code.google.com/p/robotframework/source/detail?r=2461
Modified:
/trunk/doc/userguide/RobotFrameworkUserGuide.html
=======================================
--- /trunk/doc/userguide/RobotFrameworkUserGuide.html Tue Feb 16 23:54:35
2010
+++ /trunk/doc/userguide/RobotFrameworkUserGuide.html Wed Feb 17 07:21:22
2010
@@ -11041,7 +11041,7 @@
where <span class="code">attributes</span> is a dictionary containing
details of the event. The
following table lists all the available methods in the listener interface
and
the contents of the <span class="code">attributes</span> dictionary, where
applicable. Keys of
-the dictionary are strings. All of these methods have also camelCase
aliases.
+the dictionary are strings. All of these methods have also
<cite>camelCase</cite> aliases.
Thus, for example, <span class="code">startSuite</span> is a synonym to
<span class="code">start_suite</span>.</p>
<table border="1" class="tabular docutils">
<caption>Available methods in the listener interface</caption>
@@ -11059,58 +11059,47 @@
<tbody valign="top">
<tr><td>start_suite</td>
<td>name, attributes</td>
-<td><dl class="first last docutils">
-<dt>Keys in the attributes dictionary:</dt>
-<dd><ul class="first last simple">
+<td><p class="first">Keys in the attributes dictionary:</p>
+<ul class="last simple">
<li>doc: test suite documentation</li>
<li>longname: suite name including parent suites</li>
<li>starttime: execution start time</li>
</ul>
-</dd>
-</dl>
</td>
</tr>
<tr><td>end_suite</td>
<td>name, attributes</td>
-<td><dl class="first last docutils">
-<dt>Keys in the attributes dictionary:</dt>
-<dd><ul class="first last simple">
+<td><p class="first">Keys in the attributes dictionary:</p>
+<ul class="last simple">
<li>doc: test suite documentation</li>
<li>longname: test suite name including parents</li>
<li>starttime: execution start time</li>
<li>endtime: execution end time</li>
<li>elapsetime: execution time in milliseconds
as an integer</li>
-<li>status: either PASS or FAIL</li>
-<li>statistics: suite statistics (number of
-passed and failed tests in the suite)
-as a string</li>
+<li>status: either <span class="code">PASS</span> or <span
class="code">FAIL</span></li>
+<li>statistics: suite statistics (number of passed
+and failed tests in the suite) as a string</li>
<li>message: error message, if the suite setup
or teardown has failed, empty otherwise</li>
</ul>
-</dd>
-</dl>
</td>
</tr>
<tr><td>start_test</td>
<td>name, attributes</td>
-<td><dl class="first last docutils">
-<dt>Keys in the attributes dictionary:</dt>
-<dd><ul class="first last simple">
+<td><p class="first">Keys in the attributes dictionary:</p>
+<ul class="last simple">
<li>doc: test case documentation</li>
<li>longname: test name including parent suites</li>
<li>starttime: execution start time</li>
<li>tags: test case tags as a list of strings</li>
</ul>
-</dd>
-</dl>
</td>
</tr>
<tr><td>end_test</td>
<td>name, attributes</td>
-<td><dl class="first last docutils">
-<dt>Keys in the attributes dictionary:</dt>
-<dd><ul class="first last simple">
+<td><p class="first">Keys in the attributes dictionary:</p>
+<ul class="last simple">
<li>doc: test case documentation</li>
<li>longname: test name including parent suites</li>
<li>starttime: execution start time</li>
@@ -11118,68 +11107,60 @@
<li>elapsetime: execution time in milliseconds
as an integer</li>
<li>tags: test case tags as a list of strings</li>
-<li>status: either PASS or FAIL</li>
+<li>status: either <span class="code">PASS</span> or <span
class="code">FAIL</span></li>
<li>message: contains an error message if the
test has failed and is empty otherwise</li>
</ul>
-</dd>
-</dl>
</td>
</tr>
<tr><td>start_keyword</td>
<td>name, attributes</td>
-<td><dl class="first last docutils">
-<dt>Keys in the attributes dictionary:</dt>
-<dd><ul class="first last simple">
+<td><p class="first">Keys in the attributes dictionary:</p>
+<ul class="last simple">
<li>doc: keyword documentation</li>
<li>starttime: execution start time</li>
<li>args: keyword arguments as a list of strings</li>
</ul>
-</dd>
-</dl>
</td>
</tr>
<tr><td>end_keyword</td>
<td>name, attributes</td>
-<td><dl class="first last docutils">
-<dt>Keys in the attributes dictionary:</dt>
-<dd><ul class="first last simple">
+<td><p class="first">Keys in the attributes dictionary:</p>
+<ul class="last simple">
<li>doc: keyword documentation</li>
<li>starttime: execution start time</li>
<li>endtime: execution end time</li>
<li>elapsetime: execution time in milliseconds
as an integer</li>
-<li>args: keyword arguments as a list of strings</li>
-<li>status: either PASS or FAIL</li>
+<li>args: keyword's arguments as a list of strings</li>
+<li>status: either <span class="code">PASS</span> or <span
class="code">FAIL</span></li>
</ul>
-</dd>
-</dl>
</td>
</tr>
<tr><td>log_message</td>
<td>message</td>
-<td><p class="first">Called when a library keyword creates log
-message. <cite>message</cite> is a dictionary with
+<td><p class="first">Called when an executed keyword writes a log
+message. <span class="code">message</span> is a dictionary with
following keys:</p>
-<blockquote class="last">
<ul class="simple">
<li>message: the content of the message</li>
-<li>level: log level used in logging the message</li>
+<li>level: <a class="reference internal" href="#log-levels">log level</a>
used in logging the message</li>
<li>timestamp: message creation time, format is
-YYYY-MM-DD hh:mm:ss.mil</li>
-<li>level: log level used in logging the message</li>
-<li>html: String TRUE or FALSE denoting whether
-message is HTML or not</li>
+<span class="code">YYYY-MM-DD hh:mm:ss.mil</span></li>
+<li>html: string <span class="code">yes</span> or <span
class="code">no</span> denoting
+whether the message should be interpreted as
+HTML or not</li>
</ul>
-</blockquote>
+<p class="last">New in Robot Framework 2.1.3.</p>
</td>
</tr>
<tr><td>message</td>
<td>message</td>
-<td>Called when framework creates a message. These
-messages are also available in <a class="reference internal"
href="#system-log">syslog</a>.
-'message' is a dictionary with same keys as with
-log_message method.</td>
+<td><p class="first">Called when the framework itself writes a <a
class="reference internal" href="#system-log">syslog</a>
+message. <span class="code">message</span> is a dictionary with
+same keys as with <span class="code">log_message</span> method.</p>
+<p class="last">New in Robot Framework 2.1.3.</p>
+</td>
</tr>
<tr><td>output_file</td>
<td>path</td>
@@ -11225,35 +11206,20 @@
as in the table above. It should be remembered that a listener <em>does
not</em> need
to implement any explicit interface or have all these methods.</p>
<div class="highlight"><pre><span class="kd">public</span> <span
class="kd">interface</span> <span class="nc">RobotListenerInterface</span>
<span class="o">{</span>
-
<span class="kd">public</span> <span class="kd">static</span> <span
class="kd">final</span> <span class="kt">int</span> <span
class="n">ROBOT_LISTENER_API_VERSION</span> <span class="o">=</span> <span
class="mi">2</span><span class="o">;</span>
-
<span class="kt">void</span> <span class="nf">startSuite</span><span
class="o">(</span><span class="n">String</span> <span
class="n">name</span><span class="o">,</span> <span
class="n">java</span><span class="o">.</span><span
class="na">util</span><span class="o">.</span><span class="na">Map</span>
<span class="n">attributes</span><span class="o">);</span>
-
<span class="kt">void</span> <span class="nf">endSuite</span><span
class="o">(</span><span class="n">String</span> <span
class="n">name</span><span class="o">,</span> <span
class="n">java</span><span class="o">.</span><span
class="na">util</span><span class="o">.</span><span class="na">Map</span>
<span class="n">attributes</span><span class="o">);</span>
-
<span class="kt">void</span> <span class="nf">startTest</span><span
class="o">(</span><span class="n">String</span> <span
class="n">name</span><span class="o">,</span> <span
class="n">java</span><span class="o">.</span><span
class="na">util</span><span class="o">.</span><span class="na">Map</span>
<span class="n">attributes</span><span class="o">);</span>
-
<span class="kt">void</span> <span class="nf">endTest</span><span
class="o">(</span><span class="n">String</span> <span
class="n">name</span><span class="o">,</span> <span
class="n">java</span><span class="o">.</span><span
class="na">util</span><span class="o">.</span><span class="na">Map</span>
<span class="n">attributes</span><span class="o">);</span>
-
<span class="kt">void</span> <span class="nf">startKeyword</span><span
class="o">(</span><span class="n">String</span> <span
class="n">name</span><span class="o">,</span> <span
class="n">java</span><span class="o">.</span><span
class="na">util</span><span class="o">.</span><span class="na">Map</span>
<span class="n">attributes</span><span class="o">);</span>
-
<span class="kt">void</span> <span class="nf">endKeyword</span><span
class="o">(</span><span class="n">String</span> <span
class="n">name</span><span class="o">,</span> <span
class="n">java</span><span class="o">.</span><span
class="na">util</span><span class="o">.</span><span class="na">Map</span>
<span class="n">attributes</span><span class="o">);</span>
-
<span class="kt">void</span> <span class="nf">logMessage</span><span
class="o">(</span><span class="n">java</span><span class="o">.</span><span
class="na">util</span><span class="o">.</span><span class="na">Map</span>
<span class="n">message</span><span class="o">);</span>
-
<span class="kt">void</span> <span class="nf">message</span><span
class="o">(</span><span class="n">java</span><span class="o">.</span><span
class="na">util</span><span class="o">.</span><span class="na">Map</span>
<span class="n">message</span><span class="o">);</span>
-
<span class="kt">void</span> <span class="nf">outputFile</span><span
class="o">(</span><span class="n">String</span> <span
class="n">path</span><span class="o">);</span>
-
<span class="kt">void</span> <span class="nf">logFile</span><span
class="o">(</span><span class="n">String</span> <span
class="n">path</span><span class="o">);</span>
-
<span class="kt">void</span> <span class="nf">reportFile</span><span
class="o">(</span><span class="n">String</span> <span
class="n">path</span><span class="o">);</span>
-
<span class="kt">void</span> <span class="nf">summaryFile</span><span
class="o">(</span><span class="n">String</span> <span
class="n">path</span><span class="o">);</span>
-
<span class="kt">void</span> <span class="nf">debugFile</span><span
class="o">(</span><span class="n">String</span> <span
class="n">path</span><span class="o">);</span>
-
<span class="kt">void</span> <span class="nf">close</span><span
class="o">();</span>
<span class="o">}</span>
</pre></div>
@@ -12334,7 +12300,7 @@
<div class="footer">
<hr class="footer" />
<p>Generated by <a class="reference external"
href="http://docutils.sourceforge.net/rst.html";>reStructuredText</a>.
Syntax highlighting by <a class="reference external"
href="http://pygments.org/";>Pygments</a>.</p>
-<p>Generated on: 2010-02-17 07:52 UTC.
+<p>Generated on: 2010-02-17 15:19 UTC.
</p>
</div>
