• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1//
2//  Copyright (c) 2009-2011 Artyom Beilis (Tonkikh)
3//
4//  Distributed under the Boost Software License, Version 1.0. (See
5//  accompanying file LICENSE_1_0.txt or copy at
6//  http://www.boost.org/LICENSE_1_0.txt)
7//
8
9// vim: tabstop=4 expandtab shiftwidth=4 softtabstop=4 filetype=cpp.doxygen
10
11/*!
12
13\mainpage Boost.Locale
14
15\section main_intro What is Boost.Locale?
16
17Boost.Locale is a library that provides high quality
18localization facilities in a C++ way. It was originally designed
19a part of <a href="http://cppcms.sourceforge.net/">CppCMS</a> - C++ Web Framework
20project and then contributed to Boost.
21
22Boost.Locale gives powerful tools for development of cross platform
23localized software - the software that talks to user
24in its language.
25
26Provided Features:
27
28-   Correct case conversion, case folding and normalization.
29-   Collation (sorting), including support for 4 Unicode
30    collation levels.
31-   Date, time, timezone and calendar manipulations,
32    formatting and parsing, including transparent support
33    for calendars other than Gregorian.
34-   Boundary analysis for characters, words, sentences and
35    line-breaks.
36-   Number formatting, spelling and parsing.
37-   Monetary formatting and parsing.
38-   Powerful message formatting (string translation)
39    including support for plural forms, using GNU catalogs.
40-   Character set conversion.
41-   Transparent support for 8-bit character sets like Latin1
42-   Support for \c char and \c wchar_t
43-   Experimental support for C++0x \c char16_t and \c char32_t
44    strings and streams.
45
46Boost.Locale enhances and unifies the standard library's API
47the way it becomes useful and convenient for development
48of cross platform and "cross-culture" software.
49
50In order to achieve this goal Boost.Locale uses
51the-state-of-the-art Unicode and Localization
52library: <a href="http://icu-project.org/">ICU</a> - International Components for Unicode.
53
54Boost.Locale creates the natural glue between the C++ locales
55framework, iostreams, and the powerful ICU library.
56
57Boost.Locale provides non-ICU based localization support as well.
58It is based on the operating system native API or on the standard
59C++ library support. Sacrificing some less important features,
60Boost.Locale becomes less powerful but lighter and easier to deploy
61and use library.
62
63
64\section main_tutorial Tutorials
65
66- \subpage std_locales
67- \subpage using_boost_locale
68    - \ref locale_gen
69    - \ref collation
70    - \ref conversions
71    - \ref formatting_and_parsing
72    - \ref messages_formatting
73    - \ref charset_handling
74    - \ref boundary_analysys
75    - \ref localized_text_formatting
76    - \ref dates_times_timezones
77    - \ref locale_information
78    - \ref working_with_multiple_locales
79- \subpage using_localization_backends
80- \subpage recommendations_and_myths
81- \subpage building_boost_locale
82- \subpage appendix
83    - \ref rationale
84    - \ref faq
85    - \ref default_encoding_under_windows
86    - \ref running_examples_under_windows
87    - \ref gettext_for_windows
88    - \ref glossary
89    - \ref tested_compilers_and_paltforms
90    - \ref status_of_cpp0x_characters_support
91    - \ref special_thanks
92- \subpage changelog
93*/
94
95