NAME

Text::Multi::Block::Metadata - Text::Multi processor for Metadata blocks

SYNOPSIS

  {{{ Metadata }}}
  Title: Some funky title
  Foo: Bar

DESCRIPTION

This subclass of Text::Multi::Block implements a metadata information block, which can provide additional information about the file to your application. The content of the block is assumed to be a simple email-header like key/value format. The content will be processed into a hash when accessed. By default the contents of a Metadata block are not displayed.

PARAMETERS

These are parameters that can be set in the Text::Multi tag in your text document, to provide additional information to formatter modules, and potentially to influence how the content is rendered. Also see "PARAMETERS" in Text::Multi::Block for inherited parameters that can be used by this formatter.

hidden

Set to a false value to have the metadata rendered into the output as a simple table, which you can style with CSS.

METHODS

get( $tag );

The get method provides access to the metadata content. For example, if your application defines a need for a 'Title' metadata element, you might access it this way:

  my $tm = Text::Multi->new;
  $tm->process_file( 'myfile.txtm' );
  my ( $meta ) = $tm->find_blocks( type => 'Metadata' );
  my $title = $meta->get( 'title' );

The metadata header tags are not case-sensitive.

INTERNAL METHODS

as_html()

See "as_html" in Text::Multi::Block.

SEE ALSO

Text::Multi

Text::Multi::Block

http://www.jasonkohles.com/software/Text-Multi/

AUTHOR

Jason Kohles <email@jasonkohles.com>.

COPYRIGHT AND LICENSE

Copyright (C) 2007 by Jason Kohles

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