GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  BIO::PHYLO::NEXML::ENTITIES (3)

.ds Aq ’

NAME

Bio::Phylo::NeXML::Entities - Functions for dealing with XML entities

CONTENTS

DESCRIPTION

This package provides subroutines for dealing with characters that need to be encoded as XML entities, and decoded in other formats. For example: & needs to be encoded as & in XML. The subroutines have the same signatures and the same names as those in the commonly-used module HTML::Entities. They are re-implemented here to avoid introducing dependencies.

SUBROUTINES

The following subroutines are utility functions that can be imported using:



 use Bio::Phylo::NeXML::Entities /entities/;



encode_entities Encodes problematic characters as XML entities



 Type    : Utility function
 Title   : encode_entities
 Usage   : my $encoded = encode_entities(string with & or >,>&)
 Function: Encodes entities in first argument string
 Returns : Modified string
 Args    : Required, first argument: a string to encode
           Optional, second argument: a string that specifies
           which characters to encode



decode_entities Decodes XML entities into the characters they code for



 Type    : Utility function
 Title   : decode_entities
 Usage   : my $decoded = decode_entities(string with & or >)
 Function: decodes encoded entities in argument string(s)
 Returns : Array of decoded strings
 Args    : One or more encoded strings



SEE ALSO

There is a mailing list at <https://groups.google.com/forum/#!forum/bio-phylo> for any user or developer questions and discussions.
Bio::Phylo::Manual Also see the manual: Bio::Phylo::Manual and <http://rutgervos.blogspot.com>.

CITATION

If you use Bio::Phylo in published research, please cite it:

<B>Rutger A VosB>, <B>Jason CaravasB>, <B>Klaas HartmannB>, <B>Mark A JensenB> and <B>Chase MillerB>, 2011. Bio::Phylo - phyloinformatic analysis using Perl. BMC Bioinformatics <B>12B>:63. <http://dx.doi.org/10.1186/1471-2105-12-63>

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 BIO::PHYLO::NEXML::ENTITIES (3) 2014-02-08

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.