Barbie > Labyrinth > Labyrinth

Download:
Labyrinth-5.28.tar.gz

Dependencies

Annotate this POD

CPAN RT

Open  0
View/Report Bugs
Module Version: 5.28   Source  

NAME ^

Labyrinth - An extensible website in a box.

SYNOPSIS ^

  use Labyrinth;
  my $labyrinth = Labyrinth->new();
  $labyrinth->run();

DESCRIPTION ^

Documentation overview for Labyrinth.

Labyrinth began life in 2002, with a small set of plugins to enable various features of web site management. The core set of plugins are now available as the Labyrinth-Plugin-Core package, with this package providing the core functionality that drives the Labyrinth framework system.

See the individual files for more details on how to use them.

FUNCTIONS ^

Constructor

new()

Instantiates the Labyrinth object.

Methods

run()

Provides the dispatch loop, instantiating any configuration required, then processes each command in turn, before finally publishing the result.

load()

Loads plugins found within the plugin directory.

action($action)

Calls the appropriate plugin method.

ADDITIONAL FILES ^

Additional files are needed to enable Labyrinth and any installed plugins to work correctly. These files consist of SQL, HTML template and configuration files, together with some basic CSS and Javascript files.

Please see the Labyrinth-Demo package for a set of these files.

However, these files are only the beginning, and to implement your website, you will need to update the appropriate files to use your layout design.

ADDITION INFORMATION ^

Although Labyrinth has long been in development, documentation has not been a priority. As such much of the documentation you may need to understand how to use Labyrinth is the code itself. If you have the inclination, documentation patches would be very gratefully received.

The Labyrinth website [1] will eventually feature a documentation site, wiki and other features which are intended to provide you with the information to use and extend Labyrinth as you wish.

[1] http://labyrinth.missbarbell.co.uk

AUTHOR ^

Barbie, <barbie@missbarbell.co.uk> for Miss Barbell Productions, http://www.missbarbell.co.uk/

COPYRIGHT & LICENSE ^

  Copyright (C) 2002-2014 Barbie for Miss Barbell Productions
  All Rights Reserved.

  This module is free software; you can redistribute it and/or
  modify it under the Artistic License 2.0.
syntax highlighting: