Revision: 991f813f833b
Author: Robot Framework Developers <[email protected]>
Date: Tue Jan 24 04:28:56 2012
Log: tidy: ug cleanup
http://code.google.com/p/robotframework/source/detail?r=991f813f833b
Modified:
/doc/userguide/src/SupportingTools/SupportingTools.txt
=======================================
--- /doc/userguide/src/SupportingTools/SupportingTools.txt Tue Jan 24
04:06:17 2012
+++ /doc/userguide/src/SupportingTools/SupportingTools.txt Tue Jan 24
04:28:56 2012
@@ -1,19 +1,18 @@
-Library documentation tool
---------------------------
+Library documentation tool (:prog:`libdoc`)
+-------------------------------------------
`libdoc.py`_ is tool for generating HTML or XML documentation from
keywords of
a test library or a resource file. It is included in the source
distribution
and also available through
http://code.google.com/p/robotframework/wiki/SupportingTools.
-
-Test data tidying tool
-----------------------
-
-This tool can be used to clean up and change format of Robot Framework test
-data files. By default, the output is written to the standard output
stream,
-but it can be redirected to a file. Alternatively, files can be modified
-in-place using :opt:`--inplace` or :opt:`--recursive` options.
+Test data clean-up tool (:prog:`tidy`)
+--------------------------------------
+
+:prog:`tidy` is a tool for cleaning up and changing the format of Robot
Framework
+test data files. By default, the output is written to the standard output
+stream, but it can also be redirected to a file. Alternatively, files can
be
+modified in-place using :opt:`--inplace` or :opt:`--recursive` options.
Synopsis
~~~~~~~~
@@ -48,26 +47,26 @@
~~~~~~~~~~~~~~~~~~~~~~~~~
Test case files created with HTML editors or written by hand can be
normalized
-using tidy. Tidy always writes consistent headers, consistent order for
+using tidy. :prog:`tidy` always writes consistent headers, consistent
order for
settings, and consistent amount of whitespace between cells and tables.
Examples::
- python -m robot.tidy messed_up_tests.html > cleaned_tests.html
- python -m robot.tidy --inplace tests.txt
-
-Changing test data format
-~~~~~~~~~~~~~~~~~~~~~~~~~
-
-Robot Framework supports test data in HTML, TSV and TXT formats and this
tool
+ python -m robot.tidy messed_up_tests.html > cleaned_tests.html
+ python -m robot.tidy --inplace tests.txt
+
+Changing the test data format
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Robot Framework supports test data in HTML, TSV and TXT formats
and :prog:`tidy`
makes changing between the formats trivial. Input format is always
determined
based on the extension of the input file. Output format can be set using
the :opt:`--format` option.
Examples::
- python -m robot.tidy --format tsv tests_in_html.html > tests_in_tsv.tsv
- python -m robot.tidy --format txt --recursive mytests
+ python -m robot.tidy --format tsv tests_in_html.html > tests_in_tsv.tsv
+ python -m robot.tidy --format txt --recursive mytests
Output encoding
~~~~~~~~~~~~~~~
@@ -75,6 +74,20 @@
All output files are written using UTF-8 encoding. Outputs written to the
console use the current console encoding.
+Alternative execution
+~~~~~~~~~~~~~~~~~~~~~
+
+:prog:`tidy` is used only with Python in the synopsis and examples above,
+but it works also with Jython and IronPython.
+
+In addition to executing :prog:`tidy` as a module (:cli:`python -m
robot.tidy`),
+it is possible to execute it as a script::
+
+ python path/robot/tidy.py [options] inputfile
+
+This is useful if you have done a `manual installation`_ of the framework
+and just have the :path:`robot` directory with the source code somewhere
+in your system.
Test data editing tool (RIDE)
-----------------------------
