4126704c4950bfd46d32ad54e3b106ac6d868a73sf<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
fd9abdda70912b99b24e3bf1a38f26fde908a74cnd<meta content="text/html; charset=ISO-8859-1" http-equiv="Content-Type" />
4126704c4950bfd46d32ad54e3b106ac6d868a73sf XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
4126704c4950bfd46d32ad54e3b106ac6d868a73sf This file is generated from xml source: DO NOT EDIT
4126704c4950bfd46d32ad54e3b106ac6d868a73sf XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
96ad5d81ee4a2cc66a4ae19893efc8aa6d06fae7jailletc<title>mod_xml2enc - Apache HTTP Server Version 2.5</title>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<link href="/style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<link href="/style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
d29d9ab4614ff992b0e8de6e2b88d52b6f1f153erbowen<link href="/style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="/style/css/prettify.css" />
2e545ce2450a9953665f701bb05350f0d3f26275nd<script src="/style/scripts/prettify.min.js" type="text/javascript">
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<link href="/images/favicon.ico" rel="shortcut icon" /></head>
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<div class="up"><a href="./"><img title="<-" alt="<-" src="/images/left.gif" /></a></div>
3f08db06526d6901aa08c110b5bc7dde6bc39905nd<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<p><span>Available Languages: </span><a href="/en/mod/mod_xml2enc.html" title="English"> en </a></p>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Enhanced charset/internationalisation support for libxml2-based
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>xml2enc_module</td></tr>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_xml2enc.c</td></tr>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4 and later. Available as a third-party module
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <p>This module provides enhanced internationalisation support for
4126704c4950bfd46d32ad54e3b106ac6d868a73sf markup-aware filter modules such as <code class="module"><a href="/mod/mod_proxy_html.html">mod_proxy_html</a></code>.
4126704c4950bfd46d32ad54e3b106ac6d868a73sf It can automatically detect the encoding of input data and ensure
4126704c4950bfd46d32ad54e3b106ac6d868a73sf they are correctly processed by the <a href="http://xmlsoft.org/">libxml2</a> parser, including converting to Unicode (UTF-8) where
4126704c4950bfd46d32ad54e3b106ac6d868a73sf necessary. It can also convert data to an encoding of choice
4126704c4950bfd46d32ad54e3b106ac6d868a73sf after markup processing, and will ensure the correct <var>charset</var>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf value is set in the HTTP <var>Content-Type</var> header.</p>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<li><img alt="" src="/images/down.gif" /> <a href="#usage">Usage</a></li>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<li><img alt="" src="/images/down.gif" /> <a href="#api">Programming API</a></li>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<li><img alt="" src="/images/down.gif" /> <a href="#sniffing">Detecting an Encoding</a></li>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<li><img alt="" src="/images/down.gif" /> <a href="#output">Output Encoding</a></li>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<li><img alt="" src="/images/down.gif" /> <a href="#alias">Unsupported Encodings</a></li>
c44eeebd065e2c8cd028016b45c58afb480aaf8fdruggeri<li><img alt="" src="/images/down.gif" /> <a href="#xml2encalias">xml2EncAlias</a></li>
c44eeebd065e2c8cd028016b45c58afb480aaf8fdruggeri<li><img alt="" src="/images/down.gif" /> <a href="#xml2encdefault">xml2EncDefault</a></li>
c44eeebd065e2c8cd028016b45c58afb480aaf8fdruggeri<li><img alt="" src="/images/down.gif" /> <a href="#xml2startparse">xml2StartParse</a></li>
c44eeebd065e2c8cd028016b45c58afb480aaf8fdruggeri<ul class="seealso"><li><a href="#comments_section">Comments</a></li></ul></div>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <p>There are two usage scenarios: with modules programmed to work
4126704c4950bfd46d32ad54e3b106ac6d868a73sf with mod_xml2enc, and with those that are not aware of it:</p>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <p>Modules such as <code class="module"><a href="/mod/mod_proxy_html.html">mod_proxy_html</a></code> version 3.1
4126704c4950bfd46d32ad54e3b106ac6d868a73sf and up use the <code>xml2enc_charset</code> optional function to retrieve
4126704c4950bfd46d32ad54e3b106ac6d868a73sf the charset argument to pass to the libxml2 parser, and may use the
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <code>xml2enc_filter</code> optional function to postprocess to another
4126704c4950bfd46d32ad54e3b106ac6d868a73sf encoding. Using mod_xml2enc with an enabled module, no configuration
4126704c4950bfd46d32ad54e3b106ac6d868a73sf is necessary: the other module will configure mod_xml2enc for you
4126704c4950bfd46d32ad54e3b106ac6d868a73sf (though you may still want to customise it using the configuration
4126704c4950bfd46d32ad54e3b106ac6d868a73sf directives below).</p>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <p>To use it with a libxml2-based module that isn't explicitly enabled for
4126704c4950bfd46d32ad54e3b106ac6d868a73sf mod_xml2enc, you will have to configure the filter chain yourself.
4126704c4950bfd46d32ad54e3b106ac6d868a73sf So to use it with a filter foo provided by a module mod_foo to
4126704c4950bfd46d32ad54e3b106ac6d868a73sf improve the latter's i18n support with HTML and XML, you could use</p>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf FilterProvider iconv xml2enc Content-Type $xml
4126704c4950bfd46d32ad54e3b106ac6d868a73sf FilterProvider markup foo Content-Type $xml
4126704c4950bfd46d32ad54e3b106ac6d868a73sf FilterChain iconv markup
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <p>mod_foo will now support any character set supported by either
4126704c4950bfd46d32ad54e3b106ac6d868a73sf</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <p>Programmers writing libxml2-based filter modules are encouraged to
4126704c4950bfd46d32ad54e3b106ac6d868a73sf enable them for mod_xml2enc, to provide strong i18n support for your
4126704c4950bfd46d32ad54e3b106ac6d868a73sf users without reinventing the wheel. The programming API is exposed in
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <code class="module"><a href="/mod/mod_proxy_html.html">mod_proxy_html</a></code>.</p>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<h2><a name="sniffing" id="sniffing">Detecting an Encoding</a></h2>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <p>Unlike <code class="module"><a href="/mod/mod_charset_lite.html">mod_charset_lite</a></code>, mod_xml2enc is designed
4126704c4950bfd46d32ad54e3b106ac6d868a73sf to work with data whose encoding cannot be known in advance and thus
4126704c4950bfd46d32ad54e3b106ac6d868a73sf configured. It therefore uses 'sniffing' techniques to detect the
4126704c4950bfd46d32ad54e3b106ac6d868a73sf encoding of HTTP data as follows:</p>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <li>If the HTTP <var>Content-Type</var> header includes a
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <li>If the data start with an XML Byte Order Mark (BOM) or an
4126704c4950bfd46d32ad54e3b106ac6d868a73sf XML encoding declaration, that is used.</li>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <li>If an encoding is declared in an HTML <code><META></code>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf element, that is used.</li>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <li>If none of the above match, the default value set by
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <code class="directive">xml2EncDefault</code> is used.</li>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf <p>The rules are applied in order. As soon as a match is found,
4126704c4950bfd46d32ad54e3b106ac6d868a73sf it is used and detection is stopped.</p>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<p><a href="http://xmlsoft.org/">libxml2</a> always uses UTF-8 (Unicode)
4126704c4950bfd46d32ad54e3b106ac6d868a73sfinternally, and libxml2-based filter modules will output that by default.
4126704c4950bfd46d32ad54e3b106ac6d868a73sfmod_xml2enc can change the output encoding through the API, but there
4126704c4950bfd46d32ad54e3b106ac6d868a73sfis currently no way to configure that directly.</p>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<p>Changing the output encoding should (in theory, at least) never be
4126704c4950bfd46d32ad54e3b106ac6d868a73sfnecessary, and is not recommended due to the extra processing load on
4126704c4950bfd46d32ad54e3b106ac6d868a73sfthe server of an unnecessary conversion.</p>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf</div><div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<h2><a name="alias" id="alias">Unsupported Encodings</a></h2>
4126704c4950bfd46d32ad54e3b106ac6d868a73sf<p>If you are working with encodings that are not supported by any of
4126704c4950bfd46d32ad54e3b106ac6d868a73sfthe conversion methods available on your platform, you can still alias
4126704c4950bfd46d32ad54e3b106ac6d868a73sfthem to a supported encoding using <code class="directive">xml2EncAlias</code>.</p>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<div class="directive-section"><h2><a name="xml2EncAlias" id="xml2EncAlias">xml2EncAlias</a> <a name="xml2encalias" id="xml2encalias">Directive</a></h2>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Recognise Aliases for encoding values</td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>xml2EncAlias <var>charset alias [alias ...]</var></code></td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_xml2enc</td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <p>This server-wide directive aliases one or more encoding to another
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar encoding. This enables encodings not recognised by libxml2 to be handled
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar internally by libxml2's encoding support using the translation table for
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar a recognised encoding. This serves two purposes: to support character sets
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar (or names) not recognised either by libxml2 or iconv, and to skip
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar conversion for an encoding where it is known to be unnecessary.</p>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<div class="directive-section"><h2><a name="xml2EncDefault" id="xml2EncDefault">xml2EncDefault</a> <a name="xml2encdefault" id="xml2encdefault">Directive</a></h2>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets a default encoding to assume when absolutely no information
1f1b6bf13313fdd14a45e52e553d3ff28689b717coarcan be <a href="#sniffing">automatically detected</a></td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>xml2EncDefault <var>name</var></code></td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_xml2enc</td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Version 2.4.0 and later; available as a third-party
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <p>If you are processing data with known encoding but no encoding
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar information, you can set this default to help mod_xml2enc process
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar the data correctly. For example, to work with the default value
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar of Latin1 (<var>iso-8859-1</var> specified in HTTP/1.0, use</p>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <pre class="prettyprint lang-config">xml2EncDefault iso-8859-1</pre>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<div class="top"><a href="#page-header"><img alt="top" src="/images/up.gif" /></a></div>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<div class="directive-section"><h2><a name="xml2StartParse" id="xml2StartParse">xml2StartParse</a> <a name="xml2startparse" id="xml2startparse">Directive</a></h2>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Advise the parser to skip leading junk.</td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>xml2StartParse <var>element [element ...]</var></code></td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host, directory, .htaccess</td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_xml2enc</td></tr>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <p>Specify that the markup parser should start at the first instance
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar of any of the elements specified. This can be used as a workaround
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar where a broken backend inserts leading junk that messes up the parser (<a href="http://bahumbug.wordpress.com/2006/10/12/mod_proxy_html-revisited/">example here</a>).</p>
1f1b6bf13313fdd14a45e52e553d3ff28689b717coar <p>It should never be used for XML, nor well-formed HTML.</p>
f086b4b402fa9a2fefc7dda85de2a3cc1cd0a654rjung<p><span>Available Languages: </span><a href="/en/mod/mod_xml2enc.html" title="English"> en </a></p>
727872d18412fc021f03969b8641810d8896820bhumbedooh</div><div class="top"><a href="#page-header"><img src="/images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed again by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Freenode, or sent to our <a href="http://httpd.apache.org/lists.html">mailing lists</a>.</div>
727872d18412fc021f03969b8641810d8896820bhumbedoohvar comments_shortname = 'httpd';
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedoohvar comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_xml2enc.html';
0d0ba3a410038e179b695446bb149cce6264e0abnd(function(w, d) {
cc7e1025de9ac63bd4db6fe7f71c158b2cf09fe4humbedooh if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
727872d18412fc021f03969b8641810d8896820bhumbedooh d.write('<div id="comments_thread"><\/div>');
0d0ba3a410038e179b695446bb149cce6264e0abnd var s = d.createElement('script');
ac082aefa89416cbdc9a1836eaf3bed9698201c8humbedooh s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
0d0ba3a410038e179b695446bb149cce6264e0abnd (d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
727872d18412fc021f03969b8641810d8896820bhumbedooh d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
0d0ba3a410038e179b695446bb149cce6264e0abnd})(window, document);
205f749042ed530040a4f0080dbcb47ceae8a374rjung<p class="apache">Copyright 2015 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
af33a4994ae2ff15bc67d19ff1a7feb906745bf8rbowen<p class="menu"><a href="/mod/">Modules</a> | <a href="/mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="/glossary.html">Glossary</a> | <a href="/sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
0d0ba3a410038e179b695446bb149cce6264e0abndif (typeof(prettyPrint) !== 'undefined') {
7fec19672a491661b2fe4b29f685bc7f4efa64d4nd prettyPrint();