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

   1 =pod
   2
   3 =head1 NAME
   4
   5 Locale::Script - standard codes for script identification
   6
   7 =head1 SYNOPSIS
   8
   9    use Locale::Script;
  10
  11    $script  = code2script('phnx');                     # 'Phoenician'
  12    $code    = script2code('Phoenician');               # 'Phnx'
  13    $code    = script2code('Phoenician',
  14                           LOCALE_CODE_NUMERIC);        # 115
  15
  16    @codes   = all_script_codes();
  17    @scripts = all_script_names();
  18
  19 =head1 DESCRIPTION
  20
  21 The C<Locale::Script> module provides access to standards codes used
  22 for identifying scripts, such as those defined in ISO 15924.
  23
  24 Most of the routines take an optional additional argument which
  25 specifies the code set to use. If not specified, the default ISO
  26 15924 four-letter codes will be used.
  27
  28 =head1 SUPPORTED CODE SETS
  29
  30 There are several different code sets you can use for identifying
  31 scripts. The ones currently supported are:
  32
  33 =over 4
  34
  35 =item B<alpha>
  36
  37 This is a set of four-letter (capitalized) codes from ISO 15924
  38 such as 'Phnx' for Phoenician.
  39
  40 This code set is identified with the symbol C<LOCALE_SCRIPT_ALPHA>.
  41
  42 The Zxxx, Zyyy, and Zzzz codes are not used.
  43
  44 This is the default code set.
  45
  46 =item B<numeric>
  47
  48 This is a set of three-digit numeric codes from ISO 15924 such as 115
  49 for Phoenician.
  50
  51 This code set is identified with the symbol C<LOCALE_SCRIPT_NUMERIC>.
  52
  53 =back
  54
  55 =head1 ROUTINES
  56
  57 =over 4
  58
  59 =item B<code2script ( CODE [,CODESET] )>
  60
  61 =item B<script2code ( NAME [,CODESET] )>
  62
  63 =item B<script_code2code ( CODE ,CODESET ,CODESET2 )>
  64
  65 =item B<all_script_codes ( [CODESET] )>
  66
  67 =item B<all_script_names ( [CODESET] )>
  68
  69 =item B<Locale::Script::rename_script  ( CODE ,NEW_NAME [,CODESET] )>
  70
  71 =item B<Locale::Script::add_script  ( CODE ,NAME [,CODESET] )>
  72
  73 =item B<Locale::Script::delete_script  ( CODE [,CODESET] )>
  74
  75 =item B<Locale::Script::add_script_alias  ( NAME ,NEW_NAME )>
  76
  77 =item B<Locale::Script::delete_script_alias  ( NAME )>
  78
  79 =item B<Locale::Script::rename_script_code  ( CODE ,NEW_CODE [,CODESET] )>
  80
  81 =item B<Locale::Script::add_script_code_alias  ( CODE ,NEW_CODE [,CODESET] )>
  82
  83 =item B<Locale::Script::delete_script_code_alias  ( CODE [,CODESET] )>
  84
  85 These routines are all documented in the Locale::Codes man page.
  86
  87 =back
  88
  89 =head1 SEE ALSO
  90
  91 =over 4
  92
  93 =item B<Locale::Codes>
  94
  95 =item B<Locale::Constants>
  96
  97 =item B<http://www.unicode.org/iso15924/>
  98
  99 Home page for ISO 15924.
 100
 101 =back
 102
 103 =head1 AUTHOR
 104
 105 See Locale::Codes for full author history.
 106
 107 Currently maintained by Sullivan Beck (sbeck@cpan.org).
 108
 109 =head1 COPYRIGHT
 110
 111    Copyright (c) 1997-2001 Canon Research Centre Europe (CRE).
 112    Copyright (c) 2001-2010 Neil Bowers
 113    Copyright (c) 2010-2010 Sullivan Beck
 114
 115 This module is free software; you can redistribute it and/or
 116 modify it under the same terms as Perl itself.
 117
 118 =cut