Skip to content

Commit 5510f67

Browse files
authored
doc-enの差分を反映(1) (#138)
* Add explicit warning about CSV function's escape parameterName php/doc-en@cef78b0 * Add title+titleabbrev to preface and reformat info box php/doc-en@dee52c0
1 parent cb4569b commit 5510f67

File tree

8 files changed

+42
-22
lines changed

8 files changed

+42
-22
lines changed

language-snippets.ent

+13-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 1cdefe36cdfc0e3acaff6a0db918d4b037081aa8 Maintainer: takagi Status: working -->
3+
<!-- EN-Revision: cef78b0fbe0fbe02003699b027ab50200097e949 Maintainer: takagi Status: working -->
44
<!-- Credits: hirokawa,haruki,shimooka,mumumu -->
55

66
<!ENTITY installation.enabled.disable 'この拡張モジュールはデフォルトで有効になっています。無効にしたい場合は、次のオプションを指定してコンパイルします。'>
@@ -1028,6 +1028,18 @@ $font = 'SomeFont';
10281028
</entry>
10291029
</row>'>
10301030

1031+
<!-- CSV -->
1032+
<!ENTITY warning.csv.escape-parameter '<warning xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink"><simpara>
1033+
<parameter>escape</parameter>
1034+
が空の文字列(<literal>""</literal>)以外に設定されているとき、
1035+
<link xlink:href="&url.rfc;4180">RFC 4180</link>
1036+
に準拠しない CSV が生成されたり、PHP の CSV
1037+
関数を介してラウンドトリップ(往復変換)でデータが壊れる可能性があります。
1038+
<parameter>escape</parameter>のデフォルト値は<literal>"\\"</literal>
1039+
なので、明示的に空の文字列を指定すること推奨します。デフォルト値は、PHP 9.0
1040+
以降の将来のバージョンで変更予定です。
1041+
</simpara></warning>'>
1042+
10311043
<!-- DBM notes -->
10321044

10331045
<!ENTITY dbm.dbm-identifier.description '<varlistentry xmlns="http://docbook.org/ns/docbook"><term><parameter>dbm_identifier</parameter></term><listitem><para><function>dbmopen</function> が返す DBM リンク識別子。</para></listitem></varlistentry>'>

preface.xml

+17-15
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,24 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 9a10d863b9e6acde050f1d5a559927d12a4e65b0 Maintainer: hirokawa Status: ready -->
3+
<!-- EN-Revision: dee52c067be3be96a735f0c33cbcf0009a996b2e Maintainer: hirokawa Status: ready -->
44

55
<preface xml:id="preface" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns="http://docbook.org/ns/docbook">
6-
<info><title>序文</title>
7-
<abstract>
8-
<simpara>
9-
<acronym>PHP</acronym> は、<emphasis>PHP: Hypertext Preprocessor</emphasis>
10-
を意味し、広く使用されているオープンソースの汎用スクリプト言語です。
11-
HTML に埋め込むことができ、Web アプリケーションの開発に特に適しています。
12-
PHP の構文の多くは C、Java、Perl 言語から転用したもので、
13-
簡単に習得することができます。この言語は、動的に生成されるウェブページを
14-
Web 開発者が速やかに作成できるようにすることを主な目標として
15-
つくられました。しかし、それだけにとどまらず、
16-
もっと多くのことを PHP を使って行うことができます。
17-
</simpara>
18-
</abstract>
19-
</info>
6+
<info>
7+
<titleabbrev>序文</titleabbrev>
8+
<title>このマニュアルについて</title>
9+
<abstract>
10+
<simpara>
11+
<acronym>PHP</acronym> は、<emphasis>PHP: Hypertext Preprocessor</emphasis>
12+
を意味し、広く使用されているオープンソースの汎用スクリプト言語です。
13+
HTML に埋め込むことができ、Web アプリケーションの開発に特に適しています。
14+
PHP の構文の多くは C、Java、Perl 言語から転用したもので、
15+
簡単に習得することができます。この言語は、動的に生成されるウェブページを
16+
Web 開発者が速やかに作成できるようにすることを主な目標として
17+
つくられました。しかし、それだけにとどまらず、
18+
もっと多くのことを PHP を使って行うことができます。
19+
</simpara>
20+
</abstract>
21+
</info>
2022

2123
<para>
2224
このマニュアルは、

reference/filesystem/functions/fgetcsv.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 61374bbe228e8e9c55a24aba59a1e2bb2a871148 Maintainer: hirokawa Status: ready -->
3+
<!-- EN-Revision: cef78b0fbe0fbe02003699b027ab50200097e949 Maintainer: hirokawa Status: ready -->
44
<!-- CREDITS: shimooka,mumumu -->
55
<refentry xml:id="function.fgetcsv" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -104,6 +104,7 @@
104104
</varlistentry>
105105
</variablelist>
106106
</para>
107+
&warning.csv.escape-parameter;
107108
</refsect1>
108109

109110
<refsect1 role="returnvalues">

reference/filesystem/functions/fputcsv.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 291d60430d25f2b508bebb5720b41cc68f9a6ec1 Maintainer: takagi Status: ready -->
3+
<!-- EN-Revision: cef78b0fbe0fbe02003699b027ab50200097e949 Maintainer: takagi Status: ready -->
44
<!-- Credits: mumumu -->
55
<refentry xml:id="function.fputcsv" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -84,6 +84,7 @@
8484
</varlistentry>
8585
</variablelist>
8686
</para>
87+
&warning.csv.escape-parameter;
8788
<note>
8889
<para>
8990
<parameter>enclosure</parameter> がフィールド内に含まれる場合は、同じ文字を二度続けることでエスケープします。

reference/spl/splfileobject/fgetcsv.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 61374bbe228e8e9c55a24aba59a1e2bb2a871148 Maintainer: masakielastic Status: ready -->
3+
<!-- EN-Revision: cef78b0fbe0fbe02003699b027ab50200097e949 Maintainer: masakielastic Status: ready -->
44
<!-- Credits: mumumu -->
55
<refentry xml:id="splfileobject.fgetcsv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
66
<refnamediv>
@@ -78,6 +78,7 @@
7878
</varlistentry>
7979
</variablelist>
8080
</para>
81+
&warning.csv.escape-parameter;
8182
</refsect1>
8283

8384
<refsect1 role="returnvalues">

reference/spl/splfileobject/fputcsv.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: takagi Status: ready -->
3+
<!-- EN-Revision: cef78b0fbe0fbe02003699b027ab50200097e949 Maintainer: takagi Status: ready -->
44
<!-- Credits: mumumu -->
55
<refentry xml:id="splfileobject.fputcsv" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
66
<refnamediv>
@@ -78,6 +78,7 @@
7878
ただし、その直前に <parameter>escape</parameter> がある場合は別です。
7979
</para>
8080
</note>
81+
&warning.csv.escape-parameter;
8182
</refsect1>
8283

8384
<refsect1 role="returnvalues">

reference/spl/splfileobject/setcsvcontrol.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: d51166ca16fda8e766849505b84f9306ef443f71 Maintainer: masakielastic Status: ready -->
3+
<!-- EN-Revision: cef78b0fbe0fbe02003699b027ab50200097e949 Maintainer: masakielastic Status: ready -->
44
<!-- Credits: mumumu -->
55
<refentry xml:id="splfileobject.setcsvcontrol" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
66
<refnamediv>
@@ -52,6 +52,7 @@
5252
</varlistentry>
5353
</variablelist>
5454
</para>
55+
&warning.csv.escape-parameter;
5556
</refsect1>
5657

5758
<refsect1 role="returnvalues">

reference/strings/functions/str-getcsv.xml

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<!-- $Revision$ -->
3-
<!-- EN-Revision: 61374bbe228e8e9c55a24aba59a1e2bb2a871148 Maintainer: takagi Status: ready -->
3+
<!-- EN-Revision: cef78b0fbe0fbe02003699b027ab50200097e949 Maintainer: takagi Status: ready -->
44
<!-- Credits: mumumu -->
55
<refentry xml:id="function.str-getcsv" xmlns="http://docbook.org/ns/docbook">
66
<refnamediv>
@@ -86,6 +86,7 @@
8686
</varlistentry>
8787
</variablelist>
8888
</para>
89+
&warning.csv.escape-parameter;
8990
</refsect1>
9091

9192
<refsect1 role="returnvalues">

0 commit comments

Comments
 (0)