.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is turned on, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} .el \{\ . de IX .. .\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "XML::Entities 3" .TH XML::Entities 3 "2015-08-17" "perl v5.12.5" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" XML::Entities \- Decode strings with XML entities .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 1 \& use XML::Entities; \& \& $a = "Tom & Jerry © Warner Bros."; \& $b = XML::Entities::decode(\*(Aqall\*(Aq, $a); \& $c = XML::Entities::numify(\*(Aqall\*(Aq, $a); \& # now $b is "Tom & Jerry X Warner Bros. \& # and $c is "Tom & Jerry © Warner Bros." \& \& # void context modifies the arguments \& XML::Entities::numify(\*(Aqall\*(Aq, $a); \& XML::Entities::decode(\*(Aqall\*(Aq, $a, $c); \& # Now $a, $b and $c all contain the decoded string .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" Based upon the HTML::Entities module by Gisle Aas .PP This module deals with decoding of strings with \s-1XML\s0 character entities. The module provides two functions: .ie n .IP "decode( $entity_set, $string, ... )" 4 .el .IP "decode( \f(CW$entity_set\fR, \f(CW$string\fR, ... )" 4 .IX Item "decode( $entity_set, $string, ... )" This routine replaces \s-1XML\s0 entities from \f(CW$entity_set\fR found in the \&\f(CW$string\fR with the corresponding Unicode character. Unrecognized entities are left alone. .Sp The \f(CW$entity_set\fR can either be a name of an entity set \- the selection of which can be obtained by \fIXML::Entities::Data::names()\fR, or \*(L"all\*(R" for a union, or alternatively a hashref which maps entity names (without leading &'s) to the corresponding Unicode characters (or strings). .Sp If multiple strings are provided as argument they are each decoded separately and the same number of strings are returned. .Sp If called in void context the arguments are decoded in-place. .Sp Note: If your version of \f(CW\*(C`HTML::Parser\*(C'\fR was built without Unicode support, then \&\f(CW\*(C`XML::Entities\*(C'\fR uses a regular expression to do the decoding, which is slower. .ie n .IP "numify( $entity_set, $string, ... )" 4 .el .IP "numify( \f(CW$entity_set\fR, \f(CW$string\fR, ... )" 4 .IX Item "numify( $entity_set, $string, ... )" This functions converts named \s-1XML\s0 entities to numeric \s-1XML\s0 entities. It is less robust than the \f(CW\*(C`decode\*(C'\fR function in the sense that it doesn't capture improperly terminated entities. It behaves like \f(CW\*(C`decode\*(C'\fR in treating parameters and returning values. .SS "XML::Entities::Data" .IX Subsection "XML::Entities::Data" The list of entities is defined in the XML::Entities::Data module. The list can be generated from the w3.org definition (or any other). Check \f(CW\*(C`perldoc XML::Entities::Data\*(C'\fR for more details. .SS "Encoding entities" .IX Subsection "Encoding entities" The HTML::Entities module provides a function for encoding entities. You just have to assign the right mapping to the \f(CW%HTML::Entities::char2entity\fR hash. So, to encode everything that XML::Entities knows about, you'd say: .PP .Vb 7 \& use XML::Entities; \& use HTML::Entities; \& %HTML::Entities::char2entity = %{ \& XML::Entities::Data::char2entity(\*(Aqall\*(Aq); \& }; \& my $encoded = encode_entities(\*(Aqtom&jerry\*(Aq); \& # now $encoded is \*(Aqtom&jerry\*(Aq .Ve .SH "SEE ALSO" .IX Header "SEE ALSO" HTML::Entities, XML::Entities::Data .SH "COPYRIGHT" .IX Header "COPYRIGHT" Copyright 2012 Jan Oldrich Kruza . All rights reserved. .PP This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.