HTML::...mbered(3pm)

✨ NAME ✨

okay bestie, welcome to HTML::Entities::Numbered 💖 (that's the manual name, she's a Perl module, and she converts numbered HTML entities — that's literally the whole job, she's so valid for that)

---

🦋 SYNOPSIS 🦋

real talk, here's the vibe in code:

use HTML::Entities::Numbered;

$html    = 'Hi Honey<b>&hearts;</b>';

# convert named HTML entities to numbered (decimal)
$decimal = name2decimal($html);    # Hi Honey<b>&#9829;</b>

# to numbered (hexadecimal)
$hex     = name2hex($html);        # Hi Honey<b>&#x2665;</b>

$content = 'Copyright &#169; Larry Wall';

# convert numbered HTML entities (decimal) to named
$name1   = decimal2name($content); # Copyright &copy; Larry Wall

$content = 'Copyright &#xA9; Larry Wall';
# convert numbered HTML entitites (hexadecimal) to named
$name2   = hex2name($content);     # Copyright &copy; Larry Wall

$xml     = '&quot;Give me &yen;10,000&quot; &gt; cherie&spades;';

# convert named HTML entities to numbered
# except valid XML entities (decimal)
$decimal = name2decimal_xml($xml); # &quot;Give me &#165;10,000&quot;
                                   # &gt; cherie&#9824;

# to numbered except valid XML entities (hexdecimal)
$hex     = name2hex_xml($xml);     # &quot;Give me &#xA5;10,000&quot;
                                   # &gt; cherie&#x2660;

like… look at her go 💅

---

🌸 DESCRIPTION 🌸

HTML::Entities::Numbered is a content conversion filter for named HTML entities — we're talking symbols, mathmetical symbols, Greek letters, Latin letters, etc. the whole cute little alphabet of entities 🔥

so here's the tea:

• when an argument of name2decimal() or name2hex() contains some nameable HTML entities, they will be replaced to numbered HTML entities.
• and when an argument of name2decimal_xml() or name2hex_xml() contains some nameable numbered HTML entities, they will be replaced to numbered HTML entities except valid XML entities. no cap. and what are those excepted "valid XML entities"? it's these five, bestie: <, >, &, ", '.
• by the same token, when an argument of decimal2name() or hex2name() contains some nameable numbered HTML entities, they will be replaced to named HTML entities.

(and yes, to say it again because it matters: the exception "valid XML entities" means the following five entities: <, >, &, ", ')

okay now the lore 🧚 on version 0.03, the entities hash table is imported from HTML::Entities (with obsolete class HTML::Entities::Numbered::Extra for older releases of Perl). but at the moment, 0.04 (or later) is included HTML::Entities::Numbered::Table to import HTML entities table, and thereby we do not need to have HTML::Entities (included in HTML::Parser distribution). glow up fr fr ✨

this may be also useful for making valid XML (corrects the undefined entity references, and enhanced by addition of functions conform to the XML).

---

👑 FUNCTIONS 👑

following all functions are exported by default. yes, all of them, she's generous like that 🫶

• name2decimal — some included named HTML entities in argument of name2decimal() will be replaced to decimal numbered HTML entities.
• name2hex — some included named HTML entities in argument of name2hex() will be replaced to hexadecimal numbered HTML entities.
• decimal2name — some include decimal numbered HTML entities in argument of decimal2name() will be replaced to named HTML entities (If they're nameable).
• hex2name — some include hexadecimal numbered HTML entities in argument of hex2name() will be replaced to named HTML entities (If they're nameable).
• name2decimal_xml — some included named HTML entities in argument of name2decimal_xml() will be replaced to decimal numbered HTML entities except valid XML entities.
• name2hex_xml — some included named HTML entities in argument of name2hex_xml() will be replaced to hexadecimal numbered HTML entities except valid XML entities.

and if you'd prefer not to import them functions into the caller's namespace (valid, lowkey respecting your space 💜), you can call them as below:

use HTML::Entities::Numbered ();

$decimal = HTML::Entities::Numbered::name2decimal($str);
$hex     = HTML::Entities::Numbered::name2hex($str);
$named1  = HTML::Entities::Numbered::decimal2name($str);
$named2  = HTML::Entities::Numbered::hex2name($str);
$decimal = HTML::Entities::Numbered::name2decimal_xml($str);
$hex     = HTML::Entities::Numbered::name2hex_xml($str);

---

🎀 AUTHOR 🎀

Koichi Taniguchi <taniguchi@livedoor.jp>

Develop triggered by IKEBE Tomohiro <ikebe@cpan.org>

Many thanks to Tatsuhiko Miyagawa <miyagawa@cpan.org> — we love a shoutout 🫶

---

💖 COPYRIGHT 💖

Copyright (c) 2004 Koichi Taniguchi. Japan. All rights reserved.

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

---

🌈 SEE ALSO 🌈

HTML::Entities, <http://www.w3.org/TR/REC-html40/sgml/entities.html>

---

and that's the whole page bestie 💅 this was HTML::...mbered(3pm) from perl v5.36.0, dated 2022-10-22 ✨ she ate and left no crumbs, go convert some entities 🦋💜