← Back to branch summary

~ubuntu-branches/ubuntu/trusty/libxml-libxml-perl/trusty-security

« back to all changes in this revision

Viewing changes to lib/XML/LibXML/Common.pod

  • Committer: Package Import Robot
  • Author(s): Alessandro Ghedini
  • Date: 2012-10-16 14:10:26 UTC
  • mfrom: (1.2.26)
  • Revision ID: package-import@ubuntu.com-20121016141026-3x0th9su7cue9hl0
Tags: 2.0006+dfsg-1
* New upstream release
* Refresh patches
* Bump Standards-Version to 3.9.4 (no changes needed)

Show diffs side-by-side

added added

removed removed

Lines of Context:
lib/XML/LibXML/Common.pod
14
14
=head1 DESCRIPTION
15
15
 
16
16
XML::LibXML::Common defines constants for all node types and provides interface
17
 
to libxml2 charset conversion functions. 
 
17
to libxml2 charset conversion functions.
18
18
 
19
19
Since XML::LibXML use their own node type definitions, one may want to use
20
 
XML::LibXML::Common in its compatibility mode: 
 
20
XML::LibXML::Common in its compatibility mode:
21
21
 
22
22
 
23
23
=head2 Exporter TAGS
47
47
  use XML::LibXML::Common qw(:encoding);
48
48
 
49
49
This tag can be used to export only the charset encoding functions of
50
 
XML::LibXML::Common. 
 
50
XML::LibXML::Common.
51
51
 
52
52
 
53
53
=head2 Exports
54
54
 
55
55
By default the W3 definitions as defined in the DOM specifications and the
56
 
encoding functions are exported by XML::LibXML::Common. 
 
56
encoding functions are exported by XML::LibXML::Common.
57
57
 
58
58
 
59
59
=head2 Encoding functions
60
60
 
61
61
To encode or decode a string to or from UTF-8, XML::LibXML::Common exports two
62
62
functions, which provide an interface to the encoding support in C<<<<<< libxml2 >>>>>>. Which encodings are supported by these functions depends on how C<<<<<< libxml2 >>>>>> was compiled. UTF-16 is always supported and on most installations, ISO
63
 
encodings are supported as well. 
 
63
encodings are supported as well.
64
64
 
65
65
This interface was useful for older versions of Perl. Since Perl >= 5.8
66
 
provides similar functions via the C<<<<<< Encode >>>>>> module, it is probably a good idea to use those instead. 
 
66
provides similar functions via the C<<<<<< Encode >>>>>> module, it is probably a good idea to use those instead.
67
67
 
68
68
=over 4
69
69
 
81
81
 
82
82
This function converts an UTF-8 encoded character string to a specified
83
83
encoding. Note that the conversion can raise an error if the given string
84
 
contains characters that cannot be represented in the target encoding. 
 
84
contains characters that cannot be represented in the target encoding.
85
85
 
86
86
 
87
87
 
99
99
distribution, intended to provide functionality shared between XML::LibXML,
100
100
XML::GDOME, and possibly other modules. Since there seems to be no progress in
101
101
this direction, we decided to merge XML::LibXML::Common 0.13 and XML::LibXML
102
 
1.70 to one CPAN distribution. 
 
102
1.70 to one CPAN distribution.
103
103
 
104
104
The merge also naturally eliminates a practical and urgent problem experienced
105
105
by many XML::LibXML users on certain platforms, namely mysterious misbehavior
106
106
of XML::LibXML occurring if the installed (often pre-packaged) version of
107
107
XML::LibXML::Common was compiled against an older version of libxml2 than
108
 
XML::LibXML. 
 
108
XML::LibXML.
109
109
 
110
110
=head1 AUTHORS
111
111
 
112
 
Matt Sergeant, 
113
 
Christian Glahn, 
 
112
Matt Sergeant,
 
113
Christian Glahn,
114
114
Petr Pajas
115
115
 
116
116
 
117
117
=head1 VERSION
118
118
 
119
 
2.0004
 
119
2.0006
120
120
 
121
121
=head1 COPYRIGHT
122
122