Pod::Weaver::Plugin::SingleEncoding(3)

NAME
Pod::Weaver::Plugin::SingleEncoding - ensure that there is exactly one =encoding of known value

VERSION
version 4.020

OVERVIEW
The SingleEncoding plugin is a Dialect and a Finalizer.

During dialect translation, it will look for "=encoding" directives. If it finds them, it will ensure that they all agree on one encoding and remove them.

During document finalization, it will insert an "=encoding" directive at the top of the output, using the encoding previously detected. If no encoding was detected, the plugin's "encoding" attribute will be used instead. That defaults to UTF-8.

If you want to reject any "=encoding" directive that doesn't match your expectations, set the "encoding" attribute by hand.

No actual validation of the encoding is done. Pod::Weaver, after all, deals in text rather than bytes.

PERL VERSION
This module should work on any version of perl still receiving updates from the Perl 5 Porters. This means it should work on any version of perl released in the last two to three years. (That is, if the most recently released version is v5.40, then this module should work on both v5.40 and v5.38.)

Although it may work on older versions of perl, no guarantee is made that the minimum required version will not be increased. The version may be increased for any reason, and there is no promise that patches will be accepted to lower the minimum required perl.

AUTHOR
Ricardo SIGNES <cpan@semiotic.systems>

COPYRIGHT AND LICENSE
This software is copyright (c) 2024 by Ricardo SIGNES.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.