Hinrik Örn Sigurðsson > grok > App::Grok::Resource::Spec

Download:
grok-0.26.tar.gz

Dependencies

Annotate this POD

Website

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 0.26   Source  

NAME ^

App::Grok::Resource::Spec - Perl 6 specification resource for grok

SYNOPSIS ^

 use strict;
 use warnings;
 use App::Grok::Resource::Spec qw<:ALL>;

 # list of all Synopsis, Exegeses, etc
 my @index = spec_index();

 # get the contents of Synopsis 02
 my $pod = spec_fetch('s02');

 # filename containing S02
 my $file = spec_locate('s02');

DESCRIPTION ^

This module the locates Apocalypses, Exegeses, Synopsis and magazine articles distributed with Perl6::Doc.

It also includes user documentation like perlintro and perlsyn.

FUNCTIONS ^

spec_update

Takes no arguments. Downloads the latest specifications (Synopses) into grok's data dir.

spec_index

Doesn't take any arguments. Returns a list of all documents known to this resource.

spec_fetch

Takes the name of a document as an argument. It is case-insensitive and you only need to specify the first three characters (though more are allowed), e.g. spec_fetch('s02'). Returns the Pod text of the document.

spec_locate

Takes the same argument as spec_fetch. Returns the filename corresponding to the given document.

syntax highlighting: