php-doc-en/reference/tidy/functions/tidy-set-encoding.xml
2011-08-16 11:38:58 +00:00

70 lines
2 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.tidy-set-encoding" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>tidy_set_encoding</refname>
<refpurpose>Set the input/output character encoding for parsing markup</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>tidy_set_encoding</methodname>
<methodparam><type>string</type><parameter>encoding</parameter></methodparam>
</methodsynopsis>
<para>
Sets the encoding for input/output documents.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>encoding</parameter></term>
<listitem>
<para>
The <parameter>encoding</parameter> parameter sets the encoding for
input/output documents. The possible values for encoding are:
<literal>ascii</literal>, <literal>latin0</literal>, <literal>latin1</literal>,
<literal>raw</literal>, <literal>utf8</literal>, <literal>iso2022</literal>,
<literal>mac</literal>, <literal>win1252</literal>, <literal>ibm858</literal>,
<literal>utf16</literal>, <literal>utf16le</literal>, <literal>utf16be</literal>,
<literal>big5</literal>, and <literal>shiftjis</literal>.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="notes">
&reftitle.notes;
&note.tidy.1only;
</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:"~/.phpdoc/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
-->