<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.5 $ -->
<!-- splitted from ./en/functions/ircg.xml, last change in rev 1.1 -->
  <refentry id="function.ircg-html-encode">
   <refnamediv>
    <refname>ircg_html_encode</refname>
    <refpurpose>
     Encodes HTML preserving output
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>Description</title>
     <methodsynopsis>
      <type>bool</type><methodname>ircg_html_encode</methodname>
      <methodparam><type>string</type><parameter>html_string</parameter></methodparam>
      <methodparam choice="opt"><type>bool</type><parameter>auto_links</parameter></methodparam>
      <methodparam choice="opt"><type>bool</type><parameter>conv_br</parameter></methodparam>
     </methodsynopsis>
    <para>
     Encodes a HTML string <parameter>html_string</parameter> for
     output. This exposes the interface which the IRCG extension
     uses internally to reformat data coming from an IRC link.
     The function causes IRC color/font codes to be encoded in
     HTML and escapes certain entities.
    </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
-->