Scroll to navigation

Pod::Weaver::Plugin::SingleEncoding(3pm) User Contributed Perl Documentation Pod::Weaver::Plugin::SingleEncoding(3pm)

NAME

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

VERSION

version 4.015

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.

AUTHOR

Ricardo SIGNES <rjbs@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2016 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.

2016-10-22 perl v5.24.1