Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
Pod::Elemental::TransfUserrContributed PerPod::Elemental::Transformer::Pod5(3)

NAME
       Pod::Elemental::Transformer::Pod5 - the default,	minimal	semantics of
       Perl5's pod element hierarchy

VERSION
       version 0.103004

SYNOPSIS
	 Pod::Elemental::Transformer::Pod5->new->transform_node($pod_elem_document);

       ...and that's it.

OVERVIEW
       The Pod5	transformer is meant to	be used	to convert the result of a
       "stock" Pod::Elemental::Document	into something simpler to work with.
       It assumes that the document conforms more or less to the convetions
       laid out	in perlpod and perlpodspec.  It	is not very strict, and	makes
       very few	assumptions, described here:

       o   =begin/=end and =for	enclose	or produce regions within the document

       o   regions are associated with format names; format names that begin
	   with	a colon	enclose	more pod-like content

       o   regions nest	strictly; all inner regions must end before outer
	   regions

       o   paragraphs in non-pod regions are "data" paragraphs

       o   non-data paragraphs that start with spaces are "verbatim"
	   paragraphs

       o   groups of data or verbatim paragraphs can be	consolodated

       Further,	all elements are replaced with equivalent elements that
       perform the Pod::Elemental::Autoblank role, so all "blank" events can
       be removed form the tree	and ignored.

CONFIGURATION
       None.  For now, it just does the	same thing every time with no
       configuration or	options.

AUTHOR
       Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE
       This software is	copyright (c) 2014 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.

perl v5.24.1			  2014-12-Pod::Elemental::Transformer::Pod5(3)

NAME | VERSION | SYNOPSIS | OVERVIEW | CONFIGURATION | AUTHOR | COPYRIGHT AND LICENSE

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=Pod::Elemental::Transformer::Pod5&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help