Changeset 1638

Timestamp:

09/02/06 01:58:50

Author:

mark

Message:

r4@travis: mark | 2006-09-01 17:57:02 +0100
attempt at adding a little more documentation

Files:

• trunk/plagger (modified) (previous)
• trunk/plagger/lib/Plagger/Date.pm (modified) (1 diff)
• trunk/plagger/lib/Plagger/Plugin.pm (modified) (1 diff)
• trunk/plagger/lib/Plagger/Template.pm (modified) (1 diff)

trunk/plagger/lib/Plagger/Date.pm

@@ -97 +97 @@
-
-1;
+
+__END__
+
+=head1 NAME
+
+Plagger::Date - DateTime subclass for Plagger
+
+=head1 SYNOPSIS
+
+
+
+=head1 DESCRIPTION
+
+This module subclasses DataTime for plagger's own needs.
+
+=over
+
+=item rebless
+
+...
+
+=item parse
+
+...
+
+=item parse_dwim
+
+...
+
+=item strptime
+
+...
+
+=item now
+
+...
+
+=item from_epoch
+
+...
+
+=item format($format)
+
+Convience method.  Returns the datetime in the format
+passed (either a formatter object or a blessed reference) 
+
+=item set_time_zone
+
+Overides default behavior to default to UTC if the passed
+time zone isn't a legal
+
+=item serialize
+
+Returns the object as a W3CDTF string.
+
+=cut
+
+=back
+
+=head1 AUTHOR
+
+Tatsuhiko Miyagawa E<lt>miyagawa@bulknews.netE<gt>
+
+See I<AUTHORS> file for the name of all the contributors.
+
+=head1 LICENSE
+
+Except where otherwise noted, Plagger is free software; you can
+redistribute it and/or modify it under the same terms as Perl itself.
+
+=head1 SEE ALSO
+
+L<http://plagger.org/>, L<DateTime>
+
+=cut

trunk/plagger/lib/Plagger/Plugin.pm

@@ -162 +162 @@
-
-1;
+
+__END__
+
+=head1 NAME
+
+Plagger::Plugin - Base class for Plagger Pluggins
+
+=head1 SYNOPSIS
+
+  package Plagger::Plugin::Something;
+  use base qw(Plagger::Plugin);
+
+  # register hooks
+  sub register {
+    my ($self, $context) = @_;
+    $context->register_hook( $self,
+       'thingy.wosit'  => $self->can('doodad'),
+    )
+  }
+  
+  sub doodad { ... }
+
+=head1 DESCRIPTION
+
+This is the base class for plagger plugins.  Pretty much everything is done
+by pluggins in Plagger.
+
+To write a new plugin, simply inherit from Plagger::Plugin:
+
+  package Plagger::Plugin;
+  use base qw(Plagger::Plugin);
+
+Then register some hooks:
+
+  # register hooks
+  sub register {
+    my ($self, $context) = @_;
+    $context->register_hook( $self,
+       'thingy.wosit'  => $self->can('doodad'),
+    )
+  }
+
+
+This means that the "doodad" method will be called at the "thingy.wosit"
+stage.
+
+=head2 Methods
+
+=over
+
+=item new
+
+Standard constructor.  Calls init.
+
+=item init
+
+Initilises the plugin
+
+=item walk_config_encryption
+
+=item do_walk
+
+=item decrypt_config
+
+=item conf
+
+=item rule
+
+=item rule_hook
+
+=item cache
+
+=item dispatch_rule_on
+
+=item class_id
+
+=item assets_dir
+
+=item log
+
+=item cookie_jar
+
+Access the Plagger::Cookies object.
+
+=item templatize
+
+=item load_assets
+
+=back
+
+=head1 AUTHOR
+
+Tatsuhiko Miyagawa E<lt>miyagawa@bulknews.netE<gt>
+
+See I<AUTHORS> file for the name of all the contributors.
+
+=head1 LICENSE
+
+Except where otherwise noted, Plagger is free software; you can
+redistribute it and/or modify it under the same terms as Perl itself.
+
+=head1 SEE ALSO
+
+L<http://plagger.org/>
+
+=cut

trunk/plagger/lib/Plagger/Template.pm

@@ -32 +32 @@
-1;
-
+__END__
+
+
+=head1 NAME
+
+Plagger::Template - Template Toolkit subclass for Plagger
+
+=head1 SYNOPSIS
+
+  From within a plagger plugin
+  $self->templatize($file, $vars);
+
+=head1 DESCRIPTION
+
+A subclass of Template Toolkit that's used by the Plagger plugins.
+As a plugin author, you really don't have to worry about this.  See the
+documentation for Plagger::Pluggin's templatize method instead.
+
+The plugin calls the custom new routine like so:
+
+  Plagger::Template->new($plagger_context, $self);
+
+Essentially this subclass uses this to know where the templates are
+from the assests path.
+
+It also does the right thing with encodings and utf8.
+
+=head1 AUTHOR
+
+Tatsuhiko Miyagawa E<lt>miyagawa@bulknews.netE<gt>
+
+See I<AUTHORS> file for the name of all the contributors.
+
+=head1 LICENSE
+
+Except where otherwise noted, Plagger is free software; you can
+redistribute it and/or modify it under the same terms as Perl itself.
+
+=head1 SEE ALSO
+
+L<http://plagger.org/>, L<Template>, L<http://tt2.org/>
+
+=cut