Update Locale-Codes from CPAN 3.42 to 3.52.

[perl5.git] / cpan / Locale-Codes / lib / Locale / Codes / Language.pod

diff --git a/cpan/Locale-Codes/lib/Locale/Codes/Language.pod b/cpan/Locale-Codes/lib/Locale/Codes/Language.pod
index 42ebe3a..7c45c50 100644 (file)
--- a/cpan/Locale-Codes/lib/Locale/Codes/Language.pod
+++ b/cpan/Locale-Codes/lib/Locale/Codes/Language.pod
@@ -2,94 +2,99 @@
 
 =head1 NAME
 
-Locale::Codes::Language - standard codes for language identification
+Locale::Codes::Language - module for dealing with language code sets
 
 =head1 SYNOPSIS
 
    use Locale::Codes::Language;
 
-   $lang = code2language('en');        # $lang gets 'English'
-   $code = language2code('French');    # $code gets 'fr'
+   $name = code2language(CODE);
+   $code = language2code(NAME);
 
    @codes   = all_language_codes();
    @names   = all_language_names();
 
 =head1 DESCRIPTION
 
-This module provides access to standard codes used
-for identifying languages, such as those as defined in ISO 639.
+This module provides access to language code sets.
 
-Most of the routines take an optional additional argument which
-specifies the code set to use. If not specified, the default ISO
-639 two-letter codes will be used.
-
-=head1 SUPPORTED CODE SETS
+Please refer to the L<Locale::Codes::Types> document for a description
+of the code sets available.
 
-There are several different code sets you can use for identifying
-languages. A code set may be specified using either a name, or a
-constant that is automatically exported by this module.
+Most of the routines take an optional additional argument which
+specifies the code set to use. The code set can be specified using the
+name of a code set, or the perl constant specified in the above
+document.  If not specified, the default code set will be used.
 
-For example, the two are equivalent:
+=head1 ROUTINES
 
-   $lang = code2language('en','alpha-2');
-   $lang = code2language('en',LOCALE_LANG_ALPHA_2);
+All routines in this module call the appropriate method in the
+L<Locale::Codes> module, using an object of type: language
+Please refer to the documentation of the L<Locale::Codes> module
+for details about each function.
 
-The codesets currently supported are:
+The following functions are exported automatically:
 
 =over 4
 
-=item B<alpha-2, LOCALE_LANG_ALPHA_2>
-
-This is the set of two-letter (lowercase) codes from ISO 639-1, such
-as 'he' for Hebrew.  It also includes additions to this set included
-in the IANA language registry.
-
-This is the default code set.
+=item B<code2language(CODE [,CODESET] [,'retired'])>
 
-=item B<alpha-3, LOCALE_LANG_ALPHA_3>
+See B<code2name> in L<Locale::Codes>
 
-This is the set of three-letter (lowercase) bibliographic codes from
-ISO 639-2 and 639-5, such as 'heb' for Hebrew.  It also includes
-additions to this set included in the IANA language registry.
+=item B<language2code(NAME [,CODESET] [,'retired'])>
 
-=item B<term, LOCALE_LANG_TERM>
+See B<name2code> in L<Locale::Codes>
 
-This is the set of three-letter (lowercase) terminologic codes from
-ISO 639.
+=item B<language_code2code(CODE ,CODESET ,CODESET2)>
 
-=back
+See B<code2code> in L<Locale::Codes>
 
-=head1 ROUTINES
+=item B<all_language_codes([CODESET] [,'retired'])>
 
-=over 4
+See B<all_codes> in L<Locale::Codes>
 
-=item B<code2language(CODE [,CODESET] [,'retired'])>
+=item B<all_language_names([CODESET] [,'retired'])>
 
-=item B<language2code(NAME [,CODESET] [,'retired'])>
+See B<all_names> in L<Locale::Codes>
 
-=item B<language_code2code(CODE ,CODESET ,CODESET2)>
+=back
 
-=item B<all_language_codes([CODESET] [,'retired'])>
+The following functions are not exported and must be called fully
+qualified with the package name:
 
-=item B<all_language_names([CODESET] [,'retired'])>
+=over 4
 
 =item B<Locale::Codes::Language::rename_language(CODE ,NEW_NAME [,CODESET])>
 
+See B<rename_code> in L<Locale::Codes>
+
 =item B<Locale::Codes::Language::add_language(CODE ,NAME [,CODESET])>
 
+See B<add_code> in L<Locale::Codes>
+
 =item B<Locale::Codes::Language::delete_language(CODE [,CODESET])>
 
+See B<delete_code> in L<Locale::Codes>
+
 =item B<Locale::Codes::Language::add_language_alias(NAME ,NEW_NAME)>
 
+See B<add_alias> in L<Locale::Codes>
+
 =item B<Locale::Codes::Language::delete_language_alias(NAME)>
 
+See B<delete_alias> in L<Locale::Codes>
+
 =item B<Locale::Codes::Language::rename_language_code(CODE ,NEW_CODE [,CODESET])>
 
+See B<replace_code> in L<Locale::Codes>
+
 =item B<Locale::Codes::Language::add_language_code_alias(CODE ,NEW_CODE [,CODESET])>
 
+See B<add_code_alias> in L<Locale::Codes>
+
 =item B<Locale::Codes::Language::delete_language_code_alias(CODE [,CODESET])>
 
-These routines are all documented in the L<Locale::Codes::API> man page.
+See B<delete_code_alias> in L<Locale::Codes>
 
 =back
 
@@ -101,22 +106,6 @@ These routines are all documented in the L<Locale::Codes::API> man page.
 
 The Locale-Codes distribution.
 
-=item L<Locale::Codes::API>
-
-The list of functions supported by this module.
-
-=item L<http://www.loc.gov/standards/iso639-2/>
-
-Source of the ISO 639-2 codes.
-
-=item L<http://www.loc.gov/standards/iso639-5/>
-
-Source of the ISO 639-5 codes.
-
-=item L<http://www.iana.org/assignments/language-subtag-registry>
-
-The IANA language subtag registry.
-
 =back
 
 =head1 AUTHOR
@@ -127,9 +116,7 @@ Currently maintained by Sullivan Beck (sbeck@cpan.org).
 
 =head1 COPYRIGHT
 
-   Copyright (c) 1997-2001 Canon Research Centre Europe (CRE).
-   Copyright (c) 2001-2010 Neil Bowers
-   Copyright (c) 2010-2016 Sullivan Beck
+   Copyright (c) 2011-2017 Sullivan Beck
 
 This module is free software; you can redistribute it and/or
 modify it under the same terms as Perl itself.