Ricardo SIGNES > Pod-Elemental-Transformer-WikiDoc > Pod::Elemental::Transformer::WikiDoc

Download:
Pod-Elemental-Transformer-WikiDoc-0.093003.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Module Version: 0.093003   Source  

NAME ^

Pod::Elemental::Transformer::WikiDoc - a transformer to replace "wikidoc" data regions with Pod5 elements

VERSION ^

version 0.093003

SYNOPSIS ^

  my $document = Pod::Elemental->read_string( $string );
  Pod::Elemental::Transformer::Pod5->new->transform_node( $document );

  Pod::Elemental::Transformer::WikiDoc->new->transform_node( $document );

...and if you had a section like this:

  =begin wikidoc

  == Look, a header!

  * Foo
  * Bar
  * Baz

  =end wikidoc

...you now have something more like this:

  =head2 Look, a header!

  =over 4
  
  =item Foo

  =item Bar

  =item Baz

  =back

For complete documentation on this dialect, see Pod::WikiDoc.

Possibly the most succinct, powerful use case is this:

  =head2 some_method

  This B<public> method takes the following arguments:

  =for wikidoc
  * name
  * rank
  * serial_number

  =cut

ATTRIBUTES ^

format_name

This attribute indicates the format name of regions to be transformed from WikiDoc. By default, the transformer will look for regions of the format "wikidoc."

METHODS ^

transform_node

AUTHOR ^

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE ^

This software is copyright (c) 2013 by Ricardo SIGNES.

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

syntax highlighting: