Skip to content

Commit

Permalink
documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
@barbie
barbie committed Mar 13, 2011
1 parent 0017153 commit d50a642
Show file tree
Hide file tree
Showing 18 changed files with 194 additions and 99 deletions.
3 changes: 3 additions & 0 deletions Changes
View file
@@ -1,5 +1,8 @@
Changes for the Labyrinth Core Plugins

5.06 13/03/2011
- updated documentation.

5.05 24/02/2011
- update Articles to better support limit, stop and order from plugins.

Expand Down
30 changes: 15 additions & 15 deletions META.json
View file
@@ -1,6 +1,6 @@
{
"name": "Labyrinth::Plugin::Core",
"version": "5.05",
"version": "5.06",
"abstract": "Labyrinth Website Management Framework Core Plugins",
"author": [
"Barbie (BARBIE) <barbie@cpan.org>"
Expand Down Expand Up @@ -51,59 +51,59 @@
"provides": {
"Labyrinth::Plugin::Articles": {
"file": "lib/Labyrinth/Plugin/Articles.pm",
"version": "5.05"
"version": "5.06"
},
"Labyrinth::Plugin::Articles::Sections": {
"file": "lib/Labyrinth/Plugin/Articles/Sections.pm",
"version": "5.05"
"version": "5.06"
},
"Labyrinth::Plugin::Articles::Site": {
"file": "lib/Labyrinth/plugin/Articles/Site.pm",
"version": "5.05"
"version": "5.06"
},
"Labyrinth::Plugin::Content": {
"file": "lib/Labyrinth/Plugin/Content.pm",
"version": "5.05"
"version": "5.06"
},
"Labyrinth::Plugin::Core": {
"file": "lib/Labyrinth/Plugin/Core.pm",
"version": "5.05"
"version": "5.06"
},
"Labyrinth::Plugin::Folders": {
"file": "lib/Labyrinth/Plugin/Folders.pm",
"version": "5.05"
"version": "5.06"
},
"Labyrinth::Plugin::Groups": {
"file": "lib/Labyrinth/Plugin/Groups.pm",
"version": "5.05"
"version": "5.06"
},
"Labyrinth::Plugin::Hits": {
"file": "lib/Labyrinth/Plugin/Hits.pm",
"version": "5.05"
"version": "5.06"
},
"Labyrinth::Plugin::Images": {
"file": "lib/Labyrinth/Plugin/Images.pm",
"version": "5.05"
"version": "5.06"
},
"Labyrinth::Plugin::Inbox": {
"file": "lib/Labyrinth/Plugin/Inbox.pm",
"version": "5.05"
"version": "5.06"
},
"Labyrinth::Plugin::Menus": {
"file": "lib/Labyrinth/Plugin/Menus.pm",
"version": "5.05"
"version": "5.06"
},
"Labyrinth::Plugin::News": {
"file": "lib/Labyrinth/Plugin/News.pm",
"version": "5.05"
"version": "5.06"
},
"Labyrinth::Plugin::Users": {
"file": "lib/Labyrinth/Plugin/Users.pm",
"version": "5.05"
"version": "5.06"
},
"Labyrinth::Plugin::Users::Info": {
"file": "lib/Labyrinth/Plugin/Users/Info.pm",
"version": "5.05"
"version": "5.06"
}
},
"no_index": {
Expand Down
30 changes: 15 additions & 15 deletions META.yml
View file
@@ -1,6 +1,6 @@
--- #YAML:1.0
name: Labyrinth::Plugin::Core
version: 5.05
version: 5.06
abstract: Labyrinth Website Management Framework Core Plugins
author:
- Barbie <barbie@cpan.org>
Expand Down Expand Up @@ -31,46 +31,46 @@ build_requires:
provides:
Labyrinth::Plugin::Articles:
file: lib/Labyrinth/Plugin/Articles.pm
version: 5.05
version: 5.06
Labyrinth::Plugin::Articles::Sections:
file: lib/Labyrinth/Plugin/Articles/Sections.pm
version: 5.05
version: 5.06
Labyrinth::Plugin::Articles::Site:
file: lib/Labyrinth/Plugin/Articles/Site.pm
version: 5.05
version: 5.06
Labyrinth::Plugin::Content:
file: lib/Labyrinth/Plugin/Content.pm
version: 5.05
version: 5.06
Labyrinth::Plugin::Core:
file: lib/Labyrinth/Plugin/Core.pm
version: 5.05
version: 5.06
Labyrinth::Plugin::Folders:
file: lib/Labyrinth/Plugin/Folders.pm
version: 5.05
version: 5.06
Labyrinth::Plugin::Groups:
file: lib/Labyrinth/Plugin/Groups.pm
version: 5.05
version: 5.06
Labyrinth::Plugin::Hits:
file: lib/Labyrinth/Plugin/Hits.pm
version: 5.05
version: 5.06
Labyrinth::Plugin::Images:
file: lib/Labyrinth/Plugin/Images.pm
version: 5.05
version: 5.06
Labyrinth::Plugin::Inbox:
file: lib/Labyrinth/Plugin/Inbox.pm
version: 5.05
version: 5.06
Labyrinth::Plugin::Menus:
file: lib/Labyrinth/Plugin/Menus.pm
version: 5.05
version: 5.06
Labyrinth::Plugin::News:
file: lib/Labyrinth/Plugin/News.pm
version: 5.05
version: 5.06
Labyrinth::Plugin::Users:
file: lib/Labyrinth/Plugin/Users.pm
version: 5.05
version: 5.06
Labyrinth::Plugin::Users::Info:
file: lib/Labyrinth/Plugin/Users/Info.pm
version: 5.05
version: 5.06

no_index:
directory:
Expand Down
4 changes: 2 additions & 2 deletions README
View file
Expand Up @@ -55,8 +55,8 @@ COPYRIGHT & LICENSE
Copyright (C) 2002-2011 Barbie for Miss Barbell Productions
All Rights Reserved.

This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
This module is free software; you can redistribute it and/or
modify it under the Artistic License 2.0.



Expand Down
75 changes: 62 additions & 13 deletions lib/Labyrinth/Plugin/Articles.pm
View file
Expand Up @@ -3,15 +3,16 @@ package Labyrinth::Plugin::Articles;
use warnings;
use strict;

my $VERSION = '5.05';
my $VERSION = '5.06';

=head1 NAME
Labyrinth::Plugin::Articles - Plugin Articles handler for Labyrinth
=head1 DESCRIPTION
Contains all the article handling functionality
Contains all the default article handling functionality for the Labyrinth
framework.
=cut

Expand Down Expand Up @@ -91,7 +92,14 @@ my $LEVEL2 = ADMIN;
# however, the default is also a standard article.
my $SECTIONID = 1;

=head1 SECTION IDs
=head1 CONFIGURATION
The Articles package is meant to be used as a base package providing default
configuration and functionality for article based content. It is expected that
that a plugin will use this package as a base, and override configuration and
methods as required.
=head2 Section IDs
It is recommended that the following be used to differentiate the types of
sections, for which articles are used to provide the underlying structure.
Expand All @@ -110,42 +118,64 @@ plugins.
7 = lyrics (see Articles::Lyrics)
8 = discographies (see Articles::Discography)
Note that some plugins mentioned above may not be currently available, however
all are planned for release.
=head2 SQL Phrases
Several keys used to access SQL phrases can be overriden. These default keys
are used in the event that only basic configuration overrides are needed, such
as the Section ID.
Key variables available are:
our $INDEXKEY = 'articleid';
our $ALLSQL = 'AllArticles';
our $SAVESQL = 'SaveArticle';
our $ADDSQL = 'AddArticle';
our $GETSQL = 'GetArticleByID';
our $DELETESQL = 'DeleteRecords';
our $PROMOTESQL = 'PromoteArticle';
our $LEVEL = EDITOR;
=cut

# -------------------------------------
# The Subs

=head1 PUBLIC INTERFACE METHODS
=over 4
=item LatestArticles()
=item LatestArticles
Gets a list of the latest article titles
=item Archive()
=item Archive
Gets a list of the volumes available.
=item List()
=item List
Gets a list of articles.
=item Meta()
=item Meta
Gets a list of articles based on given meta tags.
=item Search()
=item Search
Gets a list of articles based on a given search string.
=item Cloud()
=item Cloud
Gets current tag cloud.
=item Tags()
=item Tags
Gets the current list of meta tags
=item Item()
=item Item
Gets a single article.
Expand Down Expand Up @@ -337,20 +367,39 @@ sub Item {
=item Admin
Lists the current set of articles for the given section.
Also provides the delete, copy and promote functionality from the main
administration page for the given section.
=item Add
Add an article to the current section.
=item Edit
Edit an article within the current section.
=item AddParagraph
Add a text block to the current article.
=item AddImage
Add an image block to the current article.
=item AddLink
Add a link block to the current article.
=item DeleteItem
Delete an article.
=item Relocate
Relocate an article in a list, where an order is in use.
=item LoadContent
=item EditAmendments
Expand Down Expand Up @@ -902,7 +951,7 @@ __END__
=head1 SEE ALSO
Labyrinth
L<Labyrinth>
=head1 AUTHOR
Expand All @@ -915,6 +964,6 @@ Miss Barbell Productions, L<http://www.missbarbell.co.uk/>
All Rights Reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
modify it under the Artistic License 2.0.
=cut
9 changes: 5 additions & 4 deletions lib/Labyrinth/Plugin/Articles/Sections.pm
View file
Expand Up @@ -4,15 +4,16 @@ use warnings;
use strict;

use vars qw($VERSION $ALLSQL $SECTIONID);
$VERSION = '5.05';
$VERSION = '5.06';

=head1 NAME
Labyrinth::Plugin::Articles::Sections - Sections handler plugin for Labyrinth
=head1 DESCRIPTION
Contains all the section handling functionality
Contains all the section handling functionality for the Labyrinth
framework.
=cut

Expand Down Expand Up @@ -134,7 +135,7 @@ __END__
=head1 SEE ALSO
Labyrinth
L<Labyrinth>
=head1 AUTHOR
Expand All @@ -147,6 +148,6 @@ Miss Barbell Productions, L<http://www.missbarbell.co.uk/>
All Rights Reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
modify it under the Artistic License 2.0.
=cut
7 changes: 4 additions & 3 deletions lib/Labyrinth/Plugin/Articles/Site.pm
View file
Expand Up @@ -3,15 +3,16 @@ package Labyrinth::Plugin::Articles::Site;
use warnings;
use strict;

my $VERSION = '5.05';
my $VERSION = '5.06';

=head1 NAME
Labyrinth::Plugin::Articles::Site - Site Pages handler plugin for Labyrinth
=head1 DESCRIPTION
Contains all the site pages handling functionality
Contains all the site pages handling functionality for the Labyrinth
framework.
=cut

Expand Down Expand Up @@ -200,6 +201,6 @@ Miss Barbell Productions, L<http://www.missbarbell.co.uk/>
All Rights Reserved.
This module is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
modify it under the Artistic License 2.0.
=cut

0 comments on commit d50a642

Please sign in to comment.