nlopess Fri Sep 9 18:12:34 2005 EDT
Added files:
/phpdoc/en/reference/unicode configure.xml reference.xml
/phpdoc/en/reference/unicode/functions unicode-encode.xml
Log:
Dan Scott has danced... and the rain begins :)
commiting the first docs for unicode. its need a nice introduction
http://cvs.php.net/co.php/phpdoc/en/reference/unicode/configure.xml?r=1.1&p=1
Index: phpdoc/en/reference/unicode/configure.xml
+++ phpdoc/en/reference/unicode/configure.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<section id="unicode.installation">
&reftitle.install;
<para>
First you should download and install ICU:
<example>
<title>install ICU on Unix</title>
<programlisting role="shell">
<![CDATA[../configure --disable-threads --enable-extras --enable-icuio
--enable-layout
make && make install
]]>
</programlisting>
</example>
</para>
<para>
Then checkout latest PHP and configure it <option
role="configure">--with-icu-dir=<dir></option> option, where
<dir> was the dir to where you installed ICU. You don't need to
explicitly use this option if you install ICU to a standard location.
</para>
</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:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/co.php/phpdoc/en/reference/unicode/reference.xml?r=1.1&p=1
Index: phpdoc/en/reference/unicode/reference.xml
+++ phpdoc/en/reference/unicode/reference.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Purpose: international -->
<!-- Membership: core, external -->
<!-- note to translators:
do NOT translate anything in this extension!!
the docs will change very very often -->
<reference id="ref.unicode">
<title>Unicode Functions</title>
<titleabbrev>Unicode</titleabbrev>
<partintro>
<section id="unicode.intro">
&reftitle.intro;
<para>
Unicode Support. <!-- nice intro needed :) -->
</para>
<warning>
<para>
This extension is still in development and it isn't available to public
yet.
</para>
</warning>
</section>
<section id="unicode.requirements">
&reftitle.required;
<para>
<ulink url="&url.icu;">ICU</ulink> 3.4 or later is required.
</para>
</section>
&reference.unicode.configure;
<!--&reference.unicode.ini;-->
</partintro>
&reference.unicode.functions;
</reference>
<!-- 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:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
http://cvs.php.net/co.php/phpdoc/en/reference/unicode/functions/unicode-encode.xml?r=1.1&p=1
Index: phpdoc/en/reference/unicode/functions/unicode-encode.xml
+++ phpdoc/en/reference/unicode/functions/unicode-encode.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<refentry id="function.unicode-encode">
<refnamediv>
<refname>unicode_encode</refname>
<refpurpose>Takes a unicode string and converts it to a string in the
specified encoding</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>string</type><methodname>unicode_encode</methodname>
<methodparam><type>unicode</type><parameter>input</parameter></methodparam>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
&warn.undocumented.func;
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>input</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
Its description
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
What the function returns, first on success, then on failure.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>A <function>unicode_encode</function> example</title>
<para>
Any text that describes the purpose of t
</para>
<programlisting role="php">
<![CDATA[
<?php
if ($anexample === true) {
echo 'Use the PEAR Coding Standards';
}
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Use the PEAR Coding Standards
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>unicode_decode</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- 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:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->