2 new revisions:
Revision: 54dc16161685
Author: Pekka Klärck
Date: Tue Sep 13 13:18:38 2011
Log: Documented that in the plain text format indented cells in for
loops m...
http://code.google.com/p/robotframework/source/detail?r=54dc16161685
Revision: 3c5475581b18
Author: Pekka Klärck
Date: Tue Sep 13 13:39:35 2011
Log: enhanced plain text format documentation: 1) use "*** Name ***"
instea...
http://code.google.com/p/robotframework/source/detail?r=3c5475581b18
==============================================================================
Revision: 54dc16161685
Author: Pekka Klärck
Date: Tue Sep 13 13:18:38 2011
Log: Documented that in the plain text format indented cells in for
loops must be escaped.
Update issue 943
Status: Done
Owner: pekka.klarck
Added a note about this. You can see the change live using the link in the
previous comment once I have updated the generated User Guide. That will
happen soonish.
http://code.google.com/p/robotframework/source/detail?r=54dc16161685
Modified:
/doc/userguide/src/CreatingTestData/AdvancedFeatures.txt
/doc/userguide/src/CreatingTestData/TestDataSyntax.txt
=======================================
--- /doc/userguide/src/CreatingTestData/AdvancedFeatures.txt Fri Aug 26
06:31:46 2011
+++ /doc/userguide/src/CreatingTestData/AdvancedFeatures.txt Tue Sep 13
13:18:38 2011
@@ -283,7 +283,15 @@
second example, loop values are `split into several rows`__ and the
loop is run altogether seven times.
-__ `Dividing test data to several rows`_
+.. tip:: If you use for loops in the `plain text format`_, remember to
+ escape__ the indented cell using a backslash::
+
+ *** Test Case ***
+ Example 1
+ :FOR ${animal} IN cat dog
+ \ Log ${animal}
+ \ Log 2nd keyword
+ Log Outside loop
For loops are most useful and also clearest when they are used with
`list variables`_. This is illustrated by the example below, where
@@ -300,6 +308,9 @@
\ Start Element ${element}
=========== ======== ============= ========== ===========
===========
+__ `Dividing test data to several rows`_
+__ Escaping_
+
Using several loop variables
''''''''''''''''''''''''''''
=======================================
--- /doc/userguide/src/CreatingTestData/TestDataSyntax.txt Mon Jun 27
05:59:54 2011
+++ /doc/userguide/src/CreatingTestData/TestDataSyntax.txt Tue Sep 13
13:18:38 2011
@@ -478,6 +478,8 @@
:code:`\\` to be in the appropriate cell). Another possibility is
using `built-in variable`__ :var:`${EMPTY}`.
+- To escape indented cells in `for loops`_ when using the `plain text
format`_.
+
__ `Handling whitespace`_
__ `Space and empty variables`_
==============================================================================
Revision: 3c5475581b18
Author: Pekka Klärck
Date: Tue Sep 13 13:39:35 2011
Log: enhanced plain text format documentation: 1) use "*** Name ***"
instead of "***Name***" example, 2) doc enhancements, 3) rm 2.1.x references
http://code.google.com/p/robotframework/source/detail?r=3c5475581b18
Modified:
/doc/userguide/src/CreatingTestData/TestDataSyntax.txt
=======================================
--- /doc/userguide/src/CreatingTestData/TestDataSyntax.txt Tue Sep 13
13:18:38 2011
+++ /doc/userguide/src/CreatingTestData/TestDataSyntax.txt Tue Sep 13
13:39:35 2011
@@ -190,21 +190,21 @@
'''''''''''''''''
The plain text format is technically otherwise similar to the `TSV
-format`_ but the separator between cells is different. The TSV
+format`_ but the separator between the cells is different. The TSV
format uses tabs, but in the plain text format you can use either two
-or more spaces or a pipe character surrounded with spaces :code:`( | )`.
In both
-cases the `test data tables`_ must have one or more asterisk before
-its name similarly as with the TSV format, and everything before the
-first table is ignored.
-
-.. Note:: The plain text format is only supported in Robot Framework 2.1.1
- and newer.
-
-Starting from Robot Framework 2.1.2 tabs in plain text files are
automatically
-converted to two spaces. This allows using a single tab as a separator
similarly
-as in the TSV format. Notice, however, that in the plain text format
multiple
-tabs are considered to be a single separator whereas in the TSV format
every
-tab would be a separator.
+or more spaces or a pipe character surrounded with spaces :code:`( | )`.
+
+The `test data tables`_ must have one or more asterisk before their
+names similarly as in the TSV format. Otherwise asterisks and possible
+spaces in the table header are ignored so, for example, :code:`***
+Settings ***` and :code:`*Settings` work the same way. Also similarly
+as in the TSV format, everything before the first table is ignored.
+
+In plain text files tabs are automatically converted to two
+spaces. This allows using a single tab as a separator similarly as in
+the TSV format. Notice, however, that in the plain text format
+multiple tabs are considered to be a single separator whereas in the
+TSV format every tab would be a separator.
Space separated format
``````````````````````
@@ -216,13 +216,13 @@
::
- ***Settings***
+ *** Settings ***
Library OperatingSystem
- ***Variables***
+ *** Variables ***
${MESSAGE} Hello, world!
- ***Test Cases***
+ *** Test Cases ***
My Test [Documentation] Example test
Log ${MESSAGE}
My Keyword /tmp
@@ -230,7 +230,7 @@
Another Test
Should Be Equal ${MESSAGE} Hello, world!
- ***Keywords***
+ *** Keywords ***
My Keyword [Arguments] ${path}
Directory Should Exist ${path}
