mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 14:28:56 +00:00
06d026fec8
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@189156 c90b9560-bf6c-de11-be94-00142212c4b1
88 lines
2.4 KiB
XML
88 lines
2.4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.2 $ -->
|
|
<!-- splitted from ./en/functions/ps.xml, last change in rev 1.12 -->
|
|
<refentry id="function.ps-hyphenate">
|
|
<refnamediv>
|
|
<refname>ps_hyphenate</refname>
|
|
<refpurpose>Hyphenates a word</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>array</type><methodname>ps_hyphenate</methodname>
|
|
<methodparam><type>resource</type><parameter>psdoc</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>text</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
Hyphenates the passed word. <function>ps_hyphenate</function> evaluates the
|
|
value hyphenminchars and the parameter hyphendict. hyphendict must be set
|
|
before calling this function.
|
|
</para>
|
|
<para>
|
|
This function requires the locale category LC_CTYPE to be set properly.
|
|
This is done when the extension is initialized by using the environment
|
|
variables. On Unix systems read the man page of locale.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>psdoc</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>text</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>text</parameter> should not contain any non alpha
|
|
characters. Possible positions for breaks are returned in an array of
|
|
interger numbers. Each number is the position of the char in
|
|
<parameter>text</parameter> after which a hyphenation can take place.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<!-- <member><function>ps_boot</function></member> -->
|
|
<member><function>ps_show_boxed</function></member>
|
|
<member>locale(1)</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
|
|
-->
|
|
|