Perl6::Pod::Parser::Utils - set of useful functions


Perl6-Pod documentation  | view source Contained in the Perl6-Pod distribution.

Index


NAME

Top

Perl6::Pod::Parser::Utils - set of useful functions

SYNOPSIS

Top

    use Perl6::Pod::Parser::Utils qw(parse_URI );

DESCRIPTION

Top

Set of useful functions

METHODS

Top

parse_URI ($string)

Parse Pod's URI:.

    scheme:path#section_name(rules)

For example:

    http://www.exapmple.com/test.pod#Sect1
    test.pod
    file:bundle.pod(para :public)
    file:../file1.txt
    Name|http://www.com#test

Return stucture:

    'Name|http://example.com/index.html#txt':
      {
        'is_external' => 1,
        'name'        => 'Name',
        'section'     => 'txt',
        'address'     => 'example.com/index.html',
        'scheme'      => 'http'
      }




    '../data/test.pod':
      {
        'is_external' => '',
        'name'        => '',
        'section'     => '',
        'address'     => '../data/test.pod',
        'scheme'      => 'file'
      }







    'http://www.com/d.pod(head1 :todo, para)':
     {
          'is_external' => '1',
          'name' => '',
          'section' => '',
          'address' => 'www.com/d.pod',
          'scheme' => 'http',
          'rules' => 'head1 :todo, para'
        }

SEE ALSO

Top

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

AUTHOR

Top

Zahatski Aliaksandr, <zag@cpan.org>

COPYRIGHT AND LICENSE

Top


Perl6-Pod documentation  | view source Contained in the Perl6-Pod distribution.