cpan/Locale-Codes/lib/Locale/Codes/Changes.pod

   1 =pod
   2
   3 =head1 NAME
   4
   5 Locale::Codes::Changes - details changes to Locale::Codes
   6
   7 =head1 SYNOPSIS
   8
   9 This describes the changes made to modules in the Locale-Codes
  10 distribution.  Major changes are marked with asterisks (*).  For the
  11 most part, all modules have remained backward compatible at every
  12 release, but occasionally a change is made which is backward
  13 incompatible. These are marked with an exclamation mark (!).
  14
  15 As of 3.00, the codes are autogenerated from the standards. With each
  16 release, codes will be re-generated and tested to see if any code
  17 changed. Any time there are any changes to the codes, it will be
  18 flagged below with a change: NEW CODE(s).
  19
  20 I intend to check for new codes four times a year (March, June,
  21 September, December). I will also check on request, so if a code
  22 changes that you use, feel free to contact me.  Any time there are new
  23 codes, I will add them to the module and release a new version.
  24
  25 =head1 VERSION 3.18  ()
  26
  27 =head1 VERSION 3.17  (2011-06-28)
  28
  29 NEW CODE(s)
  30
  31 =over 4
  32
  33 =item B<Added new types of codes>
  34
  35 Added Language Extension codes (langext) and Language Variation codes
  36 (langvar) as defined in the IANA language registry.
  37
  38 =item B<Added new codeset(s)>
  39
  40 Added language codes from ISO 639-5
  41
  42 Added language/script codes from the IANA language subtag
  43 registry
  44
  45 =item B<Bug fixes>
  46
  47 Fixed an uninitialized value warning.  RT 67438
  48
  49 Fixed the return value for the all_XXX_codes and all_XXX_names functions.  RT 69100
  50
  51 =item B<Reorganized code>
  52
  53 Reorganized modules to move Locale::MODULE to Locale::Codes::MODULE to
  54 allow for cleaner future additions.  The original four modules (Locale::Language,
  55 Locale::Currency, Locale::Country, Locale::Script) will continue to work, but
  56 all new sets of codes will be added in the Locale::Codes namespace.
  57
  58 =back
  59
  60 =head1 VERSION 3.16  (2011-03-01; sbeck)
  61
  62 NEW CODE(s)
  63
  64 =head1 VERSION 3.15  (2010-12-02; sbeck)
  65
  66 NEW CODE(s)
  67
  68 =over 4
  69
  70 =item B<Minor fixes>
  71
  72 Added version number to Makefile.PL/Build.PL requirement
  73 for POD testing modules.  RT 62247
  74
  75 Changed 'use vars' to 'our'
  76
  77 =back
  78
  79 =head1 VERSION 3.14  (2010-09-28; sbeck)
  80
  81 NEW CODE(s)
  82
  83 =over 4
  84
  85 =item B<Bug fixes>
  86
  87 Stripped out some HTML that got included with some codes.
  88
  89 =back
  90
  91 =head1 VERSION 3.13  (2010-06-04; sbeck)
  92
  93 NEW CODE(s)
  94
  95 =head1 VERSION 3.12  (2010-04-06; sbeck)
  96
  97 NEW CODE(s)
  98
  99 =over 4
 100
 101 =item B<Reorganized code>
 102
 103 Renamed test.pl to testfunc.pl to avoid causing an error
 104 when built as part of perl.
 105
 106 =back
 107
 108 =head1 VERSION 3.11  (2010-03-01; sbeck)
 109
 110 NEW CODE(s)
 111
 112 =over 4
 113
 114 =item B<Added new codeset(s)>
 115
 116 Added the IANA domain names to Country
 117
 118 =item B<Bug fixes>
 119
 120 Fixed a problem that produced warnings with perl 5.11.5.
 121 Jerry D. Hedden
 122
 123 =back
 124
 125 =head1 VERSION 3.10  (2010-02-18; sbeck)
 126
 127 NEW CODE(s)
 128
 129 =over 4
 130
 131 =item B<Reorganized code>
 132
 133 Moved support files into the Locale::Codes namespace.
 134
 135 The work done in each of the Locale::XXX modules was virtually
 136 identical to each other. It has all been moved to a central module and
 137 the Locale::XXX modules are now just wrappers.
 138
 139 =item B<(!) Changed XXX_code2code behavior slightly>
 140
 141 In previous versions, passing in the same code set for both code set
 142 arguments would automatically return undef. For example:
 143
 144    country_code2code('bo',LOCALE_CODE_ALPHA_2,LOCALE_CODE_ALPHA_2);
 145       => undef
 146
 147 This doesn't seem like reasonable behavior, so it has been changed
 148 to allow the same code set:
 149
 150    country_code2code('bo',LOCALE_CODE_ALPHA_2,LOCALE_CODE_ALPHA_2);
 151       => 'bo'
 152
 153 Note that if an invalid code is passed in, undef will still be
 154 returned:
 155
 156    country_code2code('bol',LOCALE_CODE_ALPHA_2,LOCALE_CODE_ALPHA_2);
 157       => undef
 158
 159 =item B<Added many semi-private routines>
 160
 161 Previous versions had only two semi-private routines: rename_country
 162 and alias_code which had the ability to modify the internal data in
 163 a couple very limited ways. It was requested (in an anonymous posting
 164 by someone named Steve and also by Steve Hay) that better support
 165 for modifying internal data, so a full set of routines were added.
 166
 167 The full set of routines includes:
 168
 169    rename_country
 170    rename_language
 171    rename_currency
 172    rename_script
 173
 174    add_country
 175    add_language
 176    add_currency
 177    add_script
 178
 179    delete_country
 180    delete_language
 181    delete_currency
 182    delete_script
 183
 184    add_country_alias
 185    add_language_alias
 186    add_currency_alias
 187    add_script_alias
 188
 189    delete_country_alias
 190    delete_language_alias
 191    delete_currency_alias
 192    delete_script_alias
 193
 194    rename_country_code
 195    rename_language_code
 196    rename_currency_code
 197    rename_script_code
 198
 199    add_country_code_alias
 200    add_language_code_alias
 201    add_currency_code_alias
 202    add_script_code_alias
 203
 204    delete_country_code_alias
 205    delete_language_code_alias
 206    delete_currency_code_alias
 207    delete_script_code_alias
 208
 209 =item B<New aliases>
 210
 211 Added "UK" alias. Steve Hay
 212
 213 =back
 214
 215 =head1 VERSION 3.01  (2010-02-15; sbeck)
 216
 217 =over 4
 218
 219 =item B<Fixed Makefile.PL and Build.PL>
 220
 221 They now install as core modules as they are supposed to.  Reported in
 222 RT 54526
 223
 224 =back
 225
 226 =head1 VERSION 3.00  (2010-02-10; sbeck)
 227
 228 NEW CODE(s)
 229
 230 =over 4
 231
 232 =item B<New maintainer>
 233
 234 From 1997 to 2004, Locale::Codes was maintained by Neil
 235 Bowers. Unfortunately, no updates were made from June 2004 to January
 236 2010. During that time, a number of changes have been made to the
 237 standards since then, so the data included was out-of-date.
 238
 239 I contacted Neil to get his permission to assume maintenance of
 240 the module, and he kindly agreed.
 241
 242 =item B<(*) (!) All codes are generated from standards>
 243
 244 All of the values returned by the various functions are now values
 245 directly from the standards. This means that the values returned in
 246 the 2.xx series are not necessarily the same as the values returned
 247 here.
 248
 249 As an example, the ISO 3166 standard which lists country codes refers
 250 to the country associated with the code "bo" as "Bolivia,
 251 Plurinational State of", so that is what is returned. In the 2.xx
 252 series, "Bolivia" was returned.  Also, the country names vary from one
 253 standard to another. So the code "bol" which is maintained by the
 254 United Nations returns the name of the country as "Bolivia
 255 (Plurinational State of)". Some common aliases have been added, so you
 256 can still request a code associated with a county name "Bolivia".
 257
 258 Since the data comes from the standards, some "incorrect" values are
 259 no longer supported. For example, 2.07 treated "Zaire" as an alias for
 260 "Congo", but the country changed it's name, and "Zaire" is not in the
 261 standard, so it has been dropped in 3.00.
 262
 263 =item B<Added new codeset(s)>
 264
 265 FIPS 10 country codes (requested in RT 1755)
 266
 267 Alpha-3 and Term language codes (requested in RT 11730)
 268
 269 Numeric currency codes (requested in RT 18797)
 270
 271 =item B<(*) (!) Locale::Script changed>
 272
 273 In 2.xx, Locale::Script assigned scripts to country codes, which is NOT
 274 how it is done currently in the standards. It appears that an older version
 275 of ISO 15924 did this, but I haven't found an old version to confirm
 276 that, and in any case, that is not the case in the current standards.
 277
 278 As a result, the Locale::Script module is completely incompatible with
 279 the 2.xx version with respect to the types of codes it supports. None of
 280 the old codes will work.
 281
 282 =item B<Added missing functions>
 283
 284 I've added in some functions which were "missing" previously (since there was
 285 only one set of codes supported, the code2code functions didn't apply):
 286
 287    language_code2code
 288    currency_code2code
 289
 290 so the interfaces for each type of codes are consistent.
 291
 292 =item B<(!) Dropped support for _alias_code>
 293
 294 In Locale::Country, _alias_code was an allowed, but deprecated function
 295 which was documented to be supported in the 2.xx series. I've removed it.
 296
 297 =item B<(!) All functions return the standard value>
 298
 299 code2country (and other equivalent functions) now returns the name of
 300 the country specified in the standard (if the different standards
 301 refer to the country by different variations in the name, the results
 302 will differ based on the CODESET)
 303
 304 =item B<(!) rename_country function altered>
 305
 306 The rename_country function from 2.07 would guess the CODESET (unlike
 307 all other functions which used a default of LOCALE_CODE_ALPHA_2). The
 308 guess can cause problems since (with the addition of FIPS) codes may
 309 appear in different codesets for different countries. The behavior has
 310 been changed to be the same as other functions (default to
 311 LOCALE_CODE_ALPHA_2).
 312
 313 =back
 314
 315 =head1 VERSION 2.07  (2004-06-10; neilb)
 316
 317 Made $_ local in the initialization code for each module
 318 change back-propagated from Perl distribution
 319
 320 Removed two non ISO-8859-1 characters from language names
 321 change back-propagated from Perl distribution
 322
 323 Added the following aliases, with a test case for each
 324    - Burma added to Myanmar
 325    - French Southern and Antarctic Lands to
 326      French Southern Territories
 327 patch from TJ Mather
 328
 329 "Canadian Dollar" was misspelled as "Candian Dollar"
 330    - noted by Nick Cabatoff, patch from Michael Hennecke
 331
 332 Changes to Locale::Country reflecting changes in ISO 3166
 333    - added Aland Islands (ax, ala, 248)
 334    - YUGOSLAVIA is now SERBIA AND MONTENEGRO
 335       YU => CS
 336       YUG => SCG
 337       891 => 891 (unchanged)
 338       (YUGOSLAVIA retained as an alias)
 339    - EAST TIMOR changed to TIMOR-LESTE
 340       (old name retained as an alias)
 341    - three letter code for Romania changed from ROM to ROU
 342
 343 ZAIRE is now CONGO, THE DEMOCRATIC REPUBLIC OF THE
 344     ZR  => CD
 345     ZAR => COD
 346     180 => 180 (unchanged)
 347     (ZAIRE retained as alias)
 348
 349 =head1 VERSION 2.06  (2002-07-15; neilb)
 350
 351 The four modules which have data after __DATA__ weren't closing the
 352 DATA filehandle after reading from it, which they should. Bug and
 353 patch from Steve Hay.
 354
 355 =head1 VERSION 2.05  (2002-07-08; neilb)
 356
 357 Added three letter codes for the countries that were missing
 358 them. Patch from TJ Mather.
 359
 360 Documentation bug: one of the examples used => where the
 361 lvalue was a constant, which isn't allowed, unless you
 362 put the () with the constant to force the right interpretation.
 363 Pointed out by TJ Mather and MYT.
 364
 365 Updated the URL for the appendix in the CIA world factbook.
 366 Patch from TJ Mather.
 367
 368 =head1 VERSION 2.04  (2002-05-23; neilb)
 369
 370 Updated according to changes in ISO 3166-1 described
 371 in ISO 3166-1 newsletters V-4 and V-5, dated 2002-05-20:
 372    - Kazakstan is now "Kazakhstan"
 373    - Macau is now "Macao"
 374 The old names are retained as aliases.
 375
 376 The alpha-2 and alpha-3 codes for East Timor have changed:
 377    tp -> tl
 378    tmp -> tls
 379 the numeric code stays 626. If you want to support the old
 380 codes, you can use the semi-private function alias_code().
 381
 382 =head1 VERSION 2.03  (2002-03-24; neilb)
 383
 384 Fixed a typo in the alias for the Vatican, reported (with patch)
 385 by Philip Newton.
 386
 387 Added "Moldova" as an alias for "Moldova, Republic of"
 388
 389 Updated Makefile.PL to include AUTHOR and ABSTRACT
 390
 391 =head1 VERSION 2.02  (2002-03-09; neilb)
 392
 393 Added semi-private routine rename_country() to Locale::Country,
 394 based on a patch from Iain Chalmers.
 395
 396 Added test rename.t for the above function.
 397
 398 Renamed _alias_code to be alias_code. Have retained the old
 399 name for backwards compatibility. Will remove it when the
 400 major version number next changes.
 401
 402 =head1 VERSION 2.01  (2002-02-18; neilb)
 403
 404 Split the documentation for all modules into separate pod files.
 405
 406 Made sure all =over were =over 4; some were other values.
 407
 408 The code2code() methods had one more shift than was needed.
 409
 410 =head1 VERSION 2.00  (2002-02-17; neilb)
 411
 412 Created Locale::Script which provides an interface to the ISO codes
 413 for identification of scripts (writing scripts, rather than perl style
 414 scripts). The codes are defined by ISO 15924, which is currently in
 415 final draft.  Thanks to Jarkko for pointing out this new standard.
 416 All three code sets are supported, and a test-suite added.
 417
 418 Added support for country name variants to Locale::Country,
 419 so that
 420    country2code('USA')
 421    country2code('United States')
 422    country2code('United States of America')
 423 will all return 'us'.  This had been in the LIMITATIONS section since
 424 the first version.  Patch from TJ Mather with additional variants from
 425 me. Added test-cases for these.
 426
 427 Added VERSION to Locale::Constants. Thanks to Jarkko for
 428 pointing that it was missing.
 429
 430 Should really have bumped major version with previous release,
 431 since there was a change to the API.
 432
 433 =head1 VERSION 1.06  (2001-03-04; neilb)
 434
 435 Added Locale::Constants, which defines three symbols for identifying
 436 which codeset is being used:
 437
 438    LOCALE_CODE_ALPHA_2
 439    LOCALE_CODE_ALPHA_3
 440    LOCALE_CODE_NUMERIC
 441
 442 Updated Locale::Country to support all three code sets defined by ISO
 443 3166. This was requested by Keith Wall.  I haven't added multiple
 444 codeset support to the other modules yet - I'll wait until someone
 445 asks for them.
 446
 447 =head1 VERSION 1.05  (2001-02-13; neilb)
 448
 449 Added Locale::Currency, contribution from Michael Hennecke.
 450
 451 Added test suite for it (t/currency.t) and added test cases
 452 to t/all.t for the all_* functions.
 453
 454 =head1 VERSION 1.04  (2000-12-21; neilb)
 455
 456 Fixed very minor typos from 1.03!
 457
 458 =head1 VERSION 1.03  (2000-12-??; neilb)
 459
 460 Updated Locale::Country:
 461    - fixed spelling of a few countries
 462    - added link to a relevant page from CIA world factbook
 463
 464 Updated Locale::Language:
 465    - fixed typo in the documentation (ISO 939 should be 639)
 466
 467 =head1 VERSION 1.02  (2000-05-04; neilb)
 468
 469 Updated Locale::Country and Locale::Language to reflect changes in the
 470 relevant ISO standards. These mainly reflect languages which are new
 471 to the relevant standard, and changes in the spelling of some country
 472 names.
 473
 474 Added official URLs for the standards to the SEE ALSO sections of the
 475 doc for each module.
 476
 477 Thanks to Jarkko Hietaniemi for pointing me at the pages with latest
 478 versions of ISO 3166 and 639.
 479
 480 =head1 VERSION 1.00  (1998-03-09; neilb)
 481
 482 Added Locale::Country::_alias_code() so that 'uk' can be added as the
 483 code for "United Kingdom", if you want it.  This was prompted by Ed
 484 Jordan.
 485
 486 Added a new test suite for handling this case, and extended the
 487 existing test-suite to include testing of the case where 'uk' hasn't
 488 been defined as a valid code.
 489
 490 =head1 VERSION 0.003  (1997-05-09; neilb)
 491
 492 First public release to CPAN
 493
 494 =head1 SEE ALSO
 495
 496 Locale::Codes
 497
 498 =head1 AUTHOR
 499
 500 See Locale::Codes for full author history.
 501
 502 Currently maintained by Sullivan Beck (sbeck@cpan.org).
 503
 504 =head1 COPYRIGHT
 505
 506    Copyright (c) 2001-2010 Neil Bowers
 507    Copyright (c) 2010-2011 Sullivan Beck
 508
 509 This module is free software; you can redistribute it and/or
 510 modify it under the same terms as Perl itself.
 511
 512 =cut