argra****@users*****
argra****@users*****
2012年 9月 30日 (日) 05:01:58 JST
Index: docs/modules/CGI-WebGzip-0.12/WebGzip.pod
diff -u docs/modules/CGI-WebGzip-0.12/WebGzip.pod:1.2 docs/modules/CGI-WebGzip-0.12/WebGzip.pod:1.3
--- docs/modules/CGI-WebGzip-0.12/WebGzip.pod:1.2 Thu Jan 27 22:14:46 2011
+++ docs/modules/CGI-WebGzip-0.12/WebGzip.pod Sun Sep 30 05:01:58 2012
@@ -3,26 +3,58 @@
=head1 NAME
+=begin original
+
CGI::WebGzip - Perl extension for GZipping script output
+
+=end original
+
CGI::WebGzip - 文字出力をGZipにより圧縮するPerl拡張
=head1 SYNOPSIS
+=begin original
+
# Usual code working with STDOUT:
+ use CGI::WebGzip;
+ print "Content-type: text/html\n\n";
+ print "Hello, world!";
+
+=end original
+
# 標準出力に使用される標準的なコードです:
use CGI::WebGzip;
print "Content-type: text/html\n\n";
print "Hello, world!";
+=begin original
+
# Lesser compression (by default 9, now - 5)
+ use CGI::WebGzip(5);
+
+=end original
+
# より小さい圧縮 (by default 9, now - 5)
use CGI::WebGzip(5);
+=begin original
+
# Set callback function which would be called after compressing,
# but before any output. You may set cookie in this function to
# display them later on the page (using JavaScript).
+ use CGI::WebGzip;
+ BEGIN {
+ CGI::WebGzip::setCallback(sub {
+ my ($nL, $oL) = (length $_[0], length $_[2]);
+ print sprintf "Set-Cookie: page_size=%d,%d; path=/\n", $oL, $nL;
+ return 1;
+ });
+ }
+
+=end original
+
# どんな出力の前にでも,圧縮された後に呼ばれるcallback関数設定して下さい.
# あなたはこの関数の中でCookieをセットすことができる
# 後でJavaScriptを使用してCookieを表示して下さい.
@@ -36,14 +68,33 @@
}
+=begin original
+
# Working together with CGI::WebOut.
+ use CGI::WebGzip;
+ use CGI::WebOut;
+ print "Hello, world!";
+
+=end original
+
# CGI::WebOutと一緒に動かす場合.
use CGI::WebGzip;
use CGI::WebOut;
print "Hello, world!";
+=begin original
+
# Work in FastCGI environment.
+ require CGI::WebGzip;
+ while (read request) {
+ CGI::WebGzip::import; # captures output
+ ...
+ CGI::WebGzip::flush(); # releases output
+ }
+
+=end original
+
# FastCGI環境で動かす場合.
require CGI::WebGzip;
while (read request) {
@@ -55,11 +106,15 @@
=head1 OVERVIEW
+=begin original
+
In PHP, you may write: C<ob_start("ob_gzhandler")> and get all the output
GZip-ed automatically. CGI::WebGzip does the same thing. Is you include this module
in the beginning of your program, it whill capture all the output. When
the script ends, CGI::WebGzip compresses captured data and send it to browser.
+=end original
+
PHPではあなたはこのように書くことができます:C<ob_start("ob_gzhandler")> そして
GZipにより圧縮された出力を自動ですべて取得することができます.
CGI::WebGzipは同じことをします.
@@ -67,9 +122,13 @@
その間の全ての出力を得ることができます.
スクリプトが終了するとCGI::WebGzipは取得したデータを圧縮しそれをブラウザに送ります.
+=begin original
+
If browser is incompatible with GZip encoding, output will not be captured,
and data will not be compressed.
+=end original
+
もしブラウザがGZipエンコーディングを実装していない場合,出力を得ず,
データを圧縮しないでしょう.
@@ -79,75 +138,111 @@
=item use CGI::WebGzip([compression_level])
+=begin original
+
Captures all the script output for deflating. Default compression level
is 9 (maximum). Value 0 means no compression.
+=end original
+
取得した全てのスクリプトの出力を縮小させます.
デフォルトの圧縮レベルは9です（最大値）.
圧縮レベル0は圧縮しないことを意味します.
=item void flush()
+=begin original
+
Flushes the compressed buffer immediately and releases STDOUT capture.
Usable in FastCGI environment together with manual C<import()> call
(see synopsis above).
+=end original
+
圧縮されたバッファを標準出力に即座に流します.
FastCGIが用いられている環境では手動でC<import()>呼び出しとともに行います(上に書かれたSYNOPSISを見るように).
=item bool getAbility()
+=begin original
+
Returns undef if browser we are in CGI mode, browser supports compression
and Compress::Zlib is found. Otherwise returns non-empty diagnostic message.
+=end original
+
CGIモードでブラウザが圧縮をサポートしかつCompress::Zlibが存在する場合undefを返す.
そうでなければ空でない診断メッセージを返します
=item bool isCompressibleType($type)
+=begin original
+
Returns true if page of this MIME type can be compressed.
+=end original
+
このMIMEタイプを圧縮することができるのならばtrueを返す.
=item CODE setCallback(CODE $func)
+=begin original
+
Sets the callback function called AFTER compression process, but BEFORE
any output. You may print additional headers in this function (for example,
set cookies). If this function returns false, compressed data would not be
printed later (presume function does it itself). Arguments:
+=end original
+
どんな出力の前にも,圧縮処理の後に呼ばれるcallback関数設定して下さい.
この関数で追加ヘッダをつけることができる(例えば,cookiesをセットする).
bool callback(string $compressedBody, string $headers, string $originalBody)
+=begin original
+
Returns previous callback reference.
+=end original
+
前のcallbackの参照を返します.
=item int setLevel($level)
+=begin original
+
Sets another compression level. Returns previous.
+=end original
+
別の圧縮レベルをセットします.
前の圧縮レベルを返します.
=item string getStatus()
+=begin original
+
You may determine if the compression was performed by this function. It
returns undef if data has been compressed or non-empty diagnostic message otherwise.
+=end original
+
この関数により圧縮が実行されたかを確認することができる.
データが圧縮されたかまたは空でない診断メッセージがなければundefを返す.
=item ($compressedBody, $modifiedHeaders, $status) ob_gzhandler(string $body [,string $headers])
+=begin original
+
Returns compressed data (additionally analysing headers, if present).
In scalar context returns C<$compressedBody> only.
Input headers can be modified, thus this function returns C<$modifiedHeaders>.
In C<$status> compression feruse message is returned (or undef if everything is OK).
This function can be used exactly as PHPs C<ob_gzhandler()>.
+=end original
+
圧縮されたデータを返す(その上で現在のヘッダを分析する)
スカラーコンテキストはC<$compressedBody>だけを返す
入力ヘッダーを変更することができます,したがってこの関数はC<$modifiedHeaders>を返します。
@@ -156,23 +251,35 @@
=item string deflate_gzip($text, $level);
+=begin original
+
Compresses the input string and returns result.
+=end original
+
入力文字列を圧縮して結果を返します.
=back
=head2 EXPORT
+=begin original
+
None by default.
+=end original
+
デフォルトでは何もない.
=head2 DEPENDENCIES
+=begin original
+
CGI::WebGzip depends on Compress::Zlib only. If this library is not found, no
error messages are generated.
+=end original
+
CGI::WebGzipはCompress::Zlibだけに依存しています.
もしこのライブラリが見つからない場合でもエラーメッセージは生成されません.