NAME

Encode::Arabic - Encodings of Arabic

SYNOPSIS

    use Encode::Arabic;                 # imports just like 'use Encode' even with options would
    while ($line = <>) {                # renders the ArabTeX notation for Arabic both in the ..
        print encode 'utf8', decode 'arabtex', $line;          # .. Arabic script proper and the
        print encode 'utf8', decode 'arabtex-zdmg', $line;     # .. Latin phonetic transcription
    }
    # 'use Encode::Arabic ":modes"' would export the functions controlling the conversion modes
    Encode::Arabic::demode 'arabtex', 'default';
    Encode::Arabic::enmode 'buckwalter', 'full', 'xml', 'strip off kashida';
    # Arabic in lower ASCII transliterations <--> Arabic script in Perl's internal encoding
    $string = decode 'ArabTeX', $octets;
    $octets = encode 'Buckwalter', $string;
    $string = decode 'Buckwalter', $octets;
    $octets = encode 'ArabTeX', $string;
    # Arabic in lower ASCII transliterations <--> Latin phonetic transcription, Perl's utf8
    $string = decode 'Buckwalter', $octets;
    $octets = encode 'ArabTeX', $string;
    $string = decode 'ArabTeX-ZDMG', $octets;
    $octets = encode 'utf8', $string;

DESCRIPTION

This module is a wrapper for various implementations of the encoding systems used for the Arabic language and covering even some non-Arabic extensions to the Arabic script. The included modules fit in the philosophy of Encode::Encoding and can be used directly with the Encode module.

LIST OF ENCODINGS

ArabTeX: ArabTeX multi-character notation for Arabic / Perl's internal format for the Arabic script
Encode::Arabic::ArabTeX, uses Encode::Mapper
ArabTeX-RE: Deprecated method using sequential regular-expression substitutions. Limited in scope over the ArabTeX notation and non-efficient in data processing, still, not requiring the Encode::Mapper module.
Encode::Arabic::ArabTeX::RE
ArabTeX-Verbatim: ArabTeX multi-character verbatim notation for Arabic / Perl's internal format for the Arabic script
Encode::Arabic::ArabTeX::Verbatim, uses Encode::Mapper
ArabTeX-ZDMG: ArabTeX multi-character notation for Arabic / Perl's internal format for the Latin phonetic trascription in the ZDMG style
Encode::Arabic::ArabTeX::ZDMG, uses Encode::Mapper
ArabTeX-ZDMG-RE: Deprecated method using sequential regular-expression substitutions. Limited in scope over the ArabTeX notation and non-efficient in data processing, still, not requiring the Encode::Mapper module.
Encode::Arabic::ArabTeX::ZDMG::RE
Buckwalter: Buckwalter one-to-one notation for Arabic / Perl's internal format for the Arabic script
Encode::Arabic::Buckwalter
Parkinson: Parkinson one-to-one notation for Arabic / Perl's internal format for the Arabic script
Encode::Arabic::Parkinson
Habash: Habash-Soudi-Buckwalter one-to-one notation for Arabic / Perl's internal format for the Arabic script
Encode::Arabic::Habash

There are generic aliases to these provided by Encode. Case does not matter and all characters of the class "[ _-]" are interchangeable.

Note that the standard Encode module already deals with several other single-byte encoding schemes for Arabic popular with whichever operating system, be it *n*x, Windows, DOS or Macintosh. See Encode::Supported and Encode::Byte for their identification names and aliases.

EXPORTS & MODES

The module exports as if "use Encode" also appeared in the calling package. The "import" options are just delegated to Encode and imports performed properly, with the exception of the ":modes" option coming first in the list. In such a case, the following functions will be introduced into the namespace of the importing package:

enmode ($enc, @list): Calls the "enmode" method associated with the given $enc encoding, and passes the @list to it. The idea is similar to the "encode" functions and methods of the Encode and Encode::Encoding modules, respectively. Used for control over the modes of conversion.
demode ($enc, @list): Analogous to "enmode", but calling the appropriate "demode" method. See the individual implementations of the listed encodings.

AUTHOR

Otakar Smrz "<otakar-smrz users.sf.net>", <http://otakar-smrz.users.sf.net/>

COPYRIGHT AND LICENSE

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

2022-10-16

perl v5.34.0