debian man page for html::microformats::datatype::string

HTML::Microformats::Datatype::String(3pm)		User Contributed Perl Documentation		 HTML::Microformats::Datatype::String(3pm)

NAME
       HTML::Microformats::Datatype::String - text in a particular language

SYNOPSIS
	my $string = HTML::Microformats::Datatype::String
		       ->new('Bonjour', 'fr');
	print "$string
";

DESCRIPTION
   Constructor
       "$str = HTML::Microformats::Datatype::String->new($text, [$lang])"
	   Creates a new HTML::Microformats::Datatype::String object.

   Public Methods
       "$str->lang"
	   Return the language code.

       "$str->to_string"
	   Return a plain (scalar) string.

   Functions
       "$str = ms($text, [$element])"
	   Construct a new HTML::Microformats::Datatype::String object from a scalar, plus XML::LibXML::Element. If $element is undef, then
	   returns the plain (scalar) string itself.

	   This function is exported by default.

	   (Note: the name 'ms' originally stood for 'Magic String'.)

       "isms($str)"
	   Returns true iff $str is blessed as a HTML::Microformats::Datatype::String object.

	   This function is exported by default.

       "$c = concat($a, $b, [$reverse])"
	   Concatenates two strings.

	   If the language of string $b is null or the same as $a, then the resultant string has the same language as $a. Otherwise the result has
	   no language.

	   If $reverse is true, then the strings are concatenated with $b preceding $a.

	   This function is not exported by default.

	   Can also be used as a method:

	    $c = $a->concat($b);

       "compare($a, $b)"
	   Compares two strings alphabetically. Language is ignored.

	   Return values are as per 'cmp' (see perlfunc).

	   This function is not exported by default.

	   Can also be used as a method:

	    $a->compare($b);

BUGS
       Please report any bugs to <http://rt.cpan.org/>.

SEE ALSO
       HTML::Microformats, HTML::Microformats::Datatype.

AUTHOR
       Toby Inkster <tobyink@cpan.org>.

COPYRIGHT
       Copyright 2008-2011 Toby Inkster

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

DISCLAIMER OF WARRANTIES
       THIS PACKAGE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
       MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.

perl v5.14.2							    2011-12-06				 HTML::Microformats::Datatype::String(3pm)