Revision: 3799
Author: pekka.klarck
Date: Mon Jul 12 05:41:51 2010
Log: cleanup
http://code.google.com/p/robotframework/source/detail?r=3799
Modified:
/trunk/doc/userguide/src/CreatingTestData/TestDataSyntax.txt
=======================================
--- /trunk/doc/userguide/src/CreatingTestData/TestDataSyntax.txt Mon Jul 12
05:34:46 2010
+++ /trunk/doc/userguide/src/CreatingTestData/TestDataSyntax.txt Mon Jul 12
05:41:51 2010
@@ -9,7 +9,6 @@
:depth: 2
:local:
-
Files and directories
~~~~~~~~~~~~~~~~~~~~~
@@ -32,7 +31,6 @@
- `Variable files`_ to provide more flexible ways to create variables
than resource files
-
Supported file formats
~~~~~~~~~~~~~~~~~~~~~~
@@ -48,7 +46,6 @@
Different `test data templates`_ are available for HTML and TSV
formats to make it easier to get started writing tests.
-
HTML format
'''''''''''
@@ -63,8 +60,8 @@
============ ================ ======= =======
Setting Value Value Value
============ ================ ======= =======
- Library OperatingSystem \ \
- \ \ \ \
+ Library OperatingSystem
+ \
============ ================ ======= =======
.. table::
@@ -73,8 +70,8 @@
============ ================ ======= =======
Variable Value Value Value
============ ================ ======= =======
- ${MESSAGE} Hello, world! \ \
- \ \ \ \
+ ${MESSAGE} Hello, world!
+ \
============ ================ ======= =======
.. table::
@@ -83,10 +80,10 @@
============ =================== ============ =============
Test Case Action Argument Argument
============ =================== ============ =============
- My Test [Documentation] Example test \
- \ Log ${MESSAGE} \
- \ My Keyword /tmp \
- \ \ \ \
+ My Test [Documentation] Example test
+ \ Log ${MESSAGE}
+ \ My Keyword /tmp
+ \
Another Test Should Be Equal ${MESSAGE} Hello, world!
============ =================== ============ =============
@@ -96,8 +93,8 @@
============ ====================== ============ ==========
Keyword Action Argument Argument
============ ====================== ============ ==========
- My Keyword [Arguments] ${path} \
- \ Directory Should Exist ${path} \
+ My Keyword [Arguments] ${path}
+ \ Directory Should Exist ${path}
============ ====================== ============ ==========
Editing test data
@@ -124,7 +121,6 @@
If no encoding is specified, Robot Framework uses ISO-8859-1 by default.
-
TSV format
''''''''''
@@ -140,24 +136,24 @@
============ ======================= ============= =============
\*Setting* \*Value* \*Value* \*Value*
- Library OperatingSystem \ \
- \ \ \ \
- \ \ \ \
+ Library OperatingSystem
+ \
+ \
\*Variable* \*Value* \*Value* \*Value*
- ${MESSAGE} Hello, world! \ \
- \ \ \ \
- \ \ \ \
+ ${MESSAGE} Hello, world!
+ \
+ \
\*Test Case* \*Action* \*Argument* \*Argument*
- My Test [Documentation] Example test \
- \ Log ${MESSAGE} \
- \ My Keyword /tmp \
- \ \ \ \
+ My Test [Documentation] Example test
+ \ Log ${MESSAGE}
+ \ My Keyword /tmp
+ \
Another Test Should Be Equal ${MESSAGE} Hello, world!
- \ \ \ \
- \ \ \ \
+ \
+ \
\*Keyword* \*Action* \*Argument* \*Argument*
- My Keyword [Arguments] ${path} \
- \ Directory Should Exist ${path} \
+ My Keyword [Arguments] ${path}
+ \ Directory Should Exist ${path}
============ ======================= ============= =============
Editing test data
@@ -190,7 +186,6 @@
TSV files are always expected to use UTF-8 encoding. Because ASCII is
a subset of UTF-8, plain ASCII is naturally supported too.
-
Plain text format
'''''''''''''''''
@@ -211,7 +206,6 @@
tabs are considered to be a single separator whereas in the TSV format
every
tab would be a separator.
-
Space separated format
``````````````````````
@@ -330,7 +324,6 @@
__ reStructuredText_
__ http://docutils.sourceforge.net/docs/user/rst/quickref.html
-
.. note:: Using reST files with Robot Framework requires the Python
docutils
module to be installed.
@@ -394,21 +387,23 @@
Temporary files when using reST
```````````````````````````````
-Unlike HTML or TSV formats, Robot Framework does not parse reST files
directly.
-Instead, docutils is used to automatically transform reST source files
into temporary HTML
-files that are subsequently read by Robot. These temporary files are
removed
-immediately after being read. This HTML file generation and cleanup is
handled
-internally by Robot Framework, it does not require the user to directly
invoke docutils tools.
+Unlike HTML or TSV formats, Robot Framework does not parse reST files
+directly. Instead, docutils is used to automatically transform reST
+source files into temporary HTML files that are subsequently read by
+Robot. These temporary files are removed immediately after being
+read. This HTML file generation and cleanup is handled internally by
+Robot Framework, it does not require the user to directly invoke
+docutils tools.
Syntax errors in reST source files
``````````````````````````````````
-If you create test data or other portions of a reST file that is not
syntactically
-correct (a malformed table for example), the reST-to-HTML conversion will
not
-take place and no test cases will be read from that file. When this occurs,
-Robot Framework will show the docutils error message in it's console
output showing the
-filename, line number, source context, and type of error.
-
+If you create test data or other portions of a reST file that is not
+syntactically correct (a malformed table for example), the
+reST-to-HTML conversion will not take place and no test cases will be
+read from that file. When this occurs, Robot Framework will show the
+docutils error message in it's console output showing the filename,
+line number, source context, and type of error.
Test data tables
~~~~~~~~~~~~~~~~
@@ -440,7 +435,6 @@
| | | User
Keywords |
+--------------+-------------------------------------------+-------------------+
-
Rules for parsing the data
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -470,7 +464,6 @@
or log with the :name:`Log` or :name:`Comment` keywords available
from the `BuiltIn library`_.
-
Escaping
''''''''
@@ -494,7 +487,6 @@
__ `Handling whitespace`_
__ `Space and empty variables`_
-
Handling whitespace
'''''''''''''''''''
@@ -521,7 +513,6 @@
__ `Space and empty variables`_
-
Dividing test data to several rows
''''''''''''''''''''''''''''''''''
@@ -582,7 +573,6 @@
| | ${var} = | Get X | 1 | 2 | 3 |
4 | 5 | 6 |
+-----------+-----------------+---------------+------+-------+------+------+-----+-----+
-
.. table:: Test data split to several rows
:class: example
@@ -620,7 +610,6 @@
\ ... 6
=========== ================ ============== ========== ==========
-
Splitting test data in reST tables
```````````````````````````````````
