https://github.com/poti1/pod-lol

Parse Pod into a list of lists (LOL)
https://github.com/poti1/pod-lol

hacktoberfest parser perl perl5 perldoc pod

Last synced: about 1 month ago
JSON representation

Parse Pod into a list of lists (LOL)

• Host: GitHub
• URL: https://github.com/poti1/pod-lol
• Owner: poti1
• Created: 2022-05-18T08:31:50.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-13T12:58:48.000Z (6 months ago)
• Last Synced: 2024-06-14T03:23:18.474Z (6 months ago)
• Topics: hacktoberfest, parser, perl, perl5, perldoc, pod
• Language: Perl
• Homepage:
• Size: 89.8 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: Changes

Awesome Lists containing this project

README

        
# NAME

Pod::LOL - parse Pod into a list of lists (LOL)

# VERSION

Version 0.14

# SYNOPSIS

    % cat my.pod

    =head1 NAME

    Pod::LOL - parse Pod into a list of lists (LOL)

    % perl -MPod::LOL -MData::Dumper -e 'print Dumper( Pod::LOL->new_root("my.pod") )'

Returns:

    [

       [

          "head1",

          "NAME"

       ],

       [

          "Para",

          "Pod::LOL - parse Pod into a list of lists (LOL)"

       ],

    ]

# DESCRIPTION

This class may be of interest to anyone writing a pod parser.

This module takes pod (as a file) and returns a list of lists (LOL) structure.

This is a subclass of [Pod::Simple](https://metacpan.org/pod/Pod%3A%3ASimple) and inherits all of its methods.

# SUBROUTINES/METHODS

## new\_root

Convenience method to do (mostly) this:

    Pod::LOL->new->parse_file( $file )->{root};

## \_handle\_element\_start

Overrides Pod::Simple.

Executed when a new pod element starts such as:

    "head1"

    "Para"

## \_handle\_text

Overrides Pod::Simple.

Executed for each text element such as:

    "NAME"

    "Pod::LOL - parse Pod into a list of lists (LOL)"

## \_handle\_element\_end

Overrides Pod::Simple.

Executed when a pod element ends.

Such as when these tags end:

    "head1"

    "Para"

# SEE ALSO

[App::Pod](https://metacpan.org/pod/App%3A%3APod)

[Pod::Query](https://metacpan.org/pod/Pod%3A%3AQuery)

[Pod::Simple](https://metacpan.org/pod/Pod%3A%3ASimple)

# AUTHOR

Tim Potapov, ``

# BUGS

Please report any bugs or feature requests to [https://github.com/poti1/pod-lol/issues](https://github.com/poti1/pod-lol/issues).

# SUPPORT

You can find documentation for this module with the perldoc command.

    perldoc Pod::LOL

You can also look for information at:

[https://metacpan.org/pod/Pod::LOL](https://metacpan.org/pod/Pod::LOL)

[https://github.com/poti1/pod-lol](https://github.com/poti1/pod-lol)

# ACKNOWLEDGEMENTS

TBD

# LICENSE AND COPYRIGHT

This software is Copyright (c) 2022 by Tim Potapov.

This is free software, licensed under:

    The Artistic License 2.0 (GPL Compatible)