.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" 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" ''
. ds C`
. ds C'
'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 >0, 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.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
. if \nF \{\
. de IX
. tm Index:\\$1\t\\n%\t"\\$2"
..
. if !\nF==2 \{\
. nr % 0
. nr F 2
. \}
. \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "HTML::Microformats::Datatype::String 3pm"
.TH HTML::Microformats::Datatype::String 3pm "2021-09-12" "perl v5.32.1" "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"
HTML::Microformats::Datatype::String \- text in a particular language
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 3
\& my $string = HTML::Microformats::Datatype::String
\& \->new(\*(AqBonjour\*(Aq, \*(Aqfr\*(Aq);
\& print "$string\en";
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
.SS "Constructor"
.IX Subsection "Constructor"
.ie n .IP """$str = HTML::Microformats::Datatype::String\->new($text, [$lang])""" 4
.el .IP "\f(CW$str = HTML::Microformats::Datatype::String\->new($text, [$lang])\fR" 4
.IX Item "$str = HTML::Microformats::Datatype::String->new($text, [$lang])"
Creates a new HTML::Microformats::Datatype::String object.
.SS "Public Methods"
.IX Subsection "Public Methods"
.ie n .IP """$str\->lang""" 4
.el .IP "\f(CW$str\->lang\fR" 4
.IX Item "$str->lang"
Return the language code.
.ie n .IP """$str\->to_string""" 4
.el .IP "\f(CW$str\->to_string\fR" 4
.IX Item "$str->to_string"
Return a plain (scalar) string.
.SS "Functions"
.IX Subsection "Functions"
.ie n .IP """$str = ms($text, [$element])""" 4
.el .IP "\f(CW$str = ms($text, [$element])\fR" 4
.IX Item "$str = ms($text, [$element])"
Construct a new HTML::Microformats::Datatype::String object from a
scalar, plus XML::LibXML::Element. If \f(CW$element\fR is undef, then returns
the plain (scalar) string itself.
.Sp
This function is exported by default.
.Sp
(Note: the name 'ms' originally stood for 'Magic String'.)
.ie n .IP """isms($str)""" 4
.el .IP "\f(CWisms($str)\fR" 4
.IX Item "isms($str)"
Returns true iff \f(CW$str\fR is blessed as a HTML::Microformats::Datatype::String
object.
.Sp
This function is exported by default.
.ie n .IP """$c = concat($a, $b, [$reverse])""" 4
.el .IP "\f(CW$c = concat($a, $b, [$reverse])\fR" 4
.IX Item "$c = concat($a, $b, [$reverse])"
Concatenates two strings.
.Sp
If the language of string \f(CW$b\fR is null or the same as \f(CW$a\fR, then the
resultant string has the same language as \f(CW$a\fR. Otherwise the result
has no language.
.Sp
If \f(CW$reverse\fR is true, then the strings are concatenated with \f(CW$b\fR
preceding \f(CW$a\fR.
.Sp
This function is not exported by default.
.Sp
Can also be used as a method:
.Sp
.Vb 1
\& $c = $a\->concat($b);
.Ve
.ie n .IP """compare($a, $b)""" 4
.el .IP "\f(CWcompare($a, $b)\fR" 4
.IX Item "compare($a, $b)"
Compares two strings alphabetically. Language is ignored.
.Sp
Return values are as per 'cmp' (see perlfunc).
.Sp
This function is not exported by default.
.Sp
Can also be used as a method:
.Sp
.Vb 1
\& $a\->compare($b);
.Ve
.SH "BUGS"
.IX Header "BUGS"
Please report any bugs to .
.SH "SEE ALSO"
.IX Header "SEE ALSO"
HTML::Microformats,
HTML::Microformats::Datatype.
.SH "AUTHOR"
.IX Header "AUTHOR"
Toby Inkster .
.SH "COPYRIGHT AND LICENCE"
.IX Header "COPYRIGHT AND LICENCE"
Copyright 2008\-2012 Toby Inkster
.PP
This library is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.
.SH "DISCLAIMER OF WARRANTIES"
.IX Header "DISCLAIMER OF WARRANTIES"
\&\s-1THIS PACKAGE IS PROVIDED \*(L"AS IS\*(R" AND WITHOUT ANY EXPRESS OR IMPLIED
WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.\s0