view release on metacpan or  search on metacpan

Wyrd/Site.pod  view on Meta::CPAN

=pod

=head1 NAME

Apache::Wyrd::Site - Wyrds for site maintenance and integration

=head1 DESCRIPTION

The Apache::Wyrd::Site::* modules present re-useable solutions to a few of
the common problems of getting a web site to be integrated and
self-maintaining.  They are kept separate from the other modules in the
Apache::Wyrd hierarchy because they follow a more rigid set of conventions
on site construction than the other modules, and would introduce
inflexibility to the other Modules if more closely integrated.

As a whole, they represent the more functional aspects of a "house style",
which makes several assumptions:

=over

=item The host system is Unix-like, following a process model

=item The apache version is < 2.0 with multiple listening processes

=item There is no more than one Wyrd namespace per virtual host

=item The site is organized hierarchically in one or more trees

=item Each tree is a "section" with a single parent node as its root

=item Each tree node is either a leaf or a joint between one or more
branches

=item Each node is a "Page", with a distinct title, subject, and contents

=item Each Page either has a parent Page or is a section root

=item Each Page exists in an HTML file, and that file's name ends with
".html"

=back

Additionally, some more attributes than the standard ones available in the
default Apache::Wyrd::Services::Index objects are used by items in the Site
hierarcy, and your instance of Apache::Wyrd::Site::Index should include
them:

=over

=item published

Date used in sorting/limiting by date.

=item parent

Docroot-relative path of the parent Page of the Page (see
Apache::Wyrd::Site::NavPull for conventions).

=item tags

Subject tokens of a given page (see Apache::Wyrd::Site::TagPull for
conventions).

=back

For these modules, the Apache::Wyrd::Site::Page object is the base unit of
the Site.  An Apache::Wyrd::Services::Index-derived object is used by the
Site to maintain the cache of meta-information on pages (N.B. One such
object is the Apache::Wyrd::Site::Index, which has some additional support
methods for objects in this hierarchy.)

The Index keeps track of all Page meta-information: what is the parent of a
page, what is its title, its publication date, etc, and also a reverse index
for certain attributes, called "maps", which designate which Pages have that
attribute (for example, which pages have the word "ocelot" on them, or which
pages are tagged "newsletter").  Following this convention, this index
object is queried for information either about a specific Page or about what
pages match a certain criterion.

Two main classes of objects relate between the Index and the Pages.  These
are the Pull classes and the Widget classes.