Skip to Content

Wiki source code of Encoding

Version 19.7 by Vincent Massol on 2017/09/18
Show last authors
1 {{box cssClass="floatinginfobox" title="**Contents**"}}
2 {{toc/}}
3 {{/box}}
4
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.
6
7 = XWiki encoding =
8
9 Change the charset enconding in these XWiki files:
10
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 {{code language="xml"}}
13 <filter>
14 <filter-name>Set Character Encoding</filter-name>
15 <filter-class>org.xwiki.container.servlet.filters.internal.SetCharacterEncodingFilter</filter-class>
16 <init-param>
17 <param-name>encoding</param-name>
18 <param-value>UTF-8</param-value>
19 </init-param>
20 </filter>
21 {{/code}}
22 )))
23 * **xwiki.cfg** : locate the line containing ##xwiki.encoding## and change it to look like this:(((
24 {{code}}
25 xwiki.encoding = UTF-8
26 {{/code}}
27 )))
28
29 = HTML encoding =
30
31 Change the HTML encoding in XWiki through Administration ~-~-> Look & Feel ~-~-> Page Elements ~-~-> HTTP Meta Info.
32
33 {{warning}}
34 The HTTP Meta Info section was located in Administration ~--> Presentation in older versions of XWiki.
35 {{/warning}}
36
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"}}
40 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
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"}}
48 <meta http-equiv="Content-Type" content="text/html; charset=$!xwiki.encoding" />
49 {{/code}}
50
51 = MySQL configuration =
52
53 It's common practice that the MySQL configuration file, in *nix systems is located in $$/etc/mysql/my.cnf##:##
54 Starting with MySQL 5.5.3 the option 'default-character-set=utf8' is deprecated under [mysql]
55
56 {{code}}
57 [client]
58 default-character-set=utf8
59 [mysqld]
60 default-character-set=utf8
61 character-set-server = utf8
62 collation-server = utf8_bin
63 {{/code}}
64
65 **After 5.5.3**
66
67 {{code}}
68 [client]
69 default-character-set=utf8
70 [mysqld]
71 character-set-server = utf8
72 collation-server = utf8_bin
73 {{/code}}
74
75
76
77 = Servlet Container =
78
79 == Jetty ==
80
81 {{code}}
82 echo off
83 rem set LANG=fr_FR.ISO8859-1
84 set LANG=en_US.UTF-8
85 set JETTY_PORT=8080
86 set JETTY_HOME=.
87 java %JAVA_OPTS% -Djetty.port=%JETTY_PORT% -Djetty.home=%JETTY_HOME% -Dfile.encoding=UTF-8 -jar %JETTY_HOME%/start.jar
88 {{/code}}
89
90 Instead of the config system variable LANG you can use JVM properties.
91
92 {{code}}
93 -Duser.language=en
94 -Duser.country=US
95 {{/code}}
96
97 in server startup script.
98
99 == Tomcat ==
100
101 In order to enable UTF-8 in tomcat, you have to add
102
103 {{code}}
104 URIEncoding="UTF-8"
105 {{/code}}
106
107 to each connector enabled/used in ##conf/server.xml##. For example the non-SSL HTTP Connector should read:
108
109 {{code language="xml"}}
110 <Connector port="8080" maxHttpHeaderSize="8192"
111 maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
112 enableLookups="false" redirectPort="8443" acceptCount="100"
113 connectionTimeout="20000" disableUploadTimeout="true"
114 URIEncoding="UTF-8"/>
115 {{/code}}
116
117 {{warning}}
118 In case you're using AJP to connect Tomcat and httpd, make sure you add this attribute to the AJP connector.
119 {{/warning}}
120
121 == [[Glassfish>>http://glassfish.java.net/]] ==
122
123 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**.
124
125 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.
126
127 Create a new directory that we will use as a temporary place to edit our war file:
128
129 {{code}}
130 mkdir xwikitmp
131 {{/code}}
132
133 Unpack the warfile (replace ##<suffix>## with the proper name for the version of XWiki you're using):
134
135 {{code}}
136 cd xwikitemp;jar xvf ../xwiki-<suffix>.war
137 {{/code}}
138
139 Edit the files as mentioned in the beginning of this article:
140
141 * wiki.cfg
142 * web.xml
143 * hibernate.cfg.xml
144
145 Now let's create a new warfile which contains all the changes:
146
147 {{code}}
148 jar cvf ../xwiki-<suffix>.war .
149 {{/code}}
150
151 Now you can deploy your new .war file to Glassfish and it will have all the changes in it and wll be correctly deployed.
152
153 = System config =
154
155 Add the following variables to your system:
156
157 {{code}}
158 LANG = en_US.UTF-8
159 {{/code}}
160
161 [[Credits>>http://markmail.org/message/qitvntzz7cwpyo2w]]
162
163 = OpenOffice import =
164
165 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:
166
167 {{code}}
168 <item
169 oor:path="/org.openoffice.Office.Common/Filter/HTML/Export"><prop
170 oor:name="Encoding" oor:op="fuse"><value>76</value></prop></item>
171 {{/code}}
172
173 [[Credits>>http://lists.xwiki.org/pipermail/users/2011-November/021004.html]]

About

About

Support

Platform

User Guide

Admin Guide

Developer Guide

Projects

XWiki

Extensions

Other

Contribute

Status

Practices

Under the Hood

Get Involved

Get Connected