annotate 0.8.x/doc/display.txt @ 312:98608737e686 stable

Ported [343] to stable branch.
author cmlenz
date Mon, 14 Jan 2008 13:14:39 +0000
parents 4a7af44e6695
children
rev   line source
142
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
1 .. -*- mode: rst; encoding: utf-8 -*-
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
2
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
3 ====================
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
4 Locale Display Names
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
5 ====================
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
6
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
7 .. contents:: Contents
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
8 :depth: 2
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
9 .. sectnum::
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
10
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
11
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
12 Introduction
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
13 ============
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
14
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
15 While `message catalogs <messages.html>`_ allow you to localize any messages
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
16 in your application, there are a number of strings that are used in many
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
17 applications for which translations are readily available.
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
18
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
19 Imagine for example you have a list of countries that users can choose from,
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
20 and you'd like to display the names of those countries in the language the
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
21 user prefers. Instead of translating all those country names yourself in your
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
22 application, you can make use of the translations provided by the locale data
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
23 included with Babel, which is based on the `Common Locale Data Repository
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
24 (CLDR) <http://unicode.org/cldr/>`_ developed and maintained by the `Unicode
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
25 Consortium <http://unicode.org/>`_.
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
26
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
27
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
28 The ``Locale`` Class
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
29 ====================
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
30
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
31 You normally access such locale data through the `Locale`_ class provided
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
32 by Babel:
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
33
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
34 .. code-block:: pycon
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
35
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
36 >>> from babel import Locale
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
37 >>> locale = Locale('en', 'US')
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
38 >>> locale.territories['US']
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
39 u'United States'
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
40 >>> locale = Locale('es', 'MX')
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
41 >>> locale.territories['US']
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
42 u'Estados Unidos'
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
43
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
44 .. _`Locale`: api/babel.core.Locale-class.html
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
45
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
46 In addition to country/territory names, the locale data also provides access to
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
47 names of languages, scripts, variants, time zones, and more. Some of the data
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
48 is closely related to number and date formatting.
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
49
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
50 Most of the corresponding ``Locale`` properties return dictionaries, where the
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
51 key is a code such as the ISO country and language codes. Consult the API
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
52 documentation for references to the relevant specifications.
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
53
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
54
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
55 Calender Display Names
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
56 ======================
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
57
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
58 The `Locale`_ class provides access to many locale display names related to
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
59 calendar display, such as the names of week days or months.
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
60
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
61 These display names are of course used for date formatting, but can also be
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
62 used, for example, to show a list of months to the user in their preferred
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
63 language:
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
64
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
65 .. code-block:: pycon
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
66
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
67 >>> locale = Locale('es')
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
68 >>> month_names = locale.months['format']['wide'].items()
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
69 >>> month_names.sort()
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
70 >>> for idx, name in month_names:
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
71 ... print name
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
72 enero
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
73 febrero
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
74 marzo
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
75 abril
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
76 mayo
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
77 junio
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
78 julio
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
79 agosto
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
80 septiembre
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
81 octubre
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
82 noviembre
4a7af44e6695 Create branch for 0.8.x releases.
cmlenz
parents:
diff changeset
83 diciembre
Copyright (C) 2012-2017 Edgewall Software