Creating reports
----------------







Presentation
************

A report will present some information extracted from the database of execution
results. A report may be plain text, html or image files, and is usually written
on the file system or sent by email. The following components define a report:

- a **reporter**, responsible to create the content from tests data, as a report
  object

- a **formatter**, used by some reporters to convert the report object to a
  particular format (usually reports generating images don't use a formatter)

- a **transport**, used to get the report on the right place (on the file
  system, in your mailbox...)

Some **decorators** may also be used to add some information to the tests data,
such as checkins log messages extracted from the repository or some precomputed
data. Unlike the other report's components, decorators are defined globally, not
for each report.

.. include:: reports_configuration.txt
.. include:: decorators.txt
.. include:: reporters.txt
.. include:: formatters.txt
.. include:: transports.txt
