Commits

Toby Inkster committed 18c9be4

Documentation improvements.

Comments (0)

Files changed (2)

+NAME
+    WWW::Finger - Get useful data from e-mail addresses
+
+VERSION
+    0.01
+
+SYNOPSIS
+      use WWW::Finger;
+  
+      my $finger = WWW::Finger->new("joe@example.com");
+  
+      if (defined $finger)
+      {
+        print $finger->name . "\n";
+      }
+
+DESCRIPTION
+    This module is *not* an implementation of the finger protocol (RFC 1288).
+    Use Net::Finger for that. Instead it is a set of implementations of
+    *other* methods for getting information from an e-mail address, or
+    e-mail-like identifier. This package includes three such implementations,
+    and it's pretty easy to create your own additional implementations:
+
+    *       WebFinger
+
+    *       Fingerpoint
+
+    *       cpan.org scraper (for user@cpan.org)
+
+  Constructor
+    *       "new"
+
+              $finger = WWW::Finger->new($identifier);
+
+            Creates a WWW::Finger object for a particular identifier. Will
+            return undef if no implemetation is able to handle the identifier
+
+  Object Methods
+    Some or all of these methods may return undef. The "name", "mbox",
+    "homepage", "weblog", "image" and "key" methods work in both scalar and
+    list context. Depending on which implementation was used by
+    "WWW::Finger::new", the object may also have additional methods. Consult
+    the documentation for the various implementations for details.
+
+    "name"  The person's name (or handle/nickname).
+
+    "mbox"  The person's e-mail address (including "mailto:").
+
+    "homepage"
+            The person's personal homepage.
+
+    "weblog"
+            The person's blog. (There may be some overlap with "homepage".)
+
+    "image" An avatar, photo or other image depicting the person.
+
+    "key"   The URL of the person's GPG/PGP public key.
+
+    "webid" A URI uniquely identifying the person. See
+            <http://esw.w3.org/topic/WebID>.
+
+    "endpoint"
+            A SPARQL Protocol endpoint which may provide additional data about
+            the person. (See RDF::Query::Client.)
+
+    "graph" An RDF::Trine::Model object holding data about the person. (See
+            RDF::Trine.)
+
+SEE ALSO
+    Net::Finger.
+
+    <http://code.google.com/p/webfinger/>.
+
+    <http://buzzword.org.uk/2009/fingerpoint/spec>.
+
+    <http://www.perlrdf.org/>.
+
+AUTHOR
+    Toby Inkster, <tobyink@cpan.org>
+
+COPYRIGHT AND LICENSE
+    Copyright (C) 2009 by Toby Inkster
+
+    This library is free software; you can redistribute it and/or modify it
+    under the same terms as Perl itself, either Perl version 5.8.1 or, at your
+    option, any later version of Perl 5 you may have available.
+

lib/WWW/Finger.pm

 	my @Modules = ();
 }
 
+
 sub new
 {
 	my $class      = shift;
 sub graph    { return undef; }
 
 1;
+
+__END__
+# Below is stub documentation for your module. You'd better edit it!
+
+=head1 NAME
+
+WWW::Finger - Get useful data from e-mail addresses
+
+=head1 VERSION
+
+0.01
+
+=head1 SYNOPSIS
+
+  use WWW::Finger;
+  
+  my $finger = WWW::Finger->new("joe@example.com");
+  
+  if (defined $finger)
+  {
+    print $finger->name . "\n";
+  }
+
+=head1 DESCRIPTION
+
+This module is I<not> an implementation of the finger protocol (RFC 1288). Use
+Net::Finger for that. Instead it is a set of implementations of I<other> methods
+for getting information from an e-mail address, or e-mail-like identifier. This package
+includes three such implementations, and it's pretty easy to create your own
+additional implementations:
+
+=over 8
+
+=item * WebFinger
+
+=item * Fingerpoint
+
+=item * cpan.org scraper (for user@cpan.org)
+
+=back
+
+=head2 Constructor
+
+=over 8
+
+=item * C<new>
+
+  $finger = WWW::Finger->new($identifier);
+
+Creates a WWW::Finger object for a particular identifier. Will return undef
+if no implemetation is able to handle the identifier
+
+=back
+
+=head2 Object Methods
+
+Some or all of these methods may return undef. The C<name>, C<mbox>,
+C<homepage>, C<weblog>, C<image> and C<key> methods work in both scalar
+and list context. Depending on which implementation was used by
+C<WWW::Finger::new>, the object may also have additional methods. Consult
+the documentation for the various implementations for details.
+
+=over 8
+
+=item C<name>
+
+The person's name (or handle/nickname).
+
+=item C<mbox>
+
+The person's e-mail address (including "mailto:").
+
+=item C<homepage>
+
+The person's personal homepage.
+
+=item C<weblog>
+
+The person's blog. (There may be some overlap with C<homepage>.)
+
+=item C<image>
+
+An avatar, photo or other image depicting the person.
+
+=item C<key>
+
+The URL of the person's GPG/PGP public key.
+
+=item C<webid>
+
+A URI uniquely identifying the person. See L<http://esw.w3.org/topic/WebID>.
+
+=item C<endpoint>
+
+A SPARQL Protocol endpoint which may provide additional data about the person.
+(See L<RDF::Query::Client>.)
+
+=item C<graph>
+
+An RDF::Trine::Model object holding data about the person. (See L<RDF::Trine>.)
+
+=back
+
+=head1 SEE ALSO
+
+L<Net::Finger>.
+
+L<http://code.google.com/p/webfinger/>.
+
+L<http://buzzword.org.uk/2009/fingerpoint/spec>.
+
+L<http://www.perlrdf.org/>.
+
+=head1 AUTHOR
+
+Toby Inkster, E<lt>tobyink@cpan.orgE<gt>
+
+=head1 COPYRIGHT AND LICENSE
+
+Copyright (C) 2009 by Toby Inkster
+
+This library is free software; you can redistribute it and/or modify
+it under the same terms as Perl itself, either Perl version 5.8.1 or,
+at your option, any later version of Perl 5 you may have available.
+
+=cut
+