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 to give an integrated view. To
add common machine information, the predicate meta_batch/1 can be
called.
legend_table(Legend).
The following report predicates are provided:
- meta_batch(T):
- The predicate creates the table legend.
- dump_meta(F):
- The predicate writes the meta information to the file F. An
already existing file F is silently overwritten.
- 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.
- tests(A): A is the location of the test cases.
legend(B): A is the legend option flag
- 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.