Skip to Content

Changes for page UTF-8 Encoding Tips

Last modified by Ray Kiddy on 2022/01/11 21:36
From version 11.1
edited by Antoine Berry
on 2012/09/20 10:12
Change comment: There is no comment for this version
To version 21.2
edited by Ray Kiddy
on 2022/01/11 21:36
Change comment: Changed document parent to [xwiki:documentation.Home.Development Architecture.Localization.WebHome].

Summary

Details

Page properties
Parent
... ... @@ -1,0 +1,1 @@
1 +documentation.Home.Development Architecture.Localization.WebHome
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.aberry
1 +XWiki.kiddyr
Content
... ... @@ -1,13 +1,12 @@
1 1  = UTF-8 Encoding Tips =
2 2  
3 -Encoding questions are asked frequently on the mailing list. This is just a collection of tips for using UTF-8. It's a checklist of sorts. Make sure you've done all the things specified here before pitching your computer into the ocean :)
3 +Encoding questions are asked frequently on the mailing list. This is just a collection of tips for using UTF-8. It's a checklist of sorts. Make sure you've done all the things specified here before pitching your computer into the ocean
4 4  
5 5  == Check your database ==
6 6  
7 -The database needs to be storing values in UTF-8. If it isn't, then all your effort is wasted. For example, on MySQL that means a db url like
7 +The database needs to be storing values in UTF-8. If it isn't, then all your effort is wasted. For example, on MySQL that means a db url like
8 8  
9 9  {{noformat}}
10 -
11 11  jdbc:mysql://localhost/Example?capitalizeTypenames=true&zeroDateTimeBehavior=convertToNull&useUnicode=true&characterEncoding=UTF-8
12 12  
13 13  {{/noformat}}
... ... @@ -14,14 +14,20 @@
14 14  
15 15  And setting your default charset and collation in your my.cnf file
16 16  
17 -[[image:options.png]]
16 +[[image:attach:options.png]]
18 18  
18 +Or you can set these things at table create as below. One can also set these on the database as a whole.
19 +
20 +
21 +\\\\\\\\\\\\\\\\
22 +
23 +{{{mysql> show create table cards \G*************************** 1. row ***************************       Table: cardsCreate Table: CREATE TABLE `cards` (  `pk` int NOT NULL,  `creator_pk` int DEFAULT NULL,  `created_date` bigint DEFAULT NULL,  `invalid_date` bigint DEFAULT NULL,  PRIMARY KEY (`pk`)) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci}}}
24 +
19 19  == Fonts & CSS ==
20 20  
21 -Different fonts may not have all the characters to display the different characters. If you're using a default stylesheet, then the browsers may be displaying differently simply because of fonts. Speaking of stylesheets, you probably want to encode that in UTF-8 also. Start your stylesheet with something like
27 +Different fonts may not have all the characters to display the different characters. If you're using a default stylesheet, then the browsers may be displaying differently simply because of fonts. Speaking of stylesheets, you probably want to encode that in UTF-8 also. Start your stylesheet with something like
22 22  
23 23  {{noformat}}
24 -
25 25  @charset "UTF-8";
26 26  @import url("reset.css");
27 27  
... ... @@ -31,14 +31,13 @@
31 31  
32 32  == Set eclipse encoding ==
33 33  
34 -[[image:preferences.png]]
39 +[[image:attach:preferences.png]]
35 35  
36 36  == Use Project Wonder ==
37 37  
38 -I think this goes without saying but: **Use Wonder**. Set encoding in the properties file. Notice it is UTF-8 with a hyphen. It it always UTF-8 with a hyphen... well, except with the MySQL image above because they excel in doing things differently :)
43 +I think this goes without saying but: **Use Wonder**. Set encoding in the properties file. Notice it is UTF-8 with a hyphen. It it always UTF-8 with a hyphen... well, except with the MySQL image above because they excel in doing things differently
39 39  
40 40  {{noformat}}
41 -
42 42  # Project Encoding
43 43  er.extensions.ERXApplication.DefaultEncoding=UTF-8
44 44  
... ... @@ -47,7 +47,6 @@
47 47  == Set encoding in your page wrapper ==
48 48  
49 49  {{noformat}}
50 -
51 51  <?xml version="1.0" encoding="UTF-8" standalone="no"?>
52 52  <!DOCTYPE html PUBLIC
53 53   "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN"
... ... @@ -57,8 +57,16 @@
57 57  
58 58  == Localizable strings should be in UTF-16! ==
59 59  
60 -Localizable.strings should be encoded in UTF-16. The localizer can detect UTF-16 without error, where it can confuse UTF-8 with other encodings. Pascal says use UTF-16LE if you want to be explicit about things... Especially if you are editing your strings files in an external editor like BBEdit or whatnot. I use the eclipse editor and UTF-16 myself and all seems to work fine for me. So to each his own.
63 +Localizable.strings should be encoded in UTF-16. The localizer can detect UTF-16 without error, where it can confuse UTF-8 with other encodings. Specifically, you should be using UTF-16 BE with no BOM if you are using an external text editor instead of eclipse.
61 61  
62 -== Build your files in UTF-8. ==
65 +== Build your files in UTF-8. ==
63 63  
64 64  If you have some special characters in your code (like '€' for exemple), then you will need to specify which encoding you want when you build your application. To do that, you have to modify your "build.xml" file by adding the property "encoding="utf-8" into your <wocompile> statement.
68 +
69 +{{code language="xml"}}
70 +<wocompile srcdir="Sources" destdir="bin" encoding="utf-8">
71 +
72 +{{/code}}
73 +
74 +(% class="auto-cursor-target" %)
75 +\\
options.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +141.4 KB
Content
preferences.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.XWikiGuest
Size
... ... @@ -1,0 +1,1 @@
1 +106.8 KB
Content