Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Converts a plain text interview transcript into html
Perl
branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
lib/Text/Format
t
Changes
Makefile.PL
README

README

NAME
    Text::Format::Interview - Take a text interview transcript and format to
    html.

VERSION
    Version 0.01

SYNOPSIS
     use Text::Format::Interview;

     my $txt = Text::Format::Interview->new();
     my $html = $txt->process($string);

    Converts text of the form:

      # Interview between Fred Flintstone and Barney Rubble, 3rd April, 2000 BC

      Fred: [00:00:00]
      So, Barney, when did you decide to become a Flintstone?

      Barney: [00:00:10]
      Well Fred, I'm not actually a Flintstone, my surname is Rubble and I live in Bedrock.

    Into HTML, something like:

      # Interview between Fred Flintstone and Barney Rubble, 3rd April, 2000 BC

      <h2>Fred: [00:00:00]</h2>
      <p>So, Barney, when did you decide to become a Flintstone?</p>

    This is intended as a pre-processor, so the header is using markdown
    here, but could equally be html.

    Alternatively if you specify a comma separated list of "interviewers"
    and "interviewees" at the top of the file to be processed, you'll get
    some css classes as well:

      # Interview between Fred Flintstone and Barney Rubble, 3rd April, 2000 BC
      interviewer: fred,wilma
      interviewee: barney,betty

      Fred: [00:00:00]
      So what's it like to be a flintstone?

      Barney: [00:00:05]
      I'm not a Flintstone, I'm a Rubble.  What do you think Betty?

      Betty:  [00:00:10]
      Yes Fred, you're confused.

      Wilma:  [00:00:15]
      I'm so terribly embarrassed by my husband.

    Which ought to render to:

      # Interview between Fred Flintstone and Barney Rubble, 3rd April, 2000 BC

      <p>interviewer: fred, wilma <br>
      interviewee: barney, betty <br></p>

      <h2 class="interviewer">Fred: [00:00:00]</h2>
      <p>So what's it like to be a flintstone?</p>

      <h2 class="interviewee">Barney: [00:00:05]</p>
      <p>I'm not a Flintstone, I'm a Rubble.  What do you think Betty?</p>

    This gives us the ability to put pretty colours in the interview
    transcript with CSS, something like this:

      h2.interviewer > p { color: red }

    (or something far more tortorous if you need to Internet Explorer 6
    support ...)

FUNCTIONS
  process
    Takes the text, and spits out the html.

AUTHOR
    Kieren Diment, "<zarquon at cpan.org>"

BUGS
    Please report any bugs or feature requests to "bug-text-format-interview
    at rt.cpan.org", or through the web interface at
    <http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Text-Format-Interview>.
    I will be notified, and then you'll automatically be notified of
    progress on your bug as I make changes.

SUPPORT
    You can find documentation for this module with the perldoc command.

        perldoc Text::Format::Interview

    You can also look for information at:

    *   RT: CPAN's request tracker

        <http://rt.cpan.org/NoAuth/Bugs.html?Dist=Text-Format-Interview>

    *   AnnoCPAN: Annotated CPAN documentation

        <http://annocpan.org/dist/Text-Format-Interview>

    *   CPAN Ratings

        <http://cpanratings.perl.org/d/Text-Format-Interview>

    *   Search CPAN

        <http://search.cpan.org/dist/Text-Format-Interview/>

    *   Version Control Repository (Github)

        <http://github.com/singingfish/Test-Format-Interview/tree/master>

ACKNOWLEDGEMENTS
COPYRIGHT & LICENSE
    Copyright 2009 Kieren Diment, all rights reserved.

    This program is free software; you can redistribute it and/or modify it
    under the same terms as Perl itself.

POD ERRORS
    Hey! The above document had some coding errors, which are explained
    below:

    Around line 175:
        '=item' outside of any '=over'

    Around line 180:
        You forgot a '=back' before '=head1'

Something went wrong with that request. Please try again.