File "report"

This module allows batch generation of result pages. Through dump_batch/2 the runner provides the creating of result files. Multiple result files can be loaded into memory by means of the ordinary ensure_load/1 predicate. An integrated viewer is already available through diagnose_online/2. This viewer provides a command line style interface.

legend_table(Legend).
legend_column(Tag, Legend).

Alternatively, to generate a HTML report the predicate report_batch/2 can be invoked. It takes a directory and a list of tags. If the end-user desires, he can also beforehand call diff_batch/2 and produce a further column for the HTML report. Column legends can be provided through legend_column/2 facts.

The following report predicates are provided:

report_batch(D, L, O):
The predicate succeeds in writing HTML summary and results pages for the tag list L into the directory D. The parameter O is the options list. The report generator silently overwrites already existing HTML pages. The following options are accepted:

locale(A): A is the report locale.
title(A): A is the report title.
date(A): A is the report date.
root(A): A is the destination folder.
subtitle(A): A is report sub title.
multi(B): A is the multi flag
tests(A): A is the location of the test cases.

report_begin(D, O):
The predicate succeeds in writing a HTML prologue into the directory D. The parameter O is the options list. The report generator silently overwrites am already existing HTML page.
report_add(D, L, O):
The predicate succeeds in appending a HTML summary entry and writing result pages for the tag list L into the directory D. The parameter O is the options list. The report generator silently overwrites already existing HTML pages.
report_end(D, O):
The predicate succeeds in appending a HTML epilogue into the directory D. The parameter O is the options list. The report generator silently overwrites am already existing HTML page.


Kommentare