/ 
Zeal-0.001001
River stage zero No dependents
/ Zeal::Document

NAME

Zeal::Document - Class representing a Dash/Zeal document

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

DESCRIPTION

Dash is an offline API documentation browser. Zeal::Document is a class representing a Dash/Zeal document.

Available methods:

$doc->id

The ID of this document. Not typically interesting.

$doc->name

The name of this document.

$doc->type

The type of this document. The list of types is available on the Dash website: http://kapeli.com/docsets#supportedentrytypes

$doc->path

The path of this document, relative to docset_root/Contents/Resources/Documents/. This can also be a HTTP URL.

$doc->anchor

The URL anchor/fragment identifier of this document.

$doc->fetch

The HTML content of this document, retrieved from the file system or via HTTP::Tiny.

SEE ALSO

Zeal, http://kapeli.com/dash, http://zealdocs.org

AUTHOR

Marius Gavrilescu, <marius@ieval.ro>

COPYRIGHT AND LICENSE

Copyright (C) 2014-2015 by Marius Gavrilescu

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.20.1 or, at your option, any later version of Perl 5 you may have available.