Add support for anchors

[zeal.git] / lib / Zeal / Document.pm

diff --git a/lib/Zeal/Document.pm b/lib/Zeal/Document.pm
index f80bad8d35f5868d91050bc3a37d9f8485d8cf26..d4156702349d482ecd9e5b6b5ca03b619c44a83b 100644 (file)
--- a/lib/Zeal/Document.pm
+++ b/lib/Zeal/Document.pm
@@ -4,10 +4,10 @@ use 5.014000;
 use strict;
 use warnings;
 
-our $VERSION = '0.000_001';
+our $VERSION = '0.000_002';
 
 use parent qw/Class::Accessor::Fast/;
-__PACKAGE__->mk_accessors(qw/id name type path docset/);
+__PACKAGE__->mk_accessors(qw/id name type path anchor docset/);
 
 sub fetch {
        my ($self) = @_;
@@ -26,6 +26,11 @@ Zeal::Document - Class representing a Dash/Zeal document
 =head1 SYNOPSIS
 
   use Zeal::Document;
+  my $doc = $ds->query('perlsec'); # $ds is a Zeal::Docset instance
+  say $doc->name; # perlsec
+  say $doc->type; # Module
+  say $doc->path; # perldoc-html/perlsec.html
+  my $html = $doc->fetch; # $html is now the HTML documentation for perlsec
 
 =head1 DESCRIPTION
 
@@ -55,6 +60,10 @@ The path of this document, relative to
 F<docset_root/Contents/Resources/Documents/>. This can also be a HTTP
 URL.
 
+=item $doc->B<anchor>
+
+The URL anchor/fragment identifier of this document.
+
 =item $doc->B<fetch>
 
 The HTML content of this document, retrieved from the file system or