-
-
28 Jul 2022 07:23:56 UTC
- Distribution: Pod-LOL
- Module version: 0.10
- Source (raw)
- Browse (raw)
- Changes
- How to Contribute
- Issues
- Testers (391 / 0 / 11)
- Kwalitee
Bus factor: 1- 88.51% Coverage
- License: artistic_2
- Activity
24 month- Tools
- Download (18.35KB)
- MetaCPAN Explorer
- Permissions
- Subscribe to distribution
- Permalinks
- This version
- Latest version
- Dependencies
- unknown
- Reverse dependencies
- CPAN Testers List
- Dependency graph
- NAME
- VERSION
- SYNOPSIS
- DESCRIPTION
- SUBROUTINES/METHODS
- SEE ALSO
- AUTHOR
- BUGS
- SUPPORT
- ACKNOWLEDGEMENTS
- LICENSE AND COPYRIGHT
NAME
Pod::LOL - parse Pod into a list of lists (LOL)
VERSION
Version 0.10
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 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
AUTHOR
Tim Potapov,
<tim.potapov[AT]gmail.com>
BUGS
Please report any bugs or feature requests to 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://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)
Module Install Instructions
To install Pod::LOL, copy and paste the appropriate command in to your terminal.
cpanm Pod::LOL
perl -MCPAN -e shell install Pod::LOL
For more information on module installation, please visit the detailed CPAN module installation guide.