SEARCH
NEW RPMS
DIRECTORIES
ABOUT
FAQ
VARIOUS
BLOG
DONATE


YUM REPOSITORY

 
 

MAN page from CentOS 6 psrk-perl-Pod-Escapes-1.04-27.5.noarch.rpm

Pod::Escapes

Section: Perl Programmers Reference Guide (3pm)
Updated: 2011-06-01
Index 

NAME

Pod::Escapes -- for resolving Pod E<...> sequences 

SYNOPSIS

  use Pod::Escapes qw(e2char);  ...la la la, parsing POD, la la la...  $text = e2char($e_node->label);  unless(defined $text) {    print "Unknown E sequence \"", $e_node->label, "\"!";  }  ...else print/interpolate $text...
 

DESCRIPTION

This module provides things that are useful in decodingPod E<...> sequences. Presumably, it should be usedonly by Pod parsers and/or formatters.

By default, Pod::Escapes exports none of its symbols. Butyou can request any of them to be exported.Either request them individually, as with"use Pod::Escapes qw(symbolname symbolname2...);",or you can do "use Pod::Escapes qw(:ALL);" to get allexportable symbols. 

GOODIES

e2char($e_content)
Given a name or number that could appear in a"E<name_or_num>" sequence, this returns the string thatit stands for. For example, "e2char('sol')", "e2char('47')","e2char('0x2F')", and "e2char('057')" all return ``/'',because "E<sol>", "E<47>", "E<0x2f>",and "E<057>", all mean ``/''. Ifthe name has no known value (as with a name of ``qacute'') or issyntactally invalid (as with a name of ``1/4''), this returns undef.
e2charnum($e_content)
Given a name or number that could appear in a"E<name_or_num>" sequence, this returns the number ofthe Unicode character that this stands for. For example,"e2char('sol')", "e2char('47')","e2char('0x2F')", and "e2char('057')" all return 47,because "E<sol>", "E<47>", "E<0x2f>",and "E<057>", all mean ``/'', whose Unicode number is 47. Ifthe name has no known value (as with a name of ``qacute'') or issyntactally invalid (as with a name of ``1/4''), this returns undef.
$Name2character{name}
Maps from names (as in "E<name>") like ``eacute'' or ``sol''to the string that each stands for. Note that this does notinclude numerics (like ``64'' or ``x981c''). Under old Perl versions(before 5.7) you get a ``?'' in place of characters whose Unicodevalue is over 255.
$Name2character_number{name}
Maps from names (as in "E<name>") like ``eacute'' or ``sol''to the Unicode value that each stands for. For example,$Name2character_number{'eacute'} is 201, and$Name2character_number{'eacute'} is 8364. You get the correctUnicode value, regardless of the version of Perl you're using ---which differs from %Name2character's behavior under pre-5.7 Perls.

Note that this hash does notinclude numerics (like ``64'' or ``x981c'').

$Latin1Code_to_fallback{integer}
For numbers in the range 160 (0x00A0) to 255 (0x00FF), this mapsfrom the character code for a Latin-1 character (like 233 forlowercase e-acute) to the US-ASCII character that best aproximatesit (like ``e''). You may find this useful if you are renderingPOD in a format that you think deals well only with US-ASCIIcharacters.
$Latin1Char_to_fallback{character}
Just as above, but maps from characters (like ``\xE9'', lowercase e-acute) to characters (like ``e'').
$Code2USASCII{integer}
This maps from US-ASCII codes (like 32) to the correspondingcharacter (like space, for 32). Only characters 32 to 126 aredefined. This is meant for use by "e2char($x)" when it sensesthat it's running on a non-ASCII platform (where chr(32) doesn'tget you a space --- but $Code2USASCII{32} will). It'sdocumented here just in case you might find it useful.
 

CAVEATS

On Perl versions before 5.7, Unicode characters with a valueover 255 (like lambda or emdash) can't be conveyed. Thismodule does work under such early Perl versions, but in theplace of each such character, you get a ``?''. Latin-1characters (characters 160-255) are unaffected.

Under EBCDIC platforms, "e2char($n)" may not always be thesame as "chr(e2charnum($n))", and ditto for$Name2character{$name} and"chr($Name2character_number{$name})". 

SEE ALSO

perlpod

perlpodspec

Text::Unidecode 

COPYRIGHT AND DISCLAIMERS

Copyright (c) 2001-2004 Sean M. Burke. All rights reserved.

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

This program is distributed in the hope that it will be useful, butwithout any warranty; without even the implied warranty ofmerchantability or fitness for a particular purpose.

Portions of the data tables in this module are derived from theentity declarations in the W3C XHTML specification.

Currently (October 2001), that's these three:

 http://www.w3.org/TR/xhtml1/DTD/xhtml-lat1.ent http://www.w3.org/TR/xhtml1/DTD/xhtml-special.ent http://www.w3.org/TR/xhtml1/DTD/xhtml-symbol.ent
 

AUTHOR

Sean M. Burke "sburkeAATTcpan.org"


 

Index

NAME
SYNOPSIS
DESCRIPTION
GOODIES
CAVEATS
SEE ALSO
COPYRIGHT AND DISCLAIMERS
AUTHOR

This document was created byman2html,using the manual pages.