Skip Menu |
 

Preferred bug tracker

Please visit the preferred bug tracker to report your issue.

This queue is for tickets about the CGI CPAN distribution.

Report information
The Basics
Id: 62785
Status: resolved
Priority: 0/
Queue: CGI

People
Owner: Nobody in particular
Requestors: scop [...] cpan.org
Cc:
AdminCc:

Bug Information
Severity: Normal
Broken in: (no value)
Fixed in: (no value)

Attachments
0001-Documentation-spelling-fixes.patch



Subject: [PATCH] Documentation spelling fixes
Subject: 0001-Documentation-spelling-fixes.patch
From 5e0773fb4b099f18504020a03e8b094ca43d07c3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ville=20Skytt=C3=A4?= <ville.skytta@iki.fi> Date: Sat, 6 Nov 2010 23:21:07 +0200 Subject: [PATCH] Documentation spelling fixes. --- cgi-lib_porting.html | 8 ++++---- lib/CGI.pm | 18 +++++++++--------- lib/CGI/Pretty.pm | 2 +- lib/CGI/Push.pm | 2 +- lib/CGI/Util.pm | 2 +- 5 files changed, 16 insertions(+), 16 deletions(-) diff --git a/cgi-lib_porting.html b/cgi-lib_porting.html index 5e3893c..ceef97d 100644 --- a/cgi-lib_porting.html +++ b/cgi-lib_porting.html @@ -88,7 +88,7 @@ continue to use cgi-lib.pl. <h2>How do I migrate from cgi-lib.pl to CGI.pm?</h2> -A compatability mode allows you to port most scripts that use +A compatibility mode allows you to port most scripts that use cgi-lib.pl to CGI.pm without making extensive source code changes. Most of the functions defined in cgi-lib.pl version 2.10 are available for your use. Missing functions are easy to work around. Follow this @@ -120,7 +120,7 @@ use CGI qw(:cgi-lib); </pre></blockquote> instructs Perl to read in CGI.pm and to import into your script's name -space the cgi-lib.pl compatability routines. (In case you've never +space the cgi-lib.pl compatibility routines. (In case you've never run into this syntax before, the colon in front of <code>cgi-lib</code> indicates that we're importing a family of routines identified by the tag <cite>cgi-lib</cite> rather than a @@ -173,7 +173,7 @@ print textfield(-name=&gt;'price', <h2>Cgi-lib functions that are available in CGI.pm</h2> -In compatability mode, the following cgi-lib.pl functions are +In compatibility mode, the following cgi-lib.pl functions are available for your use: <ol> @@ -237,7 +237,7 @@ available for your use: <h2>Caveats</h2> -The compatability routines are a recent feature (added in CGI.pm +The compatibility routines are a recent feature (added in CGI.pm version 2.20, released on May 22, 1996) and may contain bugs. <strong>Caveat emptor!</strong> <hr> diff --git a/lib/CGI.pm b/lib/CGI.pm index d9e1f05..fab368a 100644 --- a/lib/CGI.pm +++ b/lib/CGI.pm @@ -5514,7 +5514,7 @@ of JavaScript. Example: ); The option "-language" is a synonym for -type, and is supported for -backwad compatibility. +backwards compatibility. The old-style positional parameters are as follows: @@ -5922,7 +5922,7 @@ autoEscape() method with a false value immediately after creating the CGI object $query->autoEscape(0); Note that autoEscape() is exclusively used to effect the behavior of how some -CGI.pm HTML generation fuctions handle escaping. Calling escapeHTML() +CGI.pm HTML generation functions handle escaping. Calling escapeHTML() explicitly will always escape the HTML. I<A Lurking Trap!> Some of the form-element generating methods return @@ -5972,7 +5972,7 @@ action and form encoding that you specify. The defaults are: method: POST action: this script enctype: application/x-www-form-urlencoded for non-XHTML - multipart/form-data for XHTML, see mulitpart/form-data below. + multipart/form-data for XHTML, see multipart/form-data below. end_form() returns the closing </form> tag. @@ -6215,7 +6215,7 @@ recognized. See textfield() for details. =head3 Basics -When the form is processed, you can retrieve an L<IO::Handle> compatibile +When the form is processed, you can retrieve an L<IO::Handle> compatible handle for a file upload field like this: $lightweight_fh = $q->upload('field_name'); @@ -6303,7 +6303,7 @@ if you wish. CGI.pm gives you low-level access to file upload management through a file upload hook. You can use this feature to completely turn off the temp file storage of file uploads, or potentially write your own -file upload progess meter. +file upload progress meter. This is much like the UPLOAD_HOOK facility available in L<Apache::Request>, with the exception that the first argument to the callback is an L<Apache::Upload> @@ -6356,7 +6356,7 @@ param() is not a filehandle at all, but a string. To solve this problem the upload() method was added, which always returns a lightweight filehandle. This generally works well, but will have trouble interoperating with some other modules because the file handle is not derived -from L<IO::Handle>. So that brings us to current recommedation given above, +from L<IO::Handle>. So that brings us to current recommendation given above, which is to call the handle() method on the file handle returned by upload(). That upgrades the handle to an IO::Handle. It's a big win for compatibility for a small penalty of loading IO::Handle the first time you call it. @@ -7595,7 +7595,7 @@ Returns the remote host IP address, or 127.0.0.1 if the address is unavailable. =item B<script_name()> -Return the script name as a partial URL, for self-refering +Return the script name as a partial URL, for self-referring scripts. =item B<referer()> @@ -7712,7 +7712,7 @@ Prefix in Name. =item In the B<use> statement -Simply add the "-nph" pragmato the list of symbols to be imported into +Simply add the "-nph" pragma to the list of symbols to be imported into your script: use CGI qw(:standard -nph) @@ -7933,7 +7933,7 @@ bug reports, please provide the version of CGI.pm, the version of Perl, the name and version of your Web server, and the name and version of the operating system you are using. If the problem is even remotely browser dependent, please provide information about the -affected browers as well. +affected browsers as well. =head1 CREDITS diff --git a/lib/CGI/Pretty.pm b/lib/CGI/Pretty.pm index 3567478..869fe0c 100644 --- a/lib/CGI/Pretty.pm +++ b/lib/CGI/Pretty.pm @@ -252,7 +252,7 @@ now produces the following output: =head2 Recommendation for when to use CGI::Pretty CGI::Pretty is far slower than using CGI.pm directly. A benchmark showed that -it could be about 10 times slower. Adding newslines and spaces may alter the +it could be about 10 times slower. Adding newlines and spaces may alter the rendered appearance of HTML. Also, the extra newlines and spaces also make the file size larger, making the files take longer to download. diff --git a/lib/CGI/Push.pm b/lib/CGI/Push.pm index 9e72abd..c8ac280 100644 --- a/lib/CGI/Push.pm +++ b/lib/CGI/Push.pm @@ -214,7 +214,7 @@ itself should have exactly the same calling conventions as the This optional parameter indicates the content type of each page. It defaults to "text/html". Normally the module assumes that each page -is of a homogenous MIME type. However if you provide either of the +is of a homogeneous MIME type. However if you provide either of the magic values "heterogeneous" or "dynamic" (the latter provided for the convenience of those who hate long parameter names), you can specify the MIME type -- and other header fields -- on a per-page basis. See diff --git a/lib/CGI/Util.pm b/lib/CGI/Util.pm index eb639e4..3d4fcf1 100644 --- a/lib/CGI/Util.pm +++ b/lib/CGI/Util.pm @@ -383,7 +383,7 @@ bug reports, please provide the version of CGI.pm, the version of Perl, the name and version of your Web server, and the name and version of the operating system you are using. If the problem is even remotely browser dependent, please provide information about the -affected browers as well. +affected browsers as well. =head1 SEE ALSO -- 1.7.2.3
Subject: Re: [rt.cpan.org #62785] [PATCH] Documentation spelling fixes
Date: Mon, 08 Nov 2010 11:22:38 -0500
To: bug-CGI.pm [...] rt.cpan.org
From: Mark Stosberg <mark [...] summersault.com>
Download (untitled) / with headers
text/plain 114b
Thanks for the documentation improvements. We'll include these in a future release, with credit to you. Mark
Thanks again. This is now patched in our git repo. Mark
Subject: patch released for CGI.pm
Thanks for the bug report. A patch for it appeared in 3.51, if not sooner. Resolving. Mark


This service is sponsored and maintained by Best Practical Solutions and runs on Perl.org infrastructure.

Please report any issues with rt.cpan.org to rt-cpan-admin@bestpractical.com.