]>
iEval git - zeal.git/blob - lib/Zeal/Document.pm
1 package Zeal
::Document
;
7 our $VERSION = '0.001';
9 use parent qw
/Class::Accessor::Fast/;
10 __PACKAGE__
->mk_accessors(qw
/id name type path anchor docset/);
14 $self->docset->fetch($self->path)
24 Zeal::Document - Class representing a Dash/Zeal document
29 my $doc = $ds->query('perlsec'); # $ds is a Zeal::Docset instance
30 say $doc->name; # perlsec
31 say $doc->type; # Module
32 say $doc->path; # perldoc-html/perlsec.html
33 my $html = $doc->fetch; # $html is now the HTML documentation for perlsec
37 Dash is an offline API documentation browser. Zeal::Document is a class
38 representing a Dash/Zeal document.
46 The ID of this document. Not typically interesting.
50 The name of this document.
54 The type of this document. The list of types is available on
55 the Dash website: L<http://kapeli.com/docsets#supportedentrytypes>
59 The path of this document, relative to
60 F<docset_root/Contents/Resources/Documents/>. This can also be a HTTP
65 The URL anchor/fragment identifier of this document.
69 The HTML content of this document, retrieved from the file system or
76 L<Zeal>, L<http://kapeli.com/dash>, L<http://zealdocs.org>
80 Marius Gavrilescu, E<lt>marius@ieval.roE<gt>
82 =head1 COPYRIGHT AND LICENSE
84 Copyright (C) 2014-2015 by Marius Gavrilescu
86 This library is free software; you can redistribute it and/or modify
87 it under the same terms as Perl itself, either Perl version 5.20.1 or,
88 at your option, any later version of Perl 5 you may have available.
This page took 0.061094 seconds and 4 git commands to generate.