/ 
Pod-Elemental-0.003
River stage three • 63 direct dependents • 259 total dependents
/ Pod::Elemental::Document

NAME

Pod::Elemental::Document - a pod document

VERSION

version 0.003

ATTRIBUTES

target

This is the format to which the document was targeted. By default, this is undefined and the document is vanilla pod. If this is set, the document may or may not be pod, and is intended for some other form of processor. (See "is_pod".)

is_pod

If true, this document contains pod paragraphs, as opposed to data paragraphs. This will generally result from the document originating in a =begin block with a colon-prefixed target identifier:

=begin :html

  This is still a verbatim paragraph.

=end :html

encoding

This attribute, if set, indicates the encoding of the document.

METHODS

target_string

This returns the target to be included in the pod output. It is the target attribute, if set, prepended with a colon if is_pod is true.

AUTHOR

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

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

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