Adding rough cut of the gettext functions.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@21801 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Leon Atkinson 2000-03-20 19:12:48 +00:00
parent d93ca78296
commit a44484fe1a

131
functions/gettext.xml Normal file
View file

@ -0,0 +1,131 @@
<reference id="ref.gettext">
<title>GNU Gettext</title>
<titleabbrev>gettext</titleabbrev>
<refentry id="function.bindtextdomain">
<refnamediv>
<refname>textdomain</refname>
<refpurpose>sets the path for a domain</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>string <function>bindtextdomain</function></funcdef>
<paramdef>string <parameter>domain</parameter></paramdef>
<paramdef>string <parameter>directory</parameter></paramdef>
</funcsynopsis>
<para>
The bintextdomain function sets the path for a domain.
</para>
</refsect1>
</refentry>
<refentry id="function.dcgettext">
<refnamediv>
<refname>dcgettext</refname>
<refpurpose>overrides the domain for a single lookup</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>string <function>dcgettext</function></funcdef>
<paramdef>string <parameter>domain</parameter></paramdef>
<paramdef>string <parameter>message</parameter></paramdef>
<paramdef>int <parameter>category</parameter></paramdef>
</funcsynopsis>
<para>
This function allows you to override the current domain for a single
message lookup. It also allows you to specify a category.
</para>
</refsect1>
</refentry>
<refentry id="function.dgettext">
<refnamediv>
<refname>dgettext</refname>
<refpurpose>override the current domain</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>string <function>dgettext</function></funcdef>
<paramdef>string <parameter>domain</parameter></paramdef>
<paramdef>string <parameter>message</parameter></paramdef>
</funcsynopsis>
<para>
The dgettext function allows you to override the current domain for
a single message lookup.
</para>
</refsect1>
</refentry>
<refentry id="function.gettext">
<refnamediv>
<refname>gettext</refname>
<refpurpose>lookup a message in the current domain</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>string <function>gettext</function></funcdef>
<paramdef>string <parameter>message</parameter></paramdef>
</funcsynopsis>
<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 an underscore character as an alias to this function.
</para>
<example>
<title><function>gettext-check</function></title>
<programlisting>
<?php
//set language to German
putenv("LANG=de");
//specify location of translation tables
bindtextdomain("myPHPApp", "./locale");
//choose domain
textdomain("myPHPApp");
//print a test message
print(gettext("Welcome to My PHP Application"));
?>
</programlisting>
</example>
</refsect1>
</refentry>
<refentry id="function.textdomain">
<refnamediv>
<refname>textdomain</refname>
<refpurpose>sets the default domain</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcdef>int <function>textdomain</function></funcdef>
<paramdef>string <parameter>library</parameter></paramdef>
</funcsynopsis>
<para>
This function sets the domain to search within when calls are made
to gettext, usually the named after an application. The previous
default domain is returned. Call it with no parameters to get the
current setting without changing it.
</para>
</refsect1>
</refentry>
</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
sgml-parent-document:nil
sgml-default-dtd-file:"../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->