2 new revisions:

Revision: ab5614f89887
Author:   Pekka Klärck
Date:     Wed Feb 22 02:53:58 2012
Log: UG: Small text and layout enhancements to automatic variables table
http://code.google.com/p/robotframework/source/detail?r=ab5614f89887

Revision: afaf09ac86af
Author:   Pekka Klärck
Date:     Wed Feb 22 02:55:04 2012
Log:      UG: Documented ${KEYWORD STATUS} and ${KEYWORD MESSAGE}...
http://code.google.com/p/robotframework/source/detail?r=afaf09ac86af

==============================================================================
Revision: ab5614f89887
Author:   Pekka Klärck
Date:     Wed Feb 22 02:53:58 2012
Log: UG: Small text and layout enhancements to automatic variables table
http://code.google.com/p/robotframework/source/detail?r=ab5614f89887

Modified:
 /doc/userguide/RobotFrameworkUserGuide.html
 /doc/userguide/src/CreatingTestData/Variables.txt

=======================================
--- /doc/userguide/RobotFrameworkUserGuide.html Tue Feb 21 15:22:00 2012
+++ /doc/userguide/RobotFrameworkUserGuide.html Wed Feb 22 02:53:58 2012
@@ -5612,9 +5612,9 @@
 <table border="1" class="tabular docutils">
 <caption>Available automatic variables</caption>
 <colgroup>
-<col width="24%" />
-<col width="59%" />
-<col width="17%" />
+<col width="26%" />
+<col width="61%" />
+<col width="13%" />
 </colgroup>
 <thead valign="bottom">
 <tr><th class="head">Variable</th>
@@ -5635,11 +5635,13 @@
 <tr><td>${TEST STATUS}</td>
 <td>The status of the current test case, either PASS or
 FAIL.</td>
-<td>Test teardown</td>
+<td><a class="reference internal" href="#test-setup-and-teardown">Test
+teardown</a></td>
 </tr>
 <tr><td>${TEST MESSAGE}</td>
-<td>The possible error message of the current test case.</td>
-<td>Test teardown</td>
+<td>The message of the current test case.</td>
+<td><a class="reference internal" href="#test-setup-and-teardown">Test
+teardown</a></td>
 </tr>
 <tr><td>${PREV TEST NAME}</td>
 <td>The name of the previous test case, or an empty string
@@ -5648,7 +5650,7 @@
 </tr>
 <tr><td>${PREV TEST STATUS}</td>
 <td>The status of the previous test case: either PASS,
-FAIL or an empty string when no tests have been
+FAIL, or an empty string when no tests have been
 executed.</td>
 <td>Everywhere</td>
 </tr>
@@ -5666,14 +5668,28 @@
 <td>Everywhere</td>
 </tr>
 <tr><td>${SUITE STATUS}</td>
-<td>The status of the current test case, either PASS or
+<td>The status of the current test suite, either PASS or
 FAIL.</td>
-<td>Suite teardown</td>
+<td><a class="reference internal" href="#suite-setup-and-teardown">Suite
+teardown</a></td>
 </tr>
 <tr><td>${SUITE MESSAGE}</td>
 <td>The full message of the current test suite, including
 statistics.</td>
-<td>Suite teardown</td>
+<td><a class="reference internal" href="#suite-setup-and-teardown">Suite
+teardown</a></td>
+</tr>
+<tr><td>${KEYWORD STATUS}</td>
+<td>The status of the current keyword, either PASS or
+FAIL. New in Robot Framework 2.7</td>
+<td><a class="reference internal" href="#keyword-teardown">Keyword
+teardown</a></td>
+</tr>
+<tr><td>${KEYWORD MESSAGE}</td>
+<td>The possible error message of the current keyword.
+New in Robot Framework 2.7</td>
+<td><a class="reference internal" href="#keyword-teardown">Keyword
+teardown</a></td>
 </tr>
 <tr><td>${OUTPUT FILE}</td>
<td>An absolute path to the <a class="reference internal" href="#output-file">output file</a>.</td>
@@ -7760,9 +7776,9 @@
 </ul>
 </blockquote>
<p>Regardless the implementation language, the framework will create an instance -of the class using no arguments and variables will be get from the instance. +of the class using no arguments and variables will be gotten from the instance.
 Similarly as with modules, variables can be defined as attributes directly
