philip Mon Jan 15 06:50:03 2007 UTC
Modified files:
/phpdoc/en/reference/gettext/functions bind-textdomain-codeset.xml
bindtextdomain.xml
dcgettext.xml dcngettext.xml
dgettext.xml dngettext.xml
gettext.xml ngettext.xml
Log:
ref.gettext - Implemented the new doc style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/gettext/functions/bind-textdomain-codeset.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/gettext/functions/bind-textdomain-codeset.xml
diff -u phpdoc/en/reference/gettext/functions/bind-textdomain-codeset.xml:1.4
phpdoc/en/reference/gettext/functions/bind-textdomain-codeset.xml:1.5
--- phpdoc/en/reference/gettext/functions/bind-textdomain-codeset.xml:1.4
Mon Jan 15 02:06:20 2007
+++ phpdoc/en/reference/gettext/functions/bind-textdomain-codeset.xml Mon Jan
15 06:50:03 2007
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/gettext.xml, last change in rev 1.17 -->
+<!-- $Revision: 1.5 $ -->
<refentry id='function.bind-textdomain-codeset'>
<refnamediv>
<refname>bind_textdomain_codeset</refname>
<refpurpose>Specify the character encoding in which the messages from the
DOMAIN message catalog will be returned</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>bind_textdomain_codeset</methodname>
<methodparam><type>string</type><parameter>domain</parameter></methodparam>
@@ -19,6 +19,37 @@
<function>gettext</function> and similar functions.
</para>
</refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>domain</parameter></term>
+ <listitem>
+ <para>
+ The domain
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>codeset</parameter></term>
+ <listitem>
+ <para>
+ The code set
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ A <type>string</type> on success.
+ </para>
+ </refsect1>
</refentry>
<!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/gettext/functions/bindtextdomain.xml?r1=1.5&r2=1.6&diff_format=u
Index: phpdoc/en/reference/gettext/functions/bindtextdomain.xml
diff -u phpdoc/en/reference/gettext/functions/bindtextdomain.xml:1.5
phpdoc/en/reference/gettext/functions/bindtextdomain.xml:1.6
--- phpdoc/en/reference/gettext/functions/bindtextdomain.xml:1.5 Mon Jan
15 02:06:20 2007
+++ phpdoc/en/reference/gettext/functions/bindtextdomain.xml Mon Jan 15
06:50:03 2007
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.5 $ -->
-<!-- splitted from ./en/functions/gettext.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.6 $ -->
<refentry id="function.bindtextdomain">
<refnamediv>
<refname>bindtextdomain</refname>
<refpurpose>Sets the path for a domain</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>bindtextdomain</methodname>
<methodparam><type>string</type><parameter>domain</parameter></methodparam>
@@ -15,9 +15,43 @@
</methodsynopsis>
<para>
The <function>bindtextdomain</function> function sets the path
- for a domain. It returns the full pathname for the domain currently being
- set.
+ for a domain.
+ </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>domain</parameter></term>
+ <listitem>
+ <para>
+ The domain
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>directory</parameter></term>
+ <listitem>
+ <para>
+ The directory path
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
</para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ The full pathname for the <parameter>domain</parameter> currently being set.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>bindtextdomain</function> example</title>
@@ -31,9 +65,7 @@
?>
]]>
</programlisting>
- <para>
- This will output:
- </para>
+ &example.outputs;
<screen>
<![CDATA[
/usr/share/myapp/locale
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/gettext/functions/dcgettext.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/gettext/functions/dcgettext.xml
diff -u phpdoc/en/reference/gettext/functions/dcgettext.xml:1.4
phpdoc/en/reference/gettext/functions/dcgettext.xml:1.5
--- phpdoc/en/reference/gettext/functions/dcgettext.xml:1.4 Mon Jan 15
02:06:20 2007
+++ phpdoc/en/reference/gettext/functions/dcgettext.xml Mon Jan 15 06:50:03 2007
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/gettext.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.dcgettext">
<refnamediv>
<refname>dcgettext</refname>
<refpurpose>Overrides the domain for a single lookup</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>dcgettext</methodname>
<methodparam><type>string</type><parameter>domain</parameter></methodparam>
@@ -16,11 +16,55 @@
</methodsynopsis>
<para>
This function allows you to override the current domain for a
- single message lookup. It also allows you to specify a
- <parameter>category</parameter>.
+ single message lookup.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>domain</parameter></term>
+ <listitem>
+ <para>
+ The domain
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>message</parameter></term>
+ <listitem>
+ <para>
+ The message
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>category</parameter></term>
+ <listitem>
+ <para>
+ The category
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ A <type>string</type> on success.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also <function>gettext</function>.
+ <simplelist>
+ <member><function>gettext</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/gettext/functions/dcngettext.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/gettext/functions/dcngettext.xml
diff -u phpdoc/en/reference/gettext/functions/dcngettext.xml:1.4
phpdoc/en/reference/gettext/functions/dcngettext.xml:1.5
--- phpdoc/en/reference/gettext/functions/dcngettext.xml:1.4 Mon Jan 15
02:06:20 2007
+++ phpdoc/en/reference/gettext/functions/dcngettext.xml Mon Jan 15
06:50:03 2007
@@ -1,13 +1,12 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/gettext.xml, last change in rev 1.16 -->
+<!-- $Revision: 1.5 $ -->
<refentry id='function.dcngettext'>
<refnamediv>
<refname>dcngettext</refname>
<refpurpose>Plural version of dcgettext</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>dcngettext</methodname>
<methodparam><type>string</type><parameter>domain</parameter></methodparam>
@@ -18,11 +17,67 @@
</methodsynopsis>
<para>
This function allows you to override the current domain for a
- single plural message lookup. It also allows you to specify a
- <parameter>category</parameter>.
+ single plural message lookup.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>domain</parameter></term>
+ <listitem>
+ <para>
+ The domain
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>msgid1</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>msgid2</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>n</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>category</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ A <type>string</type> on success.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also <function>ngettext</function>.
+ <simplelist>
+ <member><function>ngettext</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/gettext/functions/dgettext.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/gettext/functions/dgettext.xml
diff -u phpdoc/en/reference/gettext/functions/dgettext.xml:1.4
phpdoc/en/reference/gettext/functions/dgettext.xml:1.5
--- phpdoc/en/reference/gettext/functions/dgettext.xml:1.4 Mon Jan 15
02:06:20 2007
+++ phpdoc/en/reference/gettext/functions/dgettext.xml Mon Jan 15 06:50:03 2007
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/gettext.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.dgettext">
<refnamediv>
<refname>dgettext</refname>
<refpurpose>Override the current domain</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>dgettext</methodname>
<methodparam><type>string</type><parameter>domain</parameter></methodparam>
@@ -15,10 +15,47 @@
</methodsynopsis>
<para>
The <function>dgettext</function> function allows you to override
- the current domain for a single message lookup.
+ the current <parameter>domain</parameter> for a single message lookup.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>domain</parameter></term>
+ <listitem>
+ <para>
+ The domain
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>message</parameter></term>
+ <listitem>
+ <para>
+ The message
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ A <type>string</type> on success.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also <function>gettext</function>.
+ <simplelist>
+ <member><function>gettext</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/gettext/functions/dngettext.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/gettext/functions/dngettext.xml
diff -u phpdoc/en/reference/gettext/functions/dngettext.xml:1.4
phpdoc/en/reference/gettext/functions/dngettext.xml:1.5
--- phpdoc/en/reference/gettext/functions/dngettext.xml:1.4 Mon Jan 15
02:06:20 2007
+++ phpdoc/en/reference/gettext/functions/dngettext.xml Mon Jan 15 06:50:03 2007
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/gettext.xml, last change in rev 1.16 -->
+<!-- $Revision: 1.5 $ -->
<refentry id='function.dngettext'>
<refnamediv>
<refname>dngettext</refname>
<refpurpose>Plural version of dgettext</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>dngettext</methodname>
<methodparam><type>string</type><parameter>domain</parameter></methodparam>
@@ -17,10 +17,60 @@
</methodsynopsis>
<para>
The <function>dngettext</function> function allows you to override
- the current domain for a single plural message lookup.
+ the current <parameter>domain</parameter> for a single plural message
lookup.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>domain</parameter></term>
+ <listitem>
+ <para>
+ The domain
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>msgid1</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>msgid2</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>n</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ A <type>string</type> on success.
+ </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also <function>ngettext</function>.
+ <simplelist>
+ <member><function>ngettext</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/gettext/functions/gettext.xml?r1=1.9&r2=1.10&diff_format=u
Index: phpdoc/en/reference/gettext/functions/gettext.xml
diff -u phpdoc/en/reference/gettext/functions/gettext.xml:1.9
phpdoc/en/reference/gettext/functions/gettext.xml:1.10
--- phpdoc/en/reference/gettext/functions/gettext.xml:1.9 Mon Jan 15
02:06:20 2007
+++ phpdoc/en/reference/gettext/functions/gettext.xml Mon Jan 15 06:50:03 2007
@@ -1,25 +1,51 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.9 $ -->
-<!-- splitted from ./en/functions/gettext.xml, last change in rev 1.2 -->
+<!-- $Revision: 1.10 $ -->
<refentry id="function.gettext">
<refnamediv>
<refname>gettext</refname>
<refpurpose>Lookup a message in the current domain</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>gettext</methodname>
<methodparam><type>string</type><parameter>message</parameter></methodparam>
</methodsynopsis>
<para>
- This function returns a translated string if one is found in the
- translation table, or the submitted message if not found. You may
- use the underscore character '_' as an alias to this function.
+ Looks up a message in the current domain.
</para>
- <example>
- <title><function>gettext</function>-check</title>
- <programlisting role="php">
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>message</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns a translated <type>string</type> if one is found in the
+ translation table, or the submitted message if not found.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
+ <para>
+ <example>
+ <title><function>gettext</function>-check</title>
+ <programlisting role="php">
<![CDATA[
<?php
// Set language to German
@@ -40,11 +66,26 @@
echo _("Have a nice day");
?>
]]>
- </programlisting>
- </example>
+ </programlisting>
+ </example>
+ </para>
+ </refsect1>
+
+ <refsect1 role="notes">
+ &reftitle.notes;
+ <note>
+ <para>
+ You may use the underscore character '_' as an alias to this function.
+ </para>
+ </note>
+ </refsect1>
+
+ <refsect1 role="seealso">
+ &reftitle.seealso;
<para>
- See also
- <function>setlocale</function>.
+ <simplelist>
+ <member><function>setlocale</function></member>
+ </simplelist>
</para>
</refsect1>
</refentry>
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/gettext/functions/ngettext.xml?r1=1.4&r2=1.5&diff_format=u
Index: phpdoc/en/reference/gettext/functions/ngettext.xml
diff -u phpdoc/en/reference/gettext/functions/ngettext.xml:1.4
phpdoc/en/reference/gettext/functions/ngettext.xml:1.5
--- phpdoc/en/reference/gettext/functions/ngettext.xml:1.4 Mon Jan 15
02:06:20 2007
+++ phpdoc/en/reference/gettext/functions/ngettext.xml Mon Jan 15 06:50:03 2007
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.4 $ -->
-<!-- splitted from ./en/functions/gettext.xml, last change in rev 1.16 -->
+<!-- $Revision: 1.5 $ -->
<refentry id="function.ngettext">
<refnamediv>
<refname>ngettext</refname>
<refpurpose>Plural version of gettext</refpurpose>
</refnamediv>
- <refsect1>
- <title>Description</title>
+
+ <refsect1 role="description">
+ &reftitle.description;
<methodsynopsis>
<type>string</type><methodname>ngettext</methodname>
<methodparam><type>string</type><parameter>msgid1</parameter></methodparam>
@@ -15,11 +15,51 @@
<methodparam><type>int</type><parameter>n</parameter></methodparam>
</methodsynopsis>
<para>
- <function>ngettext</function> returns correct plural form of message
- identified by <parameter>msgid1</parameter> and
<parameter>msgid2</parameter>
- for count <parameter>n</parameter>. Some languages have more than one form
- for plural messages dependent on the count.
+ The plural version of <function>gettext</function>. Some languages
+ have more than one form for plural messages dependent on the count.
</para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+ &reftitle.parameters;
+ <para>
+ <variablelist>
+ <varlistentry>
+ <term><parameter>msgid1</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>msgid2</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><parameter>n</parameter></term>
+ <listitem>
+ <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </para>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+ &reftitle.returnvalues;
+ <para>
+ Returns correct plural form of message identified by
+ <parameter>msgid1</parameter> and <parameter>msgid2</parameter>
+ for count <parameter>n</parameter>.
+ </para>
+ </refsect1>
+
+ <refsect1 role="examples">
+ &reftitle.examples;
<para>
<example>
<title><function>ngettext</function> example</title>
