/ 
Perl6-Pod-Lib-0.04
River stage one • 2 direct dependents • 2 total dependents
/ Perl6::Pod::Lib::Include

NAME

Perl6::Pod::Block::Include - to include pod in the specified place

SYNOPSIS

=Inlcude t/data/P_test1.pod(para :private :public)
=Include file:t/data/P_test1.pod
=Include http://example.com/api.pod(head1 :public)

=begin Include
file:../intro.pod( :!develop )
file:../api.pod(:public,para :notes)
http://example.com/todo.pod
=end Include

DESCRIPTION

The =Include block is used for include other Pod documents or their parts. For definition of the target file are used a URI:

=Include
file:../intro.pod
http://example.com/todo.pod

For inclusion of certain parts of the documents add the blockname and (or) attributes after the main link. For example:

=Include file:../intro.pod(para :public,item1)
=Include http://example.com/document.pod ( :todo )

The content of included documents will be filtered through that rules.

Eamples of the rules:

(para :pubic)

all paragraphs with attribute :public is set on

(:todo :private)

all blocks with attributes :todo and :private

(head1, head2)

all head1 and head2 blocks

SEE ALSO

http://perlcabal.org/syn/S26.html

AUTHOR

Zahatski Aliaksandr, <zag@cpan.org>

COPYRIGHT AND LICENSE

Copyright (C) 2010 by Zahatski Aliaksandr

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.8.8 or, at your option, any later version of Perl 5 you may have available.