php-doc-en/functions/gettext.xml
Egon Schmid c47c0e4d5b First attempt and no errors. Leon use XEmacs or emacs for
a better formatting.


git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@21803 c90b9560-bf6c-de11-be94-00142212c4b1
2000-03-20 21:29:36 +00:00

136 lines
4 KiB
XML

<reference id="ref.gettext">
<title>GNU Gettext</title>
<titleabbrev>gettext</titleabbrev>
<refentry id="function.bindtextdomain">
<refnamediv>
<refname>bindtextdomain</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 <function>bindtextdomain</function> 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 <function>dgettext</function> 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</function>-check</title>
<programlisting>
&lt;?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><optional>library</optional></parameter>
</paramdef>
</funcsynopsis>
<para>
This function sets the domain to search within when calls are
made to <function>gettext</function>, 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:
-->