1Kwiki::Attachments(3) User Contributed Perl DocumentationKwiki::Attachments(3)
2
3
4

NAME

6       Kwiki::Attachments - Kwiki Page Attachments Plugin
7

SYNOPSIS

9       1. Install Kwiki::Attachments
10       2. Run 'kwiki -add Kwiki::Attachments'
11

DESCRIPTION

13       General
14
15       Kwiki::Attachments gives a Kwiki wiki the ability to upload, store and
16       manage file attachments on any page. By default, if you have an image
17       creation module such as Imager or Image::Magick installed, then a
18       thumbnail will be created for every supported image file type that is
19       uploaded. Thumbnails are displayed on the attachments page, and can
20       also be displayed on wiki pages via the wafl directives described in
21       the next paragraph. The thumbnail files have "thumb_" prepended to the
22       original filename and are not displayed separately  in the attachment
23       page or widget. For this reason, you cannot upload files beginning with
24       "thumb_".
25
26       WAFL
27
28       This module provides 3 wafl tags which can be used to link to or
29       display attachments in a Kwiki page.
30
31       ·   "{file:[page/]filename}" creates a link to attachment filename.
32
33       ·   "{img:[page/]filename}" displays attachment filename.
34
35       ·   "{thumb:[page/]filename}" displays the thumbnail for attachment
36           filename.
37
38       Configuration Options
39
40       [kwiki_base_dir]/config/attachments.yaml
41
42       ·   attachments_skip: [regular_expression]
43
44           Kwiki::Attachments may be configured to reject the upload of files
45           with names matched by the given regular expression.  By default, it
46           is set to reject files beginning with "thumb_" or "." and those
47           ending with "~" or ".bak".
48
49       ·   make_thumbnails: [on|off]
50
51           This flag controls whether thumbnails are created from uploaded
52           image files.  It is set to 'on' by default.
53
54       ·   im_override: [on|off]
55
56           If both Imager.pm and Image::Magick.pm are available,
57           Kwiki::Attachments uses Imager, unless im_override is set to 'on'.
58           This parameter has no effect if only one of the two image
59           manipulation modules is installed. It is set to 'off' by default.
60

AUTHOR

62       Sue Spence <sue_cpan@pennine.com>
63
64       This module is based almost entirely on work by Eric Lowry
65       <eric@clubyo.com> and Brian Ingerson <INGY@cpan.org>
66

68       Copyright (c) 2005. Sue Spence. All rights reserved.
69
70       This program is free software; you can redistribute it and/or modify it
71       under the same terms as Perl itself.
72
73       See http://www.perl.com/perl/misc/Artistic.html
74

POD ERRORS

76       Hey! The above document had some coding errors, which are explained
77       below:
78
79       Around line 355:
80           You forgot a '=back' before '=head1'
81
82
83
84perl v5.12.0                      2005-09-11             Kwiki::Attachments(3)
Impressum