<commit_before>Supporting tools
----------------

The available supporting tools for Robot Framework are described in
this appendix.

.. contents::
   :depth: 2 
   :local: 


Internal tools
~~~~~~~~~~~~~~

These tools are distributed with Robot Framework. They are included in
the source distribution and also available through
http://code.google.com/p/robotframework/wiki/SupportingTools.


Library documentation tool
''''''''''''''''''''''''''

`libdoc.py`__ is tool for generating HTML or XML documentation from keywords of
a test library or a resource file.

__ ../../tools/libdoc/doc/libdoc.html


Historical reporting tool
'''''''''''''''''''''''''

`risto.py`__ is a tool for generating graphs about historical statistics
of test executions.

__ ../../tools/ristopy/doc/ristopy.html


Test data tidying tool
''''''''''''''''''''''

`robotidy.py`__ is a tool for cleaning Robot Framework test data, changing test 
data format between HTML and TSV and fixing inline comments to format supported
by Robot IDE.

__ ../../tools/robotidy/doc/robotidy.html


Test result diffing tool
''''''''''''''''''''''''

`robotdiff.py`__ is a tool for generating diff reports from Robot
Framework output files.

__ ../../tools/robotdiff/doc/robotdiff.html


Execution time reporting tool
'''''''''''''''''''''''''''''

`times2csv.py`__ is a tool for generating start, end and elapsed
time information about suites, tests and keywords in CSV format.

__ ../../tools/times2csv/doc/times2csv.html


File viewing tool
'''''''''''''''''

`fileviewer.py`__ is a graphical tool implementing UNIX :prog:`tail` -like 
functionality. It is especially designed to view `debug files`__.

__ ../../tools/fileviewer/doc/fileviewer.html
__ `Debug file`_


One click installer
'''''''''''''''''''

`One click installer`__ is an `AutoIT`__ script that installs Robot
Framework and its dependencies.

__ ../../tools/oneclickinstaller/doc/oneclickinstaller.html
__ http://www.autoitscript.com/autoit3/


Test status checker tool
''''''''''''''''''''''''

`statuschecker.py`__ is a tool for verifying that test case statuses
and messages and also keyword log messages are as expected.

__ ../../tools/statuschecker/doc/statuschecker.html


External tools
~~~~~~~~~~~~~~

These tools are all available as separate external projects.


Test data editing tool (Robot IDE)
''''''''''''''''''''''''''''''''''

Robot IDE is a standalone tool for editing test data. It helps in
creating, editing and maintaining of Robot Framework test data.
The project pages are at http://code.google.com/p/robotframework-ride.


Manual test execution tool (mabot)
''''''''''''''''''''''''''''''''''

:prog:`mabot` is a standalone tool for reporting manual test execution
results.  It enables storing and reporting manual test cases along
with automated Robot Framework test cases.

More information will be added as soon as :prog:`mabot` project is
made publicly available.


Tools for creating Java test libraries
''''''''''''''''''''''''''''''''''''''

:prog:`JavaTools` is an external collection of tools that simplify
creation of larger Java test libraries by offering several dynamic
ways of resolving available keywords at runtime. For more information,
see http://code.google.com/p/robotframework-javatools/.


<commit_msg>Added test doc to Supporting Tools<commit_after>Supporting tools
----------------

The available supporting tools for Robot Framework are described in
this appendix.

.. contents::
   :depth: 2 
   :local: 


Internal tools
~~~~~~~~~~~~~~

These tools are distributed with Robot Framework. They are included in
the source distribution and also available through
http://code.google.com/p/robotframework/wiki/SupportingTools.


Library documentation tool
''''''''''''''''''''''''''

`libdoc.py`__ is tool for generating HTML or XML documentation from keywords of
a test library or a resource file.

__ ../../tools/libdoc/doc/libdoc.html


Testdata documentation tool
'''''''''''''''''''''''''''

`testdoc.py`__ is tool for generating high level documentation of a given test
suite, including the names of suites and tests as well as toplevel keywords.

__ ../../tools/libdoc/doc/testdoc.html


Historical reporting tool
'''''''''''''''''''''''''

`risto.py`__ is a tool for generating graphs about historical statistics
of test executions.

__ ../../tools/ristopy/doc/ristopy.html


Test data tidying tool
''''''''''''''''''''''

`robotidy.py`__ is a tool for cleaning Robot Framework test data, changing test 
data format between HTML and TSV and fixing inline comments to format supported
by Robot IDE.

__ ../../tools/robotidy/doc/robotidy.html


Test result diffing tool
''''''''''''''''''''''''

`robotdiff.py`__ is a tool for generating diff reports from Robot
Framework output files.

__ ../../tools/robotdiff/doc/robotdiff.html


Execution time reporting tool
'''''''''''''''''''''''''''''

`times2csv.py`__ is a tool for generating start, end and elapsed
time information about suites, tests and keywords in CSV format.

__ ../../tools/times2csv/doc/times2csv.html


File viewing tool
'''''''''''''''''

`fileviewer.py`__ is a graphical tool implementing UNIX :prog:`tail` -like 
functionality. It is especially designed to view `debug files`__.

__ ../../tools/fileviewer/doc/fileviewer.html
__ `Debug file`_


One click installer
'''''''''''''''''''

`One click installer`__ is an `AutoIT`__ script that installs Robot
Framework and its dependencies.

__ ../../tools/oneclickinstaller/doc/oneclickinstaller.html
__ http://www.autoitscript.com/autoit3/


Test status checker tool
''''''''''''''''''''''''

`statuschecker.py`__ is a tool for verifying that test case statuses
and messages and also keyword log messages are as expected.

__ ../../tools/statuschecker/doc/statuschecker.html


External tools
~~~~~~~~~~~~~~

These tools are all available as separate external projects.


Test data editing tool (Robot IDE)
''''''''''''''''''''''''''''''''''

Robot IDE is a standalone tool for editing test data. It helps in
creating, editing and maintaining of Robot Framework test data.
The project pages are at http://code.google.com/p/robotframework-ride.


Manual test execution tool (mabot)
''''''''''''''''''''''''''''''''''

:prog:`mabot` is a standalone tool for reporting manual test execution
results.  It enables storing and reporting manual test cases along
with automated Robot Framework test cases.

More information will be added as soon as :prog:`mabot` project is
made publicly available.


Tools for creating Java test libraries
''''''''''''''''''''''''''''''''''''''

:prog:`JavaTools` is an external collection of tools that simplify
creation of larger Java test libraries by offering several dynamic
ways of resolving available keywords at runtime. For more information,
see http://code.google.com/p/robotframework-javatools/.



{'fraction_non_alphanumeric': 0.1630084869768803, 'fraction_numerical': 0.0014632718759145448, 'mean_word_length': 4.507655116841257, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3513806', 'n_tokens_mistral': 2073, 'n_tokens_neox': 1959, 'n_words': 734}