-in the instance or got from a special <span class="code">get_variables</span> +in the instance or gotten from a special <span class="code">get_variables</span>
 (or <span class="code">getVariables</span>) method.</p>
<p>When variables are defined directly in an instance, all attributes containing callable values are ignored to avoid creating variables from possible methods
@@ -7793,7 +7809,7 @@
     <span class="o">}</span>
 <span class="o">}</span>
 </pre></div>
-<p>The second examples utilize dynamic approach for getting variables. Both of +<p>The second examples utilizes dynamic approach for getting variables. Both of them create only one variable <span class="var">${DYNAMIC VARIABLE}</span>.</p> <div class="highlight"><pre><span class="k">class</span> <span class="nc">DynamicPythonExample</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>

@@ -15058,7 +15074,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: 2012-02-21 23:21 UTC.
+<p>Generated on: 2012-02-22 10:51 UTC.
 </p>

 </div>
=======================================
--- /doc/userguide/src/CreatingTestData/Variables.txt Tue Jan 31 06:49:51 2012 +++ /doc/userguide/src/CreatingTestData/Variables.txt Wed Feb 22 02:53:58 2012
@@ -688,52 +688,53 @@
 .. table:: Available automatic variables
    :class: tabular

- +-----------------------+-------------------------------------------------------+----------------+ - | Variable | Explanation | Available | - +=======================+=======================================================+================+ - | ${TEST NAME} | The name of the current test case. | Test case | - +-----------------------+-------------------------------------------------------+----------------+ - | @{TEST TAGS} | Contains the tags of the current test case in | Test case | - | | alphabetical order. | | - +-----------------------+-------------------------------------------------------+----------------+ - | ${TEST STATUS} | The status of the current test case, either PASS or | Test teardown | - | | FAIL. | | - +-----------------------+-------------------------------------------------------+----------------+ - | ${TEST MESSAGE} | The possible error message of the current test case. | Test teardown | - +-----------------------+-------------------------------------------------------+----------------+ - | ${PREV TEST NAME} | The name of the previous test case, or an empty string| Everywhere | - | | if no tests have been executed yet. | | - +-----------------------+-------------------------------------------------------+----------------+ - | ${PREV TEST STATUS} | The status of the previous test case: either PASS, | Everywhere | - | | FAIL or an empty string when no tests have been | | - | | executed. | | - +-----------------------+-------------------------------------------------------+----------------+ - | ${PREV TEST MESSAGE} | The possible error message of the previous test case. | Everywhere | - +-----------------------+-------------------------------------------------------+----------------+ - | ${SUITE NAME} | The full name of the current test suite. | Everywhere | - +-----------------------+-------------------------------------------------------+----------------+ - | ${SUITE SOURCE} | An absolute path to the suite file or directory. New | Everywhere | - | | in Robot Framework 2.5. | | - +-----------------------+-------------------------------------------------------+----------------+ - | ${SUITE STATUS} | The status of the current test case, either PASS or | Suite teardown | - | | FAIL. | | - +-----------------------+-------------------------------------------------------+----------------+ - | ${SUITE MESSAGE} | The full message of the current test suite, including | Suite teardown | - | | statistics. | | - +-----------------------+-------------------------------------------------------+----------------+ - | ${OUTPUT FILE} | An absolute path to the `output file`_. | Everywhere | - +-----------------------+-------------------------------------------------------+----------------+ - | ${LOG FILE} | An absolute path to the `log file`_ or string NONE | Everywhere | - | | when no log file is created. | | - +-----------------------+-------------------------------------------------------+----------------+ - | ${REPORT FILE} | An absolute path to the `report file`_ or string NONE | Everywhere | - | | when no report is created. | | - +-----------------------+-------------------------------------------------------+----------------+ - | ${DEBUG FILE} | An absolute path to the `debug file`_ or string NONE | Everywhere | - | | when no debug file is created. | | - +-----------------------+-------------------------------------------------------+----------------+ - | ${OUTPUT DIR} | An absolute path to the `output directory`_. | Everywhere | - +-----------------------+-------------------------------------------------------+----------------+ + +-----------------------+-------------------------------------------------------+------------+ + | Variable | Explanation | Available | + +=======================+=======================================================+============+ + | ${TEST NAME} | The name of the current test case. | Test case | + +-----------------------+-------------------------------------------------------+------------+ + | @{TEST TAGS} | Contains the tags of the current test case in | Test case | + | | alphabetical order. | | + +-----------------------+-------------------------------------------------------+------------+ + | ${TEST STATUS} | The status of the current test case, either PASS or | `Test | + | | FAIL. | teardown`_ | + +-----------------------+-------------------------------------------------------+------------+ + | ${TEST MESSAGE} | The message of the current test case. | `Test | + | | | teardown`_ | + +-----------------------+-------------------------------------------------------+------------+ + | ${PREV TEST NAME} | The name of the previous test case, or an empty string| Everywhere | + | | if no tests have been executed yet. | | + +-----------------------+-------------------------------------------------------+------------+ + | ${PREV TEST STATUS} | The status of the previous test case: either PASS, | Everywhere | + | | FAIL, or an empty string when no tests have been | | + | | executed. | | + +-----------------------+-------------------------------------------------------+------------+ + | ${PREV TEST MESSAGE} | The possible error message of the previous test case. | Everywhere | + +-----------------------+-------------------------------------------------------+------------+ + | ${SUITE NAME} | The full name of the current test suite. | Everywhere | + +-----------------------+-------------------------------------------------------+------------+ + | ${SUITE SOURCE} | An absolute path to the suite file or directory. New | Everywhere | + | | in Robot Framework 2.5. | | + +-----------------------+-------------------------------------------------------+------------+ + | ${SUITE STATUS} | The status of the current test suite, either PASS or | `Suite | + | | FAIL. | teardown`_ | + +-----------------------+-------------------------------------------------------+------------+ + | ${SUITE MESSAGE} | The full message of the current test suite, including | `Suite | + | | statistics. | teardown`_ | + +-----------------------+-------------------------------------------------------+------------+ + | ${OUTPUT FILE} | An absolute path to the `output file`_. | Everywhere | + +-----------------------+-------------------------------------------------------+------------+ + | ${LOG FILE} | An absolute path to the `log file`_ or string NONE | Everywhere | + | | when no log file is created. | | + +-----------------------+-------------------------------------------------------+------------+ + | ${REPORT FILE} | An absolute path to the `report file`_ or string NONE | Everywhere | + | | when no report is created. | | + +-----------------------+-------------------------------------------------------+------------+ + | ${DEBUG FILE} | An absolute path to the `debug file`_ or string NONE | Everywhere | + | | when no debug file is created. | | + +-----------------------+-------------------------------------------------------+------------+ + | ${OUTPUT DIR} | An absolute path to the `output directory`_. | Everywhere | + +-----------------------+-------------------------------------------------------+------------+

 Variable priorities and scopes
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

