Encoding
Below you have the configuration for UTF-8. Note that this is valid for XWiki 1.0 b5 and above. Easier configuration might be provided for upcoming releases.
XWiki encoding
Change the charset encoding in these XWiki files:
- web.xml: locate the filter class org.xwiki.container.servlet.filters.internal.SetCharacterEncodingFilter and change it to UTF-8. It should look like this:<filter>
<filter-name>Set Character Encoding</filter-name>
<filter-class>org.xwiki.container.servlet.filters.internal.SetCharacterEncodingFilter</filter-class>
<init-param>
<param-name>encoding</param-name>
<param-value>UTF-8</param-value>
</init-param>
</filter> - xwiki.cfg : locate the line containing xwiki.encoding and change it to look like this:xwiki.encoding = UTF-8
HTML encoding
Change the HTML encoding in XWiki through Administration --> Look & Feel --> Page Elements --> HTTP Meta Info.
Inside this textbox locate the Content-type meta tag and make it look like this, changing the encoding to UTF-8
Servlet Container
Jetty
rem set LANG=fr_FR.ISO8859-1
set LANG=en_US.UTF-8
set JETTY_PORT=8080
set JETTY_HOME=.
java %JAVA_OPTS% -Djetty.port=%JETTY_PORT% -Djetty.home=%JETTY_HOME% -Dfile.encoding=UTF-8 -jar %JETTY_HOME%/start.jar
Instead of the config system variable LANG you can use JVM properties.
-Duser.country=US
in server startup script.
Tomcat
In order to enable UTF-8 in tomcat, you have to add
to each connector enabled/used in conf/server.xml. For example the non-SSL HTTP Connector should read:
maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
enableLookups="false" redirectPort="8443" acceptCount="100"
connectionTimeout="20000" disableUploadTimeout="true"
URIEncoding="UTF-8"/>
Glassfish
To run XWiki with UTF-8 in Glassfish you will need to recreate the XWiki WAR file and do a change to the glassfish config. First, in the Administration GUI under Domain => General => Locale enter en_US.UTF-8.
Now you will need to add all the aforementioned changes from this document to the files in the war file, create a new warfile, and deploy that one to your glassfish installation. This is required due to the fact that Glassfish will not accept changes to a deployed web.xml file. So you need to deploy a ready changed web.xml file inside your war file because all subsequent changes to the deployed web.xml file in the filesystem are totally ignored.
Create a new directory that we will use as a temporary place to edit our war file:
Unpack the warfile (replace <suffix> with the proper name for the version of XWiki you're using):
Edit the files as mentioned in the beginning of this article:
- wiki.cfg
- web.xml
- hibernate.cfg.xml
Now let's create a new warfile which contains all the changes:
Now you can deploy your new .war file to Glassfish and it will have all the changes in it and wll be correctly deployed.
Web server
Apache
Make sure that the Apache configuration file httpd.conf contains the following line:
System config
Add the following variables to your system:
OpenOffice import
If OpenOffice import turns characters into question marks or HTML Entity you need to edit registrymodifications.xcu located in user profile used by the OO server by adding:
oor:path="/org.openoffice.Office.Common/Filter/HTML/Export"><prop
oor:name="Encoding" oor:op="fuse"><value>76</value></prop></item>
Tools
- The Admin Tools extension can be helpful to identify the values of the XWiki encoding configuration parameters on a running server.