moriyoshi Tue Dec 23 08:46:55 2003 EDT
Modified files:
/phpdoc/en/reference/iconv reference.xml
/phpdoc/en/reference/iconv/functions iconv-get-encoding.xml
iconv-mime-encode.xml
iconv-set-encoding.xml
Log:
Various updates.
Index: phpdoc/en/reference/iconv/reference.xml
diff -u phpdoc/en/reference/iconv/reference.xml:1.12
phpdoc/en/reference/iconv/reference.xml:1.13
--- phpdoc/en/reference/iconv/reference.xml:1.12 Sat Nov 30 07:45:44 2002
+++ phpdoc/en/reference/iconv/reference.xml Tue Dec 23 08:46:54 2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.12 $ -->
+<!-- $Revision: 1.13 $ -->
<reference id="ref.iconv">
<title>iconv functions</title>
<titleabbrev>iconv</titleabbrev>
@@ -8,21 +8,33 @@
<section id="iconv.intro">
&reftitle.intro;
<para>
- This module contains an interface to the iconv library functions.
- The iconv library functions convert strings between various
- character sets encodings. The supported character sets depend on the
- iconv() implementation on your system. Note that the iconv() function
- on some systems may not work as well as you expect. In this case, you
- should install the libiconv library.
+ This module contains an interface to iconv character set conversion
+ facility. With this module, you can turn a string represented by a local
+ character set into the one represented by another character set,
+ which may be the Unicode charcter set. Supported character sets
+ depends on the iconv() implementation of your system.
+ Note that the iconv function on some systems may not work
+ as you expect. In such case, it'd be a good idea to install the
+ <ulink url="&url.libiconv;">GNU libiconv</ulink> library. It will most
+ likely end up with more consistent results.
</para>
+
+ <para>
+ Since <application>PHP</application> 5.0.0, this extension comes with
+ various utility functions that help you to write multilingual
+ scripts. Let's have a look at the following sections to explore the new
+ features.
+ </para>
</section>
<section id="iconv.requirements">
&reftitle.required;
<para>
- Your systems standard C library must provide the iconv() function or you
- must have libiconv installed on your system. The libiconv library is
- available from <ulink url="&url.libiconv;">&url.libiconv;</ulink>.
+ You will need nothing if the system you are using is one of the recent
+ POSIX-compliant systems because standard C libraries that is supplied in
+ them must provide iconv faclity. Otherwise, you have to get the
+ <ulink url="&url.libiconv;">libiconv</ulink> library installed in
+ your system.
</para>
</section>
@@ -40,8 +52,7 @@
<section id="iconv.seealso">
&reftitle.seealso;
<para>
- See also the
- <link linkend="ref.recode">GNU Recode functions</link>.
+ See also <link linkend="ref.recode">GNU Recode functions</link>.
</para>
</section>
Index: phpdoc/en/reference/iconv/functions/iconv-get-encoding.xml
diff -u phpdoc/en/reference/iconv/functions/iconv-get-encoding.xml:1.7
phpdoc/en/reference/iconv/functions/iconv-get-encoding.xml:1.8
--- phpdoc/en/reference/iconv/functions/iconv-get-encoding.xml:1.7 Wed Dec 17
09:32:27 2003
+++ phpdoc/en/reference/iconv/functions/iconv-get-encoding.xml Tue Dec 23 08:46:55
2003
@@ -1,20 +1,24 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.7 $ -->
+<!-- $Revision: 1.8 $ -->
<!-- splitted from ./en/functions/iconv.xml, last change in rev 1.1 -->
<refentry id="function.iconv-get-encoding">
<refnamediv>
<refname>iconv_get_encoding</refname>
- <refpurpose>Get current setting for character encoding conversion</refpurpose>
+ <refpurpose>Retrieve internal configuration variables of iconv
extension</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
- <type>array</type><methodname>iconv_get_encoding</methodname>
+ <type>mixed</type><methodname>iconv_get_encoding</methodname>
<methodparam
choice="opt"><type>string</type><parameter>type</parameter></methodparam>
</methodsynopsis>
<para>
- It returns the current settings of
- <function>ob_iconv_handler</function> as array or &false; on failure.
+ <function>iconv_get_encoding</function> returns the current value
+ of the internal configuration variable if successful,
+ or &false; on failure.
+ </para>
+
+ <para>
The value of the optional <parameter>type</parameter> can be:
<simplelist>
<member>all</member>
@@ -22,9 +26,12 @@
<member>output_encoding</member>
<member>internal_encoding</member>
</simplelist>
- If <parameter>type</parameter> is omitted or not 'all'
- <function>iconv_get_encoding</function> returns the current settings of
- <function>ob_iconv_handler</function> as string.
+ </para>
+
+ <para>
+ If <parameter>type</parameter> is omitted or set to "all",
+ <function>iconv_get_encoding</function> returns an array that
+ stores all these variables.
</para>
<para>
<example>
Index: phpdoc/en/reference/iconv/functions/iconv-mime-encode.xml
diff -u phpdoc/en/reference/iconv/functions/iconv-mime-encode.xml:1.5
phpdoc/en/reference/iconv/functions/iconv-mime-encode.xml:1.6
--- phpdoc/en/reference/iconv/functions/iconv-mime-encode.xml:1.5 Tue Dec 23
07:21:27 2003
+++ phpdoc/en/reference/iconv/functions/iconv-mime-encode.xml Tue Dec 23 08:46:55
2003
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.5 $ -->
+<!-- $Revision: 1.6 $ -->
<!-- Generated by xml_proto.php v2.0. Found in /scripts directory of phpdoc. -->
<refentry id="function.iconv-mime-encode">
<refnamediv>
@@ -143,7 +143,7 @@
</example>
<para>
- See also <function>imap_base64_encode</function>,
+ See also <function>imap_binary</function>,
<function>mb_encode_mimeheader</function>
and <function>imap_8bit</function>.
</para>
Index: phpdoc/en/reference/iconv/functions/iconv-set-encoding.xml
diff -u phpdoc/en/reference/iconv/functions/iconv-set-encoding.xml:1.6
phpdoc/en/reference/iconv/functions/iconv-set-encoding.xml:1.7
--- phpdoc/en/reference/iconv/functions/iconv-set-encoding.xml:1.6 Wed Jul 16
13:13:01 2003
+++ phpdoc/en/reference/iconv/functions/iconv-set-encoding.xml Tue Dec 23 08:46:55
2003
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.6 $ -->
+<!-- $Revision: 1.7 $ -->
<!-- splitted from ./en/functions/iconv.xml, last change in rev 1.1 -->
<refentry id="function.iconv-set-encoding">
<refnamediv>
@@ -14,11 +14,12 @@
<methodparam><type>string</type><parameter>charset</parameter></methodparam>
</methodsynopsis>
<para>
- It changes the value of <parameter>type</parameter> to
+ <function>iconv_set_encoding</function> changes the value of the internal
+ configuration variable specified by <parameter>type</parameter> to
<parameter>charset</parameter>. &return.success;
</para>
<para>
- The value of <parameter>type</parameter> can be:
+ The value of <parameter>type</parameter> can be any one of those:
<simplelist>
<member>input_encoding</member>
<member>output_encoding</member>
