view release on metacpan or  search on metacpan

lib/Podlite.pm  view on Meta::CPAN

=over

=item C<< Can't set up *DATA handle (%s) >>

The filter found at least one C<=data> block, but was unable to create a
C<*DATA> filehandle in the caller's namespace (for the reason specified in the
parens).

=back

=head1 CONFIGURATION AND ENVIRONMENT

Podlite requires no configuration files or environment variables.

=head1 DEPENDENCIES

Requires the standard module C<Filter::Simple>.

=head1 LIMITATIONS

Unlike full Podlite parsers:

=over

=item *

This module does not make every Podlite block available to the surrounding
program, only the C<=data> blocks. This is to avoid unacceptably slow
compilation speed that would result from attempting to fully parse the entire
embedded Podlite markup.

=item *

The contents of C<=data> blocks appear in the global variables C<$DATA> and
C<@DATA>, and the global C<*DATA> filehandle, rather than in a special
C<$?DATA> object. These variables and filehandle are accessible from C<main>
and in every other package that is explicitly declared in the file.

=item *

Parser modes (pod mode for C<.podlite> files, markdown mode for C<.md> files)
are not implemented in this source filter. You must explicitly use C<=begin>
blocks or other directives.

=back

=head1 BUGS

Please report any bugs  L<https://github.com/zag/p5-Podlite/issues>

=head1 SEE ALSO

=over

=item L<Podlite Specification|https://podlite.org/specification> - Official specification in HTML

=item L<Podlite Specification Source|https://github.com/podlite/podlite-specs> - Specification source code

=item L<Podlite Implementation|https://github.com/podlite/podlite> - Main Podlite implementation

=item L<Podlite Desktop|https://github.com/podlite/podlite-desktop> - Desktop viewer/editor

=item L<Podlite Web|https://github.com/podlite/podlite-web> - Publishing system

=item L<podlite.org|https://podlite.org> - Official website

=item L<Filter::Simple> - The module used for source filtering

=back

=head1 AUTHOR

Aliaksandr Zahatski, C<< <zag at cpan.org> >>

=head1 CREDITS

Damian Conway - for inspiration and source filter techniques

=head1 LICENCE AND COPYRIGHT

Copyright (C) 2025 by Aliaksandr Zahatski

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 you may have available.

=head1 DISCLAIMER OF STABILITY

This module will attempt to track any future changes to the Podlite
specification. Hence its features and the Podlite syntax it recognizes may
change in future releases.

=head1 DISCLAIMER OF WARRANTY

BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
NECESSARY SERVICING, REPAIR, OR CORRECTION.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

=cut