NAME
    TAP::Formatter::HTML - TAP Test Harness output delegate for html output

SYNOPSIS
     use TAP::Harness;

     my @tests = glob( 't/*.t' );
     my $harness = TAP::Harness->new({ formatter_class => 'TAP::Formatter::HTML',
                                       merge => 1 });
     $harness->runtests( @tests );
     # prints HTML to STDOUT by default

     # or if you don't want STDERR merged in:
     my $harness = TAP::Harness->new({ formatter_class => 'TAP::Formatter::HTML' });

     # to use a custom formatter:
     my $fmt = TAP::Formatter::HTML->new;
     $fmt->css_uris([])->inline_css( $my_css )
         ->js_uris(['http://mysite.com/jquery.js', 'http://mysite.com/custom.js'])
         ->inline_js( '$(div.summary).hide()' );

     my $harness = TAP::Harness->new({ formatter => $fmt, merge => 1 });

     # you can use your own customized templates too:
     $fmt->template('custom.tt2')
         ->template_processor( Template->new )
         ->force_inline_css(0);

DESCRIPTION
    This provides html output formatting for TAP::Harness.

    Documentation is rather sparse at the moment.

METHODS
  CONSTRUCTOR
   new( \%args )
  ACCESSORS
    All chaining accessors:

   verbosity( [ $v ] )
    Verbosity level, as defined in "new" in TAP::Harness:

         1   verbose        Print individual test results (and more) to STDOUT.
         0   normal
        -1   quiet          Suppress some test output (eg: test failures).
        -2   really quiet   Suppress everything but the HTML report.
        -3   silent         Suppress all output, including the HTML report.

    Note that the report is also available via "html".

   stdout( [ \*FH ] )
    A filehandle for catching standard output. Defaults to "STDOUT".

   escape_output( [ $boolean ] )
    If set, all output to "stdout" is escaped. This is probably only useful
    if you're testing the formatter. Defaults to 0.

   html( [ \$html ] )
    This is a reference to the scalar containing the html generated on the
    last test run. Useful if you have "silent" on.

   tests( [ \@test_files ] )
    A list of test files we're running, set by TAP::Parser.

   session_class( [] )
    Class to use for TAP::Parser test sessions. You probably won't need to
    use this unless you're hacking or sub-classing the formatter. Defaults
    to TAP::Formatter::HTML::Session.

   sessions( [ \@sessions ] )
    Test sessions added by TAP::Parser. You probably won't need to use this
    unless you're hacking or sub-classing the formatter.

   template_processor( [ $processor ] )
    The template processor to use. Defaults to a TT2 Template processor with
    the following config:

      COMPILE_DIR  => catdir( tempdir(), 'TAP-Formatter-HTML' ),
      COMPILE_EXT  => '.ttc',
      INCLUDE_PATH => join(':', @INC),

   template( [ $file_name ] )
    The template file to load. Defaults to
    "TAP/Formatter/HTML/default_report.tt2".

   css_uris( [ \@uris ] )
    A list of URIs (or strings) to include as external stylesheets in
    <style> tags in the head of the document. Defaults to:

      ['file:TAP/Formatter/HTML/default_report.css'];

   js_uris( [ \@uris ] )
    A list of URIs (or strings) to include as external stylesheets in
    <style> tags in the head of the document. Defaults to:

      ['file:TAP/Formatter/HTML/jquery-1.2.3.pack.js'];

   inline_css( [] )
    If set, the formatter will include the CSS code in a <style> tag in the
    head of the document.

   inline_js( [ $javascript ] )
    If set, the formatter will include the JavaScript code in a <script> tag
    in the head of the document.

   abs_file_paths( [ $ boolean ] )
    If set, the formatter will attempt to convert any relative *file* JS &
    css URI's listed in "css_uris" & "js_uris" to absolute paths. This is
    handy if you'll be sending moving the HTML output around on your
    harddisk, (but not so handy if you move it to another machine - see
    "force_inline_css"). Defaults to *1*.

   force_inline_css( [ $boolean ] )
    If set, the formatter will attempt to slurp in any *file* css URI's
    listed in "css_uris", and append them to "inline_css". This is handy if
    you'll be sending the output around - that way you don't have to send a
    CSS file too. Defaults to *1*.

  $html = $fmt->summary( $aggregator )
    "summary" produces a summary report after all tests are run. $aggregator
    should be a TAP::Parser::Aggregator.

    This calls:

      $fmt->template_processor->process( $params )

    Where $params is a data structure containing:

      report      => %test_report
      js_uris     => @js_uris
      css_uris    => @js_uris
      incline_js  => $inline_js
      inline_css  => $inline_css
      formatter   => %formatter_info

    The "report" is the most complicated data structure, and will sooner or
    later be documented in "CUSTOMIZING".

CUSTOMIZING
    This section is not yet written. Please look through the code if you
    want to customize the templates, or sub-class.

BUGS
    Please use http://rt.cpan.org to report any issues.

AUTHOR
    Steve Purkis <spurkis@cpan.org>

COPYRIGHT
    Copyright (c) 2008 Steve Purkis <spurkis@cpan.org>, S Purkis Consulting
    Ltd. All rights reserved.

    This module is released under the same terms as Perl itself.

SEE ALSO
    Test::TAP::HTMLMatrix - the inspiration for this module. Many good ideas
    were borrowed from it.

    TAP::Formatter::Console - the default TAP formatter used by TAP::Harness

