xref: /haiku/docs/user/locale/localeintro.dox (revision e0ef64750f3169cd634bb2f7a001e22488b05231)
1/*!
2\page locale_intro Introduction to the Locale Kiit
3
4The Locale Kit provides a set of tools for internationalizing, localizing and
5translating your software. This includes not only replacing string with their
6translations at runtime, but also more complex tasks such as formating numbers,
7dates, and times in a way that match the locale preferences of the user.
8
9The main way to access locale data is through the be_locale_roster. This is a
10global instance of the BLocaleRoster class, storing the data for localizing an
11application according to the user's preferred settings. The locale roster also
12acts as a factory to instanciate most of the other classes. However, there are
13some cases where you will need to instanciate another class by yourself, to
14use it with custom settings. For example, you may need to format a date with
15a fixed format in english for including in an e-mail header, as it is the only
16format accepted there.
17
18Unlike the other kits in Haiku, the Locale kit does not live in libbe. When
19building a localized application, you have to link it to liblocale.so. If you
20want to use the catalog macros, you also have to link each of your images
21(that is, applications, libraries and add-ons) to liblocalestub.a.
22
23*/
24