Add myself to CONTRIBUTORS

[scpubgit/HTML-String.git] / lib / HTML / String.pm

diff --git a/lib/HTML/String.pm b/lib/HTML/String.pm
index a320a69..038c396 100644 (file)
--- a/lib/HTML/String.pm
+++ b/lib/HTML/String.pm
@@ -4,6 +4,10 @@ use strictures 1;
 use HTML::String::Value;
 use Exporter 'import';
 
+our $VERSION = '1.000002'; # 1.0.2
+
+$VERSION = eval $VERSION;
+
 our @EXPORT = qw(html);
 
 sub html {
@@ -26,7 +30,7 @@ HTML::String - mark strings as HTML to get auto-escaping
   
   my $html = html('<h1>').$not_html.html('</h1>');
   
-  print html($html); # <h1>Hello, Bob &quot; Jake</h1>
+  print html($html); # <h1>Hello, Bob &amp; Jake</h1>
 
 or, alternatively,
 
@@ -39,7 +43,7 @@ or, alternatively,
     "<h1>${not_html}</h1>";
   }
   
-  print html($html); # <h1>Hello, Bob &quot; Jake</h1>
+  print html($html); # <h1>Hello, Bob &amp; Jake</h1>
 
 (but see the L<HTML::String::Overload> documentation for details and caveats).
 
@@ -114,6 +118,19 @@ L<HTML::String::Overload> for more details.
 
 For integration with L<Template Toolkit|Template>, see L<HTML::String::TT>.
 
+=head1 CHARACTERS THAT WILL BE ESCAPED
+
+HTML::String concerns itself with characters that have special meaning in
+HTML. Those which begin and end tags (< and >), those which begin an entity
+(&) and those which delimit attribute values (" and '). It outputs them
+in a fashion compatible with HTML 4 and newer and all versions of XHTML
+(assuming support for named entities in the parser). There are no known
+incompatibilities with browsers. 
+
+HTML::String does not concern itself with other characters, it is assumed
+that HTML documents will be marked with a suitable character encoding via
+a Content-Type HTTP header and/or a meta element.
+
 =head1 EXPORTS
 
 =head2 html
@@ -140,7 +157,8 @@ mst - Matt S. Trout (cpan:MSTROUT) <mst@shadowcat.co.uk>
 
 =head1 CONTRIBUTORS
 
-None yet - maybe this software is perfect! (ahahahahahahahahaha)
+dorward - David Dorward (cpan:DORWARD) <david@dorward.me.uk>
+rafl - Florian Ragwitz (cpan:FLORA) <rafl@debian.org>
 
 =head1 COPYRIGHT