Wiki source code of XWiki Character Encoding Configuration

Version 13.1 by Guillaume Fenollar on 2011/01/18

version	line-number	content
13.1	1	{{box cssClass="floatinginfobox" title="Contents"}}
	2	{{toc/}}
	3	{{/box}}
1.1	4
1.2	5	Here is below 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.
1.1	6
12.2	7	= XWiki encoding =
1.1	8
1.8	9	Change the charset enconding in these XWiki files :
	10
12.1	11	* web.xml: locate the filter class com.xpn.xwiki.web.SetCharacterEncodingFilter and change it to UTF-8. It should look like this
1.1	12
12.1	13	{{code language="xml"}}
1.10	14	<filter>
1.9	15	<filter-name>Set Character Encoding</filter-name>
	16	<filter-class>com.xpn.xwiki.web.SetCharacterEncodingFilter</filter-class>
	17	<init-param>
	18	<param-name>encoding</param-name>
	19	<param-value>UTF-8</param-value>
	20	</init-param>
1.10	21	</filter>
12.1	22	{{/code}}
1.8	23
12.1	24	* xwiki.cfg : locate the line containing xwiki.encoding and change it to look like this
	25
	26	{{code}}
1.9	27	xwiki.encoding = UTF-8
12.1	28	{{/code}}
1.9	29
12.2	30	= HTML encoding =
1.9	31
12.1	32	Change the HTML encoding in XWiki through Administration ~-~-> Preferences ~-~-> Presentation ~-~-> HTTP Meta information.
11.1	33
12.1	34	{{warning}}
	35	This is Administration ~--> Presentation then look for Header ~--> HTTP Meta Information in more recent XWiki default wikis
	36	{{/warning}}
11.1	37
12.1	38	Inside this textbox locate the Content-type meta tag and make it look like this, changing the encoding to UTF-8
	39
	40	{{code language="xml"}}
1.14	41	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
12.1	42	{{/code}}
	43
	44	{{warning}}
	45	This step is not needed if you have the following. Instead that line can be left alone.
	46	{{/warning}}
	47
	48	{{code language="xml"}}
11.1	49	<meta http-equiv="Content-Type" content="text/html; charset=$!xwiki.encoding" />
12.1	50	{{/code}}
1.10	51
12.2	52	= Hibernate configuration =
1.15	53
12.1	54	Add the following lines in the ##hibernate.cfg.xml## file:
	55
	56	{{code language="xml"}}
1.6	57	<property name="connection.useUnicode">true</property>
	58	<property name="connection.characterEncoding">UTF-8</property>
12.1	59	{{/code}}
1.6	60
12.2	61	= MySQL configuration =
1.1	62
12.1	63	It's common practice that the MySQL configuration file, in *nix systems is located in /etc/mysql/my.cnf
	64
	65	{{code}}
1.1	66	[client]
	67	default-character-set=utf8
	68	[mysqld]
	69	default-character-set=utf8
	70	character-set-server = utf8
13.1	71	collation-server = utf8_bin
12.1	72	{{/code}}
1.1	73
12.2	74	= Servlet Container =
1.1	75
12.2	76	== Jetty ==
12.1	77
	78	{{code}}echo off
1.1	79	rem set LANG=fr_FR.ISO8859-1
	80	set LANG=en_US.UTF-8
	81	set JETTY_PORT=8080
	82	set JETTY_HOME=.
12.1	83	java %JAVA_OPTS% -Djetty.port=%JETTY_PORT% -Djetty.home=%JETTY_HOME% -Dfile.encoding=UTF-8 -jar %JETTY_HOME%/start.jar{{/code}}
1.4	84	Instead of config system variable LANG you can use JVM properties
	85
12.1	86	{{code}}
1.4	87	-Duser.language=en
	88	-Duser.country=US
12.1	89	{{/code}}
1.4	90
	91	in server startup script.
	92
12.2	93	== Tomcat ==
3.1	94
	95	In order to enable UTF-8 in tomcat, you have to add
	96
12.1	97	{{code}}
6.1	98	URIEncoding="UTF-8"
12.1	99	{{/code}}
3.1	100
12.1	101	to each connector enabled/used in conf/server.xml. For example the non-SSL HTTP Connector should read:
3.1	102
12.1	103	{{code language="xml"}}
3.1	104	<Connector port="8080" maxHttpHeaderSize="8192"
	105	maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
	106	enableLookups="false" redirectPort="8443" acceptCount="100"
	107	connectionTimeout="20000" disableUploadTimeout="true"
6.1	108	URIEncoding="UTF-8"/>
12.1	109	{{/code}}
3.1	110
12.1	111	{{warning}}
	112	In case you're using AJP to connect Tomcat and httpd, make sure you add this attribute to the AJP connector.
	113	{{/warning}}
9.1	114
12.2	115	== [[Glassfish>>http://www.glassfish.org/]] ==
9.1	116
12.1	117	To run xwiki with UTF-8 in Glassfish you will need to recreate the xwiki-enterprise.war file and do a change to the glassfish config. First, in the Administration GUI under Domain => General => Locale enter en_US.UTF-8.
9.1	118
12.1	119	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 you glassfish installations. 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 becuase all subsequent changes to the deployed web.xml file in the filesystem are totally ignored.
	120
9.1	121	Create a new directory that we will use as a temporary place to edit our war file
12.1	122
	123	{{code}}
	124	mkdir xwikitmp
	125	{{/code}}
	126
9.1	127	Unpack the warfile:
12.1	128
	129	{{code}}
	130	cd xwikitemp;jar xvf ../xwiki-enterprise-web-1.5.war
	131	{{/code}}
	132
9.1	133	Edit the files as mentioned in the beginning of this article:
12.1	134
9.1	135	* wiki.cfg
	136	* web.xml
	137	* hibernate.cfg.xml
12.1	138
9.1	139	Now lets create a new warfile which contains all the changes:
	140
12.1	141	{{code}}
	142	jar cvf ../xwiki-enterprise-web-local-1.5.war .
	143	{{/code}}
	144
9.1	145	Now you can deploy your new .war file to Glassfish and it will have all the changes in it and wll be correctly deployed.
	146
12.2	147	= System config =
9.1	148
1.1	149	Add the following variables to your system
	150
12.1	151	{{code}}
2.1	152	LANG = en_US.UTF-8
12.1	153	{{/code}}
1.1	154
	155	Credits: http://www.nabble.com/Re%3A-problem-with-Chinese-p9547507.html

Wiki source code of XWiki Character Encoding Configuration

Quick Links

Navigation

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected