goba Mon Jul 22 12:14:13 2002 EDT
Added files:
/phpdoc/en/reference/mbstring constants.xml
Modified files:
/phpdoc/en/reference/mbstring reference.xml
Log:
Applying new structure, adding constants info ;)
Index: phpdoc/en/reference/mbstring/reference.xml
diff -u phpdoc/en/reference/mbstring/reference.xml:1.2
phpdoc/en/reference/mbstring/reference.xml:1.3
--- phpdoc/en/reference/mbstring/reference.xml:1.2 Mon Apr 15 14:56:45 2002
+++ phpdoc/en/reference/mbstring/reference.xml Mon Jul 22 12:14:13 2002
@@ -1,15 +1,16 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<reference id="ref.mbstring">
<title>Multi-Byte String Functions</title>
<titleabbrev>Multi-Byte String</titleabbrev>
<partintro>
- <section id="mb-intro">
- <title>Introduction</title>
+
+ <section id="mbstring.intro">
+ &reftitle.intro;
<para>
There are many languages in which all characters can be expressed
by single byte. Multi-byte character codes are used to express
- many characters for many languages. <literal>mbstring</literal>
+ many characters for many languages. <literal>mbstring</literal>
is developed to handle Japanese characters. However, many
<literal>mbstring</literal> functions are able to handle
character encoding other than Japanese.
@@ -82,7 +83,7 @@
</note>
<note>
<para>
- If you use database with PHP, it is recommended that you use the
+ If you use databases with PHP, it is recommended that you use the
same character encoding for both database and <literal>internal
encoding</literal> for ease of use and better performance.
</para>
@@ -92,17 +93,18 @@
the PostgreSQL manual for details.
</para>
</note>
+ </section>
- <section id="mb-enable">
- <title>How to Enable mbstring</title>
+ <section id="mbstring.installation">
+ &reftitle.install;
<para>
<literal>mbstring</literal> is an extended module. You must
- enable module with <literal>configure</literal> script. Refer
- to the <link linkend="installation">Install</link> section for
+ enable the module with the <literal>configure</literal> script.
+ Refer to the <link linkend="installation">Install</link> section for
details.
</para>
<simpara>
- The following configure options are related to
+ The following configure options are related to the
<literal>mbstring</literal> module.
</simpara>
<para>
@@ -126,9 +128,162 @@
</listitem>
</itemizedlist>
</para>
- </section>
+ </section>
+
+ <section id="mbstring.configuration">
+ &reftitle.runtime;
+ <para>
+ <itemizedlist>
+ <listitem>
+ <simpara>
+ <literal>mbstring.internal_encoding</literal> defines default
+ internal character encoding.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <literal>mbstring.http_input</literal> defines default HTTP
+ input character encoding.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <literal>mbstring.http_output</literal> defines default HTTP
+ output character encoding.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <literal>mbstring.detect_order</literal> defines default
+ character code detection order. See also
+ <function>mb_detect_order</function>.
+ </simpara>
+ </listitem>
+ <listitem>
+ <simpara>
+ <literal>mbstring.substitute_character</literal> defines
+ character to substitute for invalid character encoding.
+ </simpara>
+ </listitem>
+ </itemizedlist>
+ </para>
+ <para>
+ Web Browsers are supposed to use the same character encoding
+ when submitting form. However, browsers may not use the same
+ character encoding. See <function>mb_http_input</function> to
+ detect character encoding used by browsers.
+ </para>
+ <para>
+ If <literal>enctype</literal> is set to
+ <literal>multipart/form-data</literal> in HTML forms,
+ <literal>mbstring</literal> does not convert character encoding
+ in POST data. The user must convert them in the script, if
+ conversion is needed.
+ </para>
+ <para>
+ Although, browsers are smart enough to detect character encoding
+ in HTML. <literal>charset</literal> is better to be set in HTTP
+ header. Change <literal>default_charset</literal> according to
+ character encoding.
+ </para>
+ <para>
+ <example>
+ <title>&php.ini; setting example</title>
+ <programlisting>
+<![CDATA[
+;; Set default internal encoding
+;; Note: Make sure to use character encoding works with PHP
+mbstring.internal_encoding = UTF-8 ; Set internal encoding to UTF-8
+
+;; Set default HTTP input character encoding
+;; Note: Script cannot change http_input setting.
+mbstring.http_input = pass ; No conversion.
+mbstring.http_input = auto ; Set HTTP input to auto
+ ; "auto" is expanded to "ASCII,JIS,UTF-8,EUC-JP,SJIS"
+mbstring.http_input = SJIS ; Set HTTP2 input to SJIS
+mbstring.http_input = UTF-8,SJIS,EUC-JP ; Specify order
- <section id="mb-conv">
+;; Set default HTTP output character encoding
+mbstring.http_output = pass ; No conversion
+mbstring.http_output = UTF-8 ; Set HTTP output encoding to UTF-8
+
+;; Set default character encoding detection order
+mbstring.detect_order = auto ; Set detect order to auto
+mbstring.detect_order = ASCII,JIS,UTF-8,SJIS,EUC-JP ; Specify order
+
+;; Set default substitute character
+mbstring.substitute_character = 12307 ; Specify Unicode value
+mbstring.substitute_character = none ; Do not print character
+mbstring.substitute_character = long ; Long Example: U+3000,JIS+7E7E
+]]>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ <example>
+ <title>&php.ini; setting for <literal>EUC-JP</literal> users</title>
+ <programlisting>
+<![CDATA[
+;; Disable Output Buffering
+output_buffering = Off
+
+;; Set HTTP header charset
+default_charset = EUC-JP
+
+;; Set HTTP input encoding conversion to auto
+mbstring.http_input = auto
+
+;; Convert HTTP output to EUC-JP
+mbstring.http_output = EUC-JP
+
+;; Set internal encoding to EUC-JP
+mbstring.internal_encoding = EUC-JP
+
+;; Do not print invalid characters
+mbstring.substitute_character = none
+]]>
+ </programlisting>
+ </example>
+ </para>
+ <para>
+ <example>
+ <title>&php.ini; setting for <literal>SJIS</literal> users</title>
+ <programlisting>
+<![CDATA[
+;; Enable Output Buffering
+output_buffering = On
+
+;; Set mb_output_handler to enable output conversion
+output_handler = mb_output_handler
+
+;; Set HTTP header charset
+default_charset = Shift_JIS
+
+;; Set http input encoding conversion to auto
+mbstring.http_input = auto
+
+;; Convert to SJIS
+mbstring.http_output = SJIS
+
+;; Set internal encoding to EUC-JP
+mbstring.internal_encoding = EUC-JP
+
+;; Do not print invalid characters
+mbstring.substitute_character = none
+]]>
+ </programlisting>
+ </example>
+ </para>
+ </section>
+
+ <section id="mbstring.resources">
+ &reftitle.resources;
+ &no.resource;
+ </section>
+
+ &reference.mbstring.constants;
+
+ <section id="mbstring.http">
<title>HTTP Input and Output</title>
<para>
HTTP input/output character encoding conversion may convert
@@ -231,18 +386,19 @@
</programlisting>
</example>
</para>
- </section>
+ </section>
- <section id="mb-code">
- <title>Supported Character Encoding</title>
+ <section id="mbstring.encodings">
+ <title>Supported Character Encodings</title>
<simpara>
- Currently, the following character encoding is supported by
- <literal>mbstring</literal> module. Caracter encoding may
+ Currently, the following character encoding is supported by the
+ <literal>mbstring</literal> module. Character encoding may
be specified for <literal>mbstring</literal> functions'
- <literal>encoding</literal> parameter. </simpara>
+ <literal>encoding</literal> parameter.
+ </simpara>
<para>
The following character encoding is supported in this PHP
- extension :
+ extension:
</para>
<para>
<literal>UCS-4</literal>, <literal>UCS-4BE</literal>,
@@ -292,158 +448,11 @@
works as internal character code.
</para>
</note>
- </section>
+ </section>
- <section id="mb-ini">
- <title>&php.ini; settings</title>
- <para>
- <itemizedlist>
- <listitem>
- <simpara>
- <literal>mbstring.internal_encoding</literal> defines default
- internal character encoding.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- <literal>mbstring.http_input</literal> defines default HTTP
- input character encoding.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- <literal>mbstring.http_output</literal> defines default HTTP
- output character encoding.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- <literal>mbstring.detect_order</literal> defines default
- character code detection order. See also
- <function>mb_detect_order</function>.
- </simpara>
- </listitem>
- <listitem>
- <simpara>
- <literal>mbstring.substitute_character</literal> defines
- character to substitute for invalid character encoding.
- </simpara>
- </listitem>
- </itemizedlist>
- </para>
- <para>
- Web Browsers are supposed to use the same character encoding
- when submitting form. However, browsers may not use the same
- character encoding. See <function>mb_http_input</function> to
- detect character encoding used by browsers.
- </para>
- <para>
- If <literal>enctype</literal> is set to
- <literal>multipart/form-data</literal> in HTML forms,
- <literal>mbstring</literal> does not convert character encoding
- in POST data. The user must convert them in the script, if
- conversion is needed.
- </para>
- <para>
- Although, browsers are smart enough to detect character encoding
- in HTML. <literal>charset</literal> is better to be set in HTTP
- header. Change <literal>default_charset</literal> according to
- character encoding.
- </para>
- <para>
- <example>
- <title>&php.ini; setting example</title>
- <programlisting>
-<![CDATA[
-;; Set default internal encoding
-;; Note: Make sure to use character encoding works with PHP
-mbstring.internal_encoding = UTF-8 ; Set internal encoding to UTF-8
-
-;; Set default HTTP input character encoding
-;; Note: Script cannot change http_input setting.
-mbstring.http_input = pass ; No conversion.
-mbstring.http_input = auto ; Set HTTP input to auto
- ; "auto" is expanded to "ASCII,JIS,UTF-8,EUC-JP,SJIS"
-mbstring.http_input = SJIS ; Set HTTP2 input to SJIS
-mbstring.http_input = UTF-8,SJIS,EUC-JP ; Specify order
-
-;; Set default HTTP output character encoding
-mbstring.http_output = pass ; No conversion
-mbstring.http_output = UTF-8 ; Set HTTP output encoding to UTF-8
-
-;; Set default character encoding detection order
-mbstring.detect_order = auto ; Set detect order to auto
-mbstring.detect_order = ASCII,JIS,UTF-8,SJIS,EUC-JP ; Specify order
-
-;; Set default substitute character
-mbstring.substitute_character = 12307 ; Specify Unicode value
-mbstring.substitute_character = none ; Do not print character
-mbstring.substitute_character = long ; Long Example: U+3000,JIS+7E7E
-]]>
- </programlisting>
- </example>
- </para>
- <para>
- <example>
- <title>&php.ini; setting for <literal>EUC-JP</literal> users</title>
- <programlisting>
-<![CDATA[
-;; Disable Output Buffering
-output_buffering = Off
-
-;; Set HTTP header charset
-default_charset = EUC-JP
-
-;; Set HTTP input encoding conversion to auto
-mbstring.http_input = auto
-
-;; Convert HTTP output to EUC-JP
-mbstring.http_output = EUC-JP
-
-;; Set internal encoding to EUC-JP
-mbstring.internal_encoding = EUC-JP
-
-;; Do not print invalid characters
-mbstring.substitute_character = none
-]]>
- </programlisting>
- </example>
- </para>
- <para>
- <example>
- <title>&php.ini; setting for <literal>SJIS</literal> users</title>
- <programlisting>
-<![CDATA[
-;; Enable Output Buffering
-output_buffering = On
-
-;; Set mb_output_handler to enable output conversion
-output_handler = mb_output_handler
-
-;; Set HTTP header charset
-default_charset = Shift_JIS
-
-;; Set http input encoding conversion to auto
-mbstring.http_input = auto
-
-;; Convert to SJIS
-mbstring.http_output = SJIS
-
-;; Set internal encoding to EUC-JP
-mbstring.internal_encoding = EUC-JP
-
-;; Do not print invalid characters
-mbstring.substitute_character = none
-]]>
- </programlisting>
- </example>
- </para>
- </section>
-
- <section id="mb-overload">
+ <section id="mbstring.overload">
<title>
- Overload of PHP string functions by mbstring functions with
- multibyte support
+ Overloading PHP string functions with multi byte string functions
</title>
<para>
Because almost PHP application written for language using
@@ -483,16 +492,16 @@
<row>
<entry>value of mbstring.func_overload</entry>
<entry>original function</entry>
- <entry>overloaded function</entry>
- </row>
+ <entry>overloaded function</entry>
+ </row>
</thead>
<tbody>
- <row>
- <entry>1</entry>
+ <row>
+ <entry>1</entry>
<entry><function>mail</function></entry>
<entry><function>mb_send_mail</function></entry>
</row>
- <row>
+ <row>
<entry>2</entry>
<entry><function>strlen</function></entry>
<entry><function>mb_strlen</function></entry>
@@ -536,15 +545,15 @@
<entry>4</entry>
<entry><function>split</function></entry>
<entry><function>mb_split</function></entry>
- </row>
+ </row>
</tbody>
</tgroup>
</table>
</para>
- </section>
+ </section>
- <section id="mb-ja-basic">
- <title>Basics for Japanese multi-byte character</title>
+ <section id="mbstring.ja-basic">
+ <title>Basics of Japanese multi-byte characters</title>
<para>
Most Japanese characters need more than 1 byte per character. In
addition, several character encoding schemas are used under a
@@ -587,9 +596,9 @@
</listitem>
</itemizedlist>
</para>
- </section>
+ </section>
- <section id="mb-ref">
+ <section id="mbstring.ref">
<title>References</title>
<para>
Multi-byte character encoding and its related issues are very
@@ -618,8 +627,6 @@
</listitem>
</itemizedlist>
</para>
- </section>
-
</section>
</partintro>
Index: phpdoc/en/reference/mbstring/constants.xml
+++ phpdoc/en/reference/mbstring/constants.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="mbstring.constants">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry>
<term>
<constant>MB_OVERLOAD_MAIL</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MB_OVERLOAD_STRING</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>MB_OVERLOAD_REGEX</constant>
(<link linkend="language.types.integer">integer</link>)
</term>
<listitem>
<simpara>
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->
--
PHP Documentation Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php
