PerlDoc

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Perl Module:

---

Parent package: Foswiki::Plugins
Child packages:

More ...Less ...

internal package ThumbnailPlugin

This plugin will make a thumbnail of an attachment when its saved.

Preference variables: THUMBNAILPLUGIN_ENABLE : on enables thumbnail creation, default is off

THUMBNAILPLUGIN_SIZE: Size (pixels) desired, default is 150.

initPlugin($topic, $web, $user, $installWeb) → $boolean

• $topic - the name of the topic in the current CGI query
• $web - the name of the web in the current CGI query
• $user - the login name of the user
• $installWeb - the name of the web the plugin is installed in

beforeAttachmentSaveHandler(\%attrHash, $topic, $web )

• \%attrHash - reference to hash of attachment attribute values
• $topic - the name of the topic in the current CGI query
• $web - the name of the web in the current CGI query

This handler is called once when an attachment is uploaded. When this handler is called, the attachment has not been recorded in the database.

The attributes hash will include at least the following attributes:

• attachment => the attachment name
• comment - the comment
• user - the user id
• tmpFilename - name of a temporary file containing the attachment data

Since: Foswiki::Plugins::VERSION = 1.025

afterAttachmentSaveHandler(\%attrHash, $topic, $web, $error )

• \%attrHash - reference to hash of attachment attribute values
• $topic - the name of the topic in the current CGI query
• $web - the name of the web in the current CGI query
• $error - any error string generated during the save process

This handler is called just after the save action. The attributes hash will include at least the following attributes:

• attachment => the attachment name
• comment - the comment
• user - the user id

Since: Foswiki::Plugins::VERSION = 1.025

The graphics code was leveraged from CGI::Application::PhotoGallery::GD, which was originally written by Brian Cassidy, and modified for image autoration by T. Litt, who also made further changes to adapat it for this plugin.

=head1 AUTHOR

Timothe Litt Elitt@acm.org<E

Copyright 2008, 2009 by Timothe Litt

Brian Cassidy Ebricas@cpan.orgE

=head1 COPYRIGHT AND LICENSE

Copyright 2008 by Brian Cassidy

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