UTF-8 Readme

From Online Manual

Revision as of 22:36, 10 October 2012 by Colin (talk | contribs) (Why would I NOT need UTF-8?)
Jump to: navigation, search

UTF-8 is an encoding standard that can represent all Unicode characters. This allows it to show almost any writing system in the world.

What's new in SMF 2.0.x with regard to UTF-8?

With version 2.0, SMF introduced full UTF-8 character set support. SMF 1.1.x supported ISO-8859 character sets, with limited support for non-ISO character sets for some languages. With SMF 2.0 comes the option to run the forum with UTF-8 or without. If you install a new SMF 2.0.x forum with UTF-8, or if you upgrade an existing SMF 2.0.x forum to UTF-8, then all posts will be stored on the database using the UTF-8 character set, and every web page will inform the browser it is using the UTF-8 character set. For each language pack you decide to install for your forum, it will be necessary to choose the UTF-8 version of that character set.

If you choose not to use UTF-8 for your SMF 2.0.x forum, then you must choose the non-UTF-8 versions of all language packs you install with your forum.

If you choose the wrong character set for any of your language packs, you will see some of what users often describe as "garbage characters" on the screen. The solution is to use only the correct character-set version of the language packs you have chosen for your forum.

Character sets available for 1.1.x

For languages with non-ASCII characters, these character sets were used in a non-UTF-8 forum. When converting to UTF-8, take note of the character set previously used.

Character set Language
big5Chinese (traditional)
gbkChinese (simplified)
ISO-8859-1Albanian, Brazilian, Catalan, Danish, Dutch, English, Finnish, French, German, Portuguese, Norwegian, Spanish, Swedish, Italian, Indonesian, Malay, Galician
ISO-8859-2Croatian, Hungarian, Polish, Romanian, Serbian (latin), Slovak, Polish, Czech
ISO-8859-3Esperanto
ISO-8859-5Serbian (cyrilic)
ISO-8859-9Turkish
tis-620Thai
UTF-8Chinese (simplified), Chinese (traditional), Japanese, Persian, Vietnamese, Urdu, Persian, Macedonian, Lithuanian
windows-1256Arabic
windows-1251Bulgarian, Russian, Ukrainian
windows-1253Greek
windows-1255Hebrew

As of SMF 1.1 RC3 you'll be able to also download each of those language packages in UTF-8 character set (Language packs).

Why would I need UTF-8?

There are a few reasons you might need UTF-8:

  • If you want to support multiple languages that use different character sets on your forum. For instance if you want to support both Russian and Turkish, you will need a character set that supports both. UTF-8 is then a logical choice.
  • If the software integrating with SMF uses UTF-8. In some cases such an integration can require character sets to match.
  • If you need better search results or improved sorting. In some cases searching and sorting by the database can be improved by chosing UTF-8 as your character set.

Why would I NOT need UTF-8?

If none of the above reasons apply to your forum, UTF-8 would probably not be very useful. Besides, it's a bit slower too.

Also keep in mind that you need at least MySQL 4.1 and SMF 1.1 RC3 to be able to use UTF-8 as default character set if you are using MySQL as your database scheme.

How to convert to UTF-8

This procedure will work well if you have used the recommended character sets in your language files in the past.

  • Start with a backup of your database(!) Character set conversions nearly always go correctly, but it is best to be prepared for the unexpected.
  • Check your default language file (Administration Center » Languages » Edit Languages ) and make a note of the character set used.
  • Go to Forum Maintenance > Convert the database and data to UTF-8 (this option will only be available if SMF detects a database version which supports UTF-8)
  • Select the character sets for your data (member posts) and database. By default, SMF will choose the character set of your default language file.
  • Press proceed; your database will be converted. Depending on the size of your database, the conversion process might stop temporarily from time to time to avoid overloading the server. If that was successful, your forum should be converted to UTF-8.
  • For each of language pack currently in use, replace it with the UTF-8 version of that language pack. Luckily all language packs for 1.1 RC3 are available for both the original character set and UTF-8, so simply download them and you should be ready to go.
  • Once all the UTF-8 language packs have been installed, convert the language settings of each user by running the following query:
UPDATE smf_members
SET lngfile = CONCAT(lngfile, '-utf8')
WHERE lngfile != ''
  • In your admin center, change the default language -- choose the UTF-8 version.
  • Check to see if all your data was properly converted
  • If any of your posts contain HTML entities, you will want to convert those to UTF-8 as well -- run "Convert HTML-entities to UTF-8 characters"