HTML::Entities man page on HP-UX

Man page or keyword search:  
man Server   10987 pages
apropos Keyword Search (all sections)
Output format
HP-UX logo
[printable version]

HTML::Entities(3)     User Contributed Perl Documentation    HTML::Entities(3)

       HTML::Entities - Encode or decode strings with HTML entities

	use HTML::Entities;

	$a = "Våre norske tegn bør æres";
	encode_entities($a, "\200-\377");

       For example, this:

	$input = "vis-�-vis Beyonc�'s na�ve\npapier-m�ch� r�sum�";
	print encode_entities($input), "\n"

       Prints this out:

	vis-à-vis Beyoncé's naïve
	papier-mâché résumé

       This module deals with encoding and decoding of strings with HTML char‐
       acter entities.	The module provides the following functions:

       decode_entities( $string, ... )
	   This routine replaces HTML entities found in the $string with the
	   corresponding Unicode character.  Under perl 5.6 and earlier only
	   characters in the Latin-1 range are replaced. Unrecognized entities
	   are left alone.

	   If multiple strings are provided as argument they are each decoded
	   separately and the same number of strings are returned.

	   If called in void context the arguments are decoded in-place.

	   This routine is exported by default.

       _decode_entities( $string, \%entity2char )
       _decode_entities( $string, \%entity2char, $expand_prefix )
	   This will in-place replace HTML entities in $string.	 The
	   %entity2char hash must be provided.	Named entities not found in
	   the %entity2char hash are left alone.  Numeric entities are
	   expanded unless their value overflow.

	   The keys in %entity2char are the entity names to be expanded and
	   their values are what they should expand into.  The values do not
	   have to be single character strings.	 If a key has ";" as suffix,
	   then occurrences in $string are only expanded if properly termi‐
	   nated with ";".  Entities without ";" will be expanded regardless
	   of how they are terminated for compatiblity with how common
	   browsers treat entities in the Latin-1 range.

	   If $expand_prefix is TRUE then entities without trailing ";" in
	   %entity2char will even be expanded as a prefix of a longer unrecog‐
	   nized name.	The longest matching name in %entity2char will be
	   used. This is mainly present for compatibility with an MSIE misfea‐

	      $string = "foo bar";
	      _decode_entities($string, { nb => "@", nbsp => "\xA0" }, 1);
	      print $string;  # will print "foo�bar"

	   This routine is exported by default.

       encode_entities( $string )
       encode_entities( $string, $unsafe_chars )
	   This routine replaces unsafe characters in $string with their
	   entity representation. A second argument can be given to specify
	   which characters to consider unsafe (i.e., which to escape). The
	   default set of characters to encode are control chars, high-bit
	   chars, and the "<", "&", ">", "'" and """ characters.  But this,
	   for example, would encode just the "<", "&", ">", and """ charac‐

	     $encoded = encode_entities($input, '<>&"');

	   This routine is exported by default.

       encode_entities_numeric( $string )
       encode_entities_numeric( $string, $unsafe_chars )
	   This routine works just like encode_entities, except that the
	   replacement entities are always "&#xhexnum;" and never "&entname;".
	   For example, "encode_entities("r\xF4le")" returns "rôle", but
	   "encode_entities_numeric("r\xF4le")" returns "rôle".

	   This routine is not exported by default.  But you can always export
	   it with "use HTML::Entities qw(encode_entities_numeric);" or even
	   "use HTML::Entities qw(:DEFAULT encode_entities_numeric);"

       All these routines modify the string passed as the first argument, if
       called in a void context.  In scalar and array contexts, the encoded or
       decoded string is returned (without changing the input string).

       If you prefer not to import these routines into your namespace, you can
       call them as:

	 use HTML::Entities ();
	 $decoded = HTML::Entities::decode($a);
	 $encoded = HTML::Entities::encode($a);
	 $encoded = HTML::Entities::encode_numeric($a);

       The module can also export the %char2entity and the %entity2char
       hashes, which contain the mapping from all characters to the corre‐
       sponding entities (and vice versa, respectively).

       Copyright 1995-2006 Gisle Aas. All rights reserved.

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

perl v5.8.8			  2006-04-26		     HTML::Entities(3)

List of man pages available for HP-UX

Copyright (c) for man pages and the logo by the respective OS vendor.

For those who want to learn more, the polarhome community provides shell access and support.

[legal] [privacy] [GNU] [policy] [cookies] [netiquette] [sponsors] [FAQ]
Polarhome, production since 1999.
Member of Polarhome portal.
Based on Fawad Halim's script.
Vote for polarhome
Free Shell Accounts :: the biggest list on the net