Wiki source code of Encoding

Version 20.1 by slauriere on 2018/09/17

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 encoding 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 = Database configuration =
52
53 == MySQL ==
54
55 It's common practice that the MySQL configuration file, in *nix systems is located in $$/etc/mysql/my.cnf##:##
56 Starting with MySQL 5.5.3 the option 'default-character-set=utf8' is deprecated under [mysql]
57
58 {{code}}
59 [client]
60 default-character-set=utf8
61 [mysqld]
62 default-character-set=utf8
63 character-set-server = utf8
64 collation-server = utf8_bin
65 {{/code}}
66
67 **After 5.5.3**
68
69 {{code}}
70 [client]
71 default-character-set=utf8
72 [mysqld]
73 character-set-server = utf8
74 collation-server = utf8_bin
75 {{/code}}
76
77
78
79 = Servlet Container =
80
81 == Jetty ==
82
83 {{code}}
84 echo off
85 rem set LANG=fr_FR.ISO8859-1
86 set LANG=en_US.UTF-8
87 set JETTY_PORT=8080
88 set JETTY_HOME=.
89 java %JAVA_OPTS% -Djetty.port=%JETTY_PORT% -Djetty.home=%JETTY_HOME% -Dfile.encoding=UTF-8 -jar %JETTY_HOME%/start.jar
90 {{/code}}
91
92 Instead of the config system variable LANG you can use JVM properties.
93
94 {{code}}
95 -Duser.language=en
96 -Duser.country=US
97 {{/code}}
98
99 in server startup script.
100
101 == Tomcat ==
102
103 In order to enable UTF-8 in tomcat, you have to add
104
105 {{code}}
106 URIEncoding="UTF-8"
107 {{/code}}
108
109 to each connector enabled/used in ##conf/server.xml##. For example the non-SSL HTTP Connector should read:
110
111 {{code language="xml"}}
112 <Connector port="8080" maxHttpHeaderSize="8192"
113 maxThreads="150" minSpareThreads="25" maxSpareThreads="75"
114 enableLookups="false" redirectPort="8443" acceptCount="100"
115 connectionTimeout="20000" disableUploadTimeout="true"
116 URIEncoding="UTF-8"/>
117 {{/code}}
118
119 {{warning}}
120 In case you're using AJP to connect Tomcat and httpd, make sure you add this attribute to the AJP connector.
121 {{/warning}}
122
123 == [[Glassfish>>http://glassfish.java.net/]] ==
124
125 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**.
126
127 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.
128
129 Create a new directory that we will use as a temporary place to edit our war file:
130
131 {{code}}
132 mkdir xwikitmp
133 {{/code}}
134
135 Unpack the warfile (replace ##<suffix>## with the proper name for the version of XWiki you're using):
136
137 {{code}}
138 cd xwikitemp;jar xvf ../xwiki-<suffix>.war
139 {{/code}}
140
141 Edit the files as mentioned in the beginning of this article:
142
143 * wiki.cfg
144 * web.xml
145 * hibernate.cfg.xml
146
147 Now let's create a new warfile which contains all the changes:
148
149 {{code}}
150 jar cvf ../xwiki-<suffix>.war .
151 {{/code}}
152
153 Now you can deploy your new .war file to Glassfish and it will have all the changes in it and wll be correctly deployed.
154
155 = Web server =
156
157 == Apache ==
158
159 Make sure that the Apache configuration file ##httpd.conf## contains the following line:
160
161 {{code}}
162 AddDefaultCharset UTF-8
163 {{/code}}
164
165 = System config =
166
167 Add the following variables to your system:
168
169 {{code}}
170 LANG = en_US.UTF-8
171 {{/code}}
172
173 [[Credits>>http://markmail.org/message/qitvntzz7cwpyo2w]]
174
175 = OpenOffice import =
176
177 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:
178
179 {{code}}
180 <item
181 oor:path="/org.openoffice.Office.Common/Filter/HTML/Export"><prop
182 oor:name="Encoding" oor:op="fuse"><value>76</value></prop></item>
183 {{/code}}
184
185 [[Credits>>http://lists.xwiki.org/pipermail/users/2011-November/021004.html]]
186
187 = Tools =
188
189 * 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.

Get Connected