[libhtml-scrubber-perl] 20/30: Ensured other module references are marked as L<>
Florian Schlichting
fsfs at moszumanska.debian.org
Sat Nov 11 13:46:20 UTC 2017
This is an automated email from the git hooks/post-receive script.
fsfs pushed a commit to annotated tag release/0.16
in repository libhtml-scrubber-perl.
commit 1b693f3541ae7e3109d0bfb76955e854d8f04f96
Author: Nigel Metheringham <nigelm at cpan.org>
Date: Sun Jun 25 16:45:46 2017 +0100
Ensured other module references are marked as L<>
Re-tidied (basically just pod reformat).
Updated Changes
---
Changes | 4 +++
README.pod | 92 +++++++++++++++++++++++++++++-----------------------
lib/HTML/Scrubber.pm | 41 +++++++++++------------
3 files changed, 76 insertions(+), 61 deletions(-)
diff --git a/Changes b/Changes
index cda4110..2970da6 100644
--- a/Changes
+++ b/Changes
@@ -1,6 +1,10 @@
Revision history for Perl extension HTML::Scrubber.
{{$NEXT}}
+ - Add missing testing prereqs (github pr#9 paultcochrane)
+ - Extend list of Perls in Travis config (github pr#10 paultcochrane)
+ - Avoid pod-spell test failure from ABSTRACT text (github pr#11 paultcochrane)
+ - Minor documentation fixes (github pr#12 paultcochrane)
0.15 2015-10-10 15:01:31+01:00 Europe/London
- Minor spelling check avoidance tweaks
diff --git a/README.pod b/README.pod
index a115ef6..3eefa54 100644
--- a/README.pod
+++ b/README.pod
@@ -1,14 +1,16 @@
=pod
-=for stopwords html cpan callback homepage Perlbrew perltidy respository
+=encoding UTF-8
=head1 NAME
-HTML::Scrubber - Perl extension for scrubbing/sanitizing html
+HTML::Scrubber - Perl extension for scrubbing/sanitizing HTML
=head1 VERSION
-version 0.15
+version 0.16
+
+=for stopwords html cpan callback homepage Perlbrew perltidy repository
=head1 SYNOPSIS
@@ -40,14 +42,18 @@ version 0.15
If you want to "scrub" or "sanitize" html input in a reliable and flexible
fashion, then this module is for you.
-I wasn't satisfied with HTML::Sanitizer because it is based on
-HTML::TreeBuilder, so I thought I'd write something similar that works directly
-with HTML::Parser.
+I wasn't satisfied with L<HTML::Sanitizer> because it is based on
+L<HTML::TreeBuilder>, so I thought I'd write something similar that works
+directly with L<HTML::Parser>.
+
+=head1 DESCRIPTION
+
+L<Master Build Results|https://travis-ci.org/nigelm/html-scrubber>
=head1 METHODS
First a note on documentation: just study the L<EXAMPLE|"EXAMPLE"> below. It's
-all the documentation you could need
+all the documentation you could need.
Also, be sure to read all the comments as well as L<How does it work?|"How does
it work?">.
@@ -70,9 +76,9 @@ If you're new to perl, good luck to you.
if $p->script; # off by default
$p->script( 0 || 1 );
-B<**> Please note that this is implemented using HTML::Parser's ignore_elements
-function, so if C<script> is set to true, all script tags encountered will be
-validated like all other tags.
+B<**> Please note that this is implemented using L<HTML::Parser>'s
+C<ignore_elements> function, so if C<script> is set to true, all script tags
+encountered will be validated like all other tags.
=head2 style
@@ -80,9 +86,9 @@ validated like all other tags.
if $p->style; # off by default
$p->style( 0 || 1 );
-B<**> Please note that this is implemented using HTML::Parser's ignore_elements
-function, so if C<style> is set to true, all style tags encountered will be
-validated like all other tags.
+B<**> Please note that this is implemented using L<HTML::Parser>'s
+C<ignore_elements> function, so if C<style> is set to true, all style tags
+encountered will be validated like all other tags.
=head2 allow
@@ -107,11 +113,11 @@ validated like all other tags.
...
);
-Updates set of attribute rules. Each rule can be 1/0, regular expression or a
-callback. Values longer than 1 char are treated as regexps. Callback is called
-with the following arguments: this object, tag name, attribute name and
-attribute value, should return empty list to drop attribute, C<undef> to keep
-it without value or a new scalar value.
+Updates a set of attribute rules. Each rule can be 1/0, a regular expression or
+a callback. Values longer than 1 char are treated as regexps. The callback is
+called with the following arguments: the current object, tag name, attribute
+name, and attribute value; the callback should return an empty list to drop the
+attribute, C<undef> to keep it without a value, or a new scalar value.
=head2 default
@@ -151,28 +157,29 @@ Takes tag, rule('_' || $tag), attrref.
=for comment _scrub_str
-I<default> handler, used by both _scrub and _scrub_fh Moved all the common code
-(basically all of it) into a single routine for ease of maintenance
+I<default> handler, used by both C<_scrub> and C<_scrub_fh>. Moved all the
+common code (basically all of it) into a single routine for ease of
+maintenance.
=for comment _scrub_fh
I<default> handler, does the scrubbing if we're scrubbing out to a file. Now
-calls _scrub_str and pushes that out to a file.
+calls C<_scrub_str> and pushes that out to a file.
=for comment _scrub
I<default> handler, does the scrubbing if we're returning a giant string. Now
-calls _scrub_str and appends that to the output string.
+calls C<_scrub_str> and appends that to the output string.
=head1 How does it work?
-When a tag is encountered, HTML::Scrubber allows/denies the tag using the
+When a tag is encountered, L<HTML::Scrubber> allows/denies the tag using the
explicit rule if one exists.
If no explicit rule exists, Scrubber applies the default rule.
-If an explicit rule exists, but it's a simple rule(1), the default attribute
-rule is applied.
+If an explicit rule exists, but it's a simple rule(1), then the default
+attribute rule is applied.
=head2 EXAMPLE
@@ -299,7 +306,7 @@ rule is applied.
=head2 FUN
-If you have Test::Inline (and you've installed HTML::Scrubber), try
+If you have L<Test::Inline> (and you've installed L<HTML::Scrubber>), try
pod2test Scrubber.pm >scrubber.t
perl scrubber.t
@@ -308,7 +315,7 @@ If you have Test::Inline (and you've installed HTML::Scrubber), try
L<HTML::Parser>, L<Test::Inline>.
-The C<HTML::Sanitizer> module is no longer available on CPAN.
+The L<HTML::Sanitizer> module is no longer available on CPAN.
=head1 VERSION REQUIREMENTS
@@ -332,29 +339,31 @@ environment with L<Dist::Zilla>, and if you're just getting started, there's
some documentation on using Vagrant and Perlbrew
L<here|http://mrcaron.github.io/2015/03/06/Perl-CPAN-Pull-Request.html>.
-There is now a C<.perltidyrc> and a <.tidyallrc> file within the respository
+There is now a C<.perltidyrc> and a C<.tidyallrc> file within the repository
for the standard perltidy settings used - I will apply these before new
releases. Please do not let formatting prevent you from sending in patches etc
- this can be sorted out as part of the release process. Info on C<tidyall>
can be found at
L<https://metacpan.org/pod/distribution/Code-TidyAll/bin/tidyall>.
-=head1 INSTALLATION
+=for :stopwords cpan testmatrix url annocpan anno bugtracker rt cpants kwalitee diff irc mailto metadata placeholders metacpan
+
+=head1 SUPPORT
-See perlmodinstall for information and options on installing Perl modules.
+=head2 Bugs / Feature Requests
-=head1 BUGS AND LIMITATIONS
+Please report any bugs or feature requests through the issue tracker at
+L<http://rt.cpan.org/Public/Dist/Display.html?Name=HTML-Scrubber>. You will be
+notified automatically of any progress on your issue.
-You can make new bug reports, and view existing ones, through the
-web interface at L<http://rt.cpan.org/Public/Dist/Display.html?Name=HTML-Scrubber>.
+=head2 Source Code
-=head1 AVAILABILITY
+This is open source software. The code repository is available for public
+review and contribution under the terms of the license.
-The project homepage is L<https://metacpan.org/release/HTML-Scrubber>.
+L<https://github.com/nigelm/html-scrubber>
-The latest version of this module is available from the Comprehensive Perl
-Archive Network (CPAN). Visit L<http://www.perl.com/CPAN/> to find a CPAN
-site near you, or see L<https://metacpan.org/module/HTML::Scrubber/>.
+ git clone https://github.com/nigelm/html-scrubber.git
=head1 AUTHORS
@@ -376,9 +385,10 @@ D. H. <podmaster at cpan.org>
=head1 COPYRIGHT AND LICENSE
-This software is copyright (c) 2015 by Ruslan Zakirov, Nigel Metheringham, 2003-2004 D. H..
+This software is copyright (c) 2017 by Ruslan Zakirov, Nigel Metheringham,
+2003-2004 D. H.
-This is free software; you can redistribute it and/or modify it under
-the same terms as the Perl 5 programming language system itself.
+This is free software; you can redistribute it and/or modify it under the same
+terms as the Perl 5 programming language system itself.
=cut
diff --git a/lib/HTML/Scrubber.pm b/lib/HTML/Scrubber.pm
index 7a11b59..2e4cde3 100644
--- a/lib/HTML/Scrubber.pm
+++ b/lib/HTML/Scrubber.pm
@@ -43,9 +43,9 @@ L<Master Build Results|https://travis-ci.org/nigelm/html-scrubber>
If you want to "scrub" or "sanitize" html input in a reliable and flexible
fashion, then this module is for you.
-I wasn't satisfied with C<HTML::Sanitizer> because it is based on
-C<HTML::TreeBuilder>, so I thought I'd write something similar that works directly
-with C<HTML::Parser>.
+I wasn't satisfied with L<HTML::Sanitizer> because it is based on
+L<HTML::TreeBuilder>, so I thought I'd write something similar that works
+directly with L<HTML::Parser>.
=head1 METHODS
@@ -154,9 +154,9 @@ sub process {
if $p->script; # off by default
$p->script( 0 || 1 );
-B<**> Please note that this is implemented using C<HTML::Parser>'s C<ignore_elements>
-function, so if C<script> is set to true, all script tags encountered will be
-validated like all other tags.
+B<**> Please note that this is implemented using L<HTML::Parser>'s
+C<ignore_elements> function, so if C<script> is set to true, all script tags
+encountered will be validated like all other tags.
=cut
@@ -173,9 +173,9 @@ sub script {
if $p->style; # off by default
$p->style( 0 || 1 );
-B<**> Please note that this is implemented using C<HTML::Parser>'s C<ignore_elements>
-function, so if C<style> is set to true, all style tags encountered will be
-validated like all other tags.
+B<**> Please note that this is implemented using L<HTML::Parser>'s
+C<ignore_elements> function, so if C<style> is set to true, all style tags
+encountered will be validated like all other tags.
=cut
@@ -235,11 +235,11 @@ sub deny {
...
);
-Updates a set of attribute rules. Each rule can be 1/0, a regular expression or a
-callback. Values longer than 1 char are treated as regexps. The callback is called
-with the following arguments: the current object, tag name, attribute name, and
-attribute value; the callback should return an empty list to drop the attribute,
-C<undef> to keep it without a value, or a new scalar value.
+Updates a set of attribute rules. Each rule can be 1/0, a regular expression or
+a callback. Values longer than 1 char are treated as regexps. The callback is
+called with the following arguments: the current object, tag name, attribute
+name, and attribute value; the callback should return an empty list to drop the
+attribute, C<undef> to keep it without a value, or a new scalar value.
=cut
@@ -405,7 +405,8 @@ sub _validate {
=for comment _scrub_str
I<default> handler, used by both C<_scrub> and C<_scrub_fh>. Moved all the
-common code (basically all of it) into a single routine for ease of maintenance.
+common code (basically all of it) into a single routine for ease of
+maintenance.
=cut
@@ -545,13 +546,13 @@ sub _optimize {
=head1 How does it work?
-When a tag is encountered, C<HTML::Scrubber> allows/denies the tag using the
+When a tag is encountered, L<HTML::Scrubber> allows/denies the tag using the
explicit rule if one exists.
If no explicit rule exists, Scrubber applies the default rule.
-If an explicit rule exists, but it's a simple rule(1), then the default attribute
-rule is applied.
+If an explicit rule exists, but it's a simple rule(1), then the default
+attribute rule is applied.
=head2 EXAMPLE
@@ -679,7 +680,7 @@ rule is applied.
=head2 FUN
-If you have C<Test::Inline> (and you've installed C<HTML::Scrubber>), try
+If you have L<Test::Inline> (and you've installed L<HTML::Scrubber>), try
pod2test Scrubber.pm >scrubber.t
perl scrubber.t
@@ -688,7 +689,7 @@ If you have C<Test::Inline> (and you've installed C<HTML::Scrubber>), try
L<HTML::Parser>, L<Test::Inline>.
-The C<HTML::Sanitizer> module is no longer available on CPAN.
+The L<HTML::Sanitizer> module is no longer available on CPAN.
=head1 VERSION REQUIREMENTS
--
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libhtml-scrubber-perl.git
More information about the Pkg-perl-cvs-commits
mailing list