==============================================================================
Revision: afaf09ac86af
Author:   Pekka Klärck
Date:     Wed Feb 22 02:55:04 2012
Log:      UG: Documented ${KEYWORD STATUS} and ${KEYWORD MESSAGE}

Update issue 1040
Status: Review
UG updated. Code/test/doc review needed and then this issue is done.
http://code.google.com/p/robotframework/source/detail?r=afaf09ac86af

Modified:
 /doc/userguide/src/CreatingTestData/Variables.txt

=======================================
--- /doc/userguide/src/CreatingTestData/Variables.txt Wed Feb 22 02:53:58 2012 +++ /doc/userguide/src/CreatingTestData/Variables.txt Wed Feb 22 02:55:04 2012
@@ -721,6 +721,12 @@
+-----------------------+-------------------------------------------------------+------------+ | ${SUITE MESSAGE} | The full message of the current test suite, including | `Suite | | | statistics. | teardown`_ | + +-----------------------+-------------------------------------------------------+------------+ + | ${KEYWORD STATUS} | The status of the current keyword, either PASS or | `Keyword | + | | FAIL. New in Robot Framework 2.7 | teardown`_ | + +-----------------------+-------------------------------------------------------+------------+ + | ${KEYWORD MESSAGE} | The possible error message of the current keyword. | `Keyword | + | | New in Robot Framework 2.7 | teardown`_ | +-----------------------+-------------------------------------------------------+------------+ | ${OUTPUT FILE} | An absolute path to the `output file`_. | Everywhere | +-----------------------+-------------------------------------------------------+------------+

Reply via email to