Wiki source code of Encoding

Version 23.1 by Thomas Mortagne on 2020/03/11

version	line-number	content
13.1	1	{{box cssClass="floatinginfobox" title="Contents"}}
	2	{{toc/}}
	3	{{/box}}
1.1	4
15.2	5	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.
1.1	6
12.2	7	= XWiki encoding =
1.1	8
20.1	9	Change the charset encoding in these XWiki files:
1.8	10
17.1	11	* web.xml: locate the filter class ##org.xwiki.container.servlet.filters.internal.SetCharacterEncodingFilter## and change it to UTF-8. It should look like this:(((
12.1	12	{{code language="xml"}}
1.10	13	<filter>
1.9	14	<filter-name>Set Character Encoding</filter-name>
17.1	15	<filter-class>org.xwiki.container.servlet.filters.internal.SetCharacterEncodingFilter</filter-class>
1.9	16	<init-param>
	17	<param-name>encoding</param-name>
	18	<param-value>UTF-8</param-value>
	19	</init-param>
1.10	20	</filter>
12.1	21	{{/code}}
15.2	22	)))
16.1	23	* xwiki.cfg : locate the line containing ##xwiki.encoding## and change it to look like this:(((
12.1	24	{{code}}
1.9	25	xwiki.encoding = UTF-8
12.1	26	{{/code}}
15.2	27	)))
1.9	28
12.2	29	= HTML encoding =
1.9	30
16.1	31	Change the HTML encoding in XWiki through Administration ~-~-> Look & Feel ~-~-> Page Elements ~-~-> HTTP Meta Info.
11.1	32
12.1	33	{{warning}}
16.1	34	The HTTP Meta Info section was located in Administration ~--> Presentation in older versions of XWiki.
12.1	35	{{/warning}}
11.1	36
12.1	37	Inside this textbox locate the Content-type meta tag and make it look like this, changing the encoding to UTF-8
	38
	39	{{code language="xml"}}
1.14	40	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
12.1	41	{{/code}}
	42
	43	{{warning}}
	44	This step is not needed if you have the following. Instead that line can be left alone.
	45	{{/warning}}
	46
	47	{{code language="xml"}}
11.1	48	<meta http-equiv="Content-Type" content="text/html; charset=$!xwiki.encoding" />
12.1	49	{{/code}}
1.10	50
12.2	51	= Servlet Container =
1.1	52
12.2	53	== Jetty ==
12.1	54
16.1	55	{{code}}
	56	echo off
1.1	57	rem set LANG=fr_FR.ISO8859-1
	58	set LANG=en_US.UTF-8
	59	set JETTY_PORT=8080
	60	set JETTY_HOME=.
15.2	61	java %JAVA_OPTS% -Djetty.port=%JETTY_PORT% -Djetty.home=%JETTY_HOME% -Dfile.encoding=UTF-8 -jar %JETTY_HOME%/start.jar
	62	{{/code}}
1.4	63
15.2	64	Instead of the config system variable LANG you can use JVM properties.
	65
12.1	66	{{code}}
1.4	67	-Duser.language=en
	68	-Duser.country=US
12.1	69	{{/code}}
1.4	70
	71	in server startup script.
	72
12.2	73	== Tomcat ==
3.1	74
	75	In order to enable UTF-8 in tomcat, you have to add
	76
12.1	77	{{code}}
6.1	78	URIEncoding="UTF-8"
12.1	79	{{/code}}
3.1	80
15.2	81	to each connector enabled/used in ##conf/server.xml##. For example the non-SSL HTTP Connector should read:
3.1	82
12.1	83	{{code language="xml"}}
3.1	84	<Connector port="8080" maxHttpHeaderSize="8192"
	85	maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
	86	enableLookups="false" redirectPort="8443" acceptCount="100"
	87	connectionTimeout="20000" disableUploadTimeout="true"
6.1	88	URIEncoding="UTF-8"/>
12.1	89	{{/code}}
3.1	90
12.1	91	{{warning}}
	92	In case you're using AJP to connect Tomcat and httpd, make sure you add this attribute to the AJP connector.
	93	{{/warning}}
9.1	94
15.2	95	== [[Glassfish>>http://glassfish.java.net/]] ==
9.1	96
19.5	97	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.
9.1	98
15.2	99	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.
12.1	100
15.2	101	Create a new directory that we will use as a temporary place to edit our war file:
12.1	102
	103	{{code}}
	104	mkdir xwikitmp
	105	{{/code}}
	106
19.6	107	Unpack the warfile (replace ##<suffix>## with the proper name for the version of XWiki you're using):
12.1	108
	109	{{code}}
19.6	110	cd xwikitemp;jar xvf ../xwiki-<suffix>.war
12.1	111	{{/code}}
	112
9.1	113	Edit the files as mentioned in the beginning of this article:
12.1	114
9.1	115	* wiki.cfg
	116	* web.xml
	117	* hibernate.cfg.xml
12.1	118
15.2	119	Now let's create a new warfile which contains all the changes:
9.1	120
12.1	121	{{code}}
19.7	122	jar cvf ../xwiki-<suffix>.war .
12.1	123	{{/code}}
	124
9.1	125	Now you can deploy your new .war file to Glassfish and it will have all the changes in it and wll be correctly deployed.
	126
20.1	127	= Web server =
	128
	129	== Apache ==
	130
	131	Make sure that the Apache configuration file ##httpd.conf## contains the following line:
	132
	133	{{code}}
	134	AddDefaultCharset UTF-8
	135	{{/code}}
	136
12.2	137	= System config =
9.1	138
15.2	139	Add the following variables to your system:
1.1	140
12.1	141	{{code}}
2.1	142	LANG = en_US.UTF-8
12.1	143	{{/code}}
1.1	144
15.2	145	[[Credits>>http://markmail.org/message/qitvntzz7cwpyo2w]]
15.1	146
	147	= OpenOffice import =
	148
15.2	149	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:
15.1	150
	151	{{code}}
	152	<item
	153	oor:path="/org.openoffice.Office.Common/Filter/HTML/Export"><prop
	154	oor:name="Encoding" oor:op="fuse"><value>76</value></prop></item>
	155	{{/code}}
	156
15.2	157	[[Credits>>http://lists.xwiki.org/pipermail/users/2011-November/021004.html]]
20.1	158
	159	= Tools =
	160
	161	* The [[Admin Tools extension>>extensions:Extension.Admin Tools Application]] can be helpful to identify the values of the XWiki encoding configuration parameters on a running server.

Wiki source code of Encoding

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