Kjetil Kjernsmo > AxKit-App-TABOO-0.52 > AxKit::App::TABOO::Provider::Classification

Download:
AxKit-App-TABOO-0.52.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 0.4   Source  

NAME ^

AxKit::App::TABOO::Provider::Classification - Provider for classifiying things in TABOO

SYNOPSIS ^

In the Apache config:

  <Location /cats/>
        PerlHandler AxKit
        AxContentProvider AxKit::App::TABOO::Provider::Classification
  </Location>

DESCRIPTION ^

This is a Provider, it implements the AxKit Provider API, and therefore contains no method that anybody should use for anything. For that reason, this documentation deals with what you should expect to be returned for different URIs.

It is intended to be used to get an overview of articles, stories etc. that can be found classified into different categories, of different types.

In accordance with the TABOO philosophy, it interacts with Data objects, that are Perl objects responsible for retrieving data from a data storage, make up sensible data structures, return XML markup, etc. In contrast with the News provider, this provider mainly interacts with Plural objects to make lists of stories. Also, it doesn't deal with comments.

The rest of the documentation has yet to be written, but as one can guess, it may share some things with the NewsList Provider.

URI USAGE ^

This Provider doesn't place any constraints of what first part of the local part of the URI should be, but the XSLT that is included in the distribution does, and you should set this with e.g.

    PerlAddVar AxParamExpr cats.prefix '"/cats/"'

in the Apache config.

After that, you may simply append the catnames of categories, and the Provider will return all stories and articles classified in all those categories. Since for stories, there is a only a primary categorization, they are only displayed when there is a single category in the path.

BUGS/TODO ^

I guess this documentation could be more verbose.

SEE ALSO ^

AxKit::App::TABOO::Data::Provider::NewsList, AxKit::App::TABOO::Data::Plurals::Categories

FORMALITIES ^

See AxKit::App::TABOO.

syntax highlighting: