Attachment List Plugin

View permissions are honored: if the user is not allowed to view the referring topic, the attachments are not displayed.

This plugin uses TWiki:Plugins/TopicDataHelperPlugin

Syntax Rules

• %ATTACHMENTLIST% - default rendering of the attachment of the current topic
• %ATTACHMENTLIST{parameters}% - see list of parameters below

Topics to search

Attachments to include/exclude

Sort options

Formatting parameters

Formatting variables

These variables can be used in the format tag:

These substitution variables can be used in the format, header and footer tags:

Format variable	Comment
$dollar	Dollar sign ($)
$quot	Double quote (")
$nop or $nop()	Is a "no operation".
$br	<br /> tag
$n or $n()	New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar
$percnt	Percent sign (%)

These variables can be used in the header and footer tags:

Test

%ATTACHMENTLIST{
web="%SYSTEMWEB%"
topic="FileAttachment"
format="| $fileIcon | [[$fileUrl][$fileName]] ($fileSize) | Submitted by $fileUser on $fileDate | $fileComment |<span class='twikiGrayText'>[[$fileActionUrl][manage]]</span> |"
}%

Output (if installed):

%ATTACHMENTLIST{ web="TWiki" topic="FileAttachment" format="| $fileIcon | $fileName ($fileSize) | Submitted by $fileUser on $fileDate | $fileComment |manage |" }%

Image output

%ATTACHMENTLIST{
topic="WabiSabi"
web="%SYSTEMWEB%"
extension="jpg,jpeg,gif,png"
header="Images:"
format="<div class='twikiImage'><a href='$fileUrl'>$imgTag</a></div>"
separator="<hr />"
footer="Number of images: $fileCount"
}%

Output (if installed):

%ATTACHMENTLIST{ topic="WabiSabi" web="TWiki" extension="jpg,jpeg,gif,png" header="Images:" format="

Regular expression filter

List all files since 01 Jan 2007, starting with a letter 'a' or 'A'. Note the use of the prefix (?i) for case insensitivity.

%ATTACHMENTLIST{
web="%SYSTEMWEB%"
topic="*"
header="Files since 01 Jan 2007, starting with a letter 'a' or 'A':"
footer="Number of files: $fileCount"
format="   * $percntICON{$fileExtension}$percnt [[$fileUrl][$fileName]] $fileComment"
includefilepattern="(?i)^[A]"
fromdate="2007/01/01"
sort="$fileName"
}%

Output (if installed):

%ATTACHMENTLIST{ web="TWiki" topic="*" header="Files since 01 Jan 2007, starting with a letter 'a' or 'A':" footer="Number of files: $fileCount" format=" * $percntICON{$fileExtension}$percnt $fileName $fileComment" includefilepattern="(?i)^[A]" fromdate="2007/01/01" sort="$fileName" }%

Plugin Settings

• Default format of rendering the attachments:

      * Set FORMAT = \n   * [[$fileUrl][$fileName]] $fileComment

• Default format of rendering image attachments:

      * Set IMAGE_FORMAT = <img src='$fileUrl' alt='$fileComment' title='$fileComment' />

• Specify image height and width parameters (switched off for performance; enable by removing the # sign):

      * #Set IMAGE_FORMAT = <img src='$fileUrl' height='$imgHeight' width='$imgWidth' alt='$fileComment' title='$fileComment'  />

• Set SHORTDESCRIPTION = Displays a formattable list of topic attachments, anywhere in a topic.
• Set DEBUG = 0

Plugin Installation Instructions

• Download the ZIP file from the Plugin web (see below)
• Unzip AttachmentListPlugin.zip in your root ($TWIKI_ROOT) directory. Content:

  File:	Description:
  data/TWiki/AttachmentListPlugin.txt
  lib/TWiki/Plugins/AttachmentListPlugin.pm
  lib/TWiki/Plugins/AttachmentListPlugin/FileData.pm

• Optionally, if it exists, run AttachmentListPlugin_installer to automatically check and install other TWiki modules that this module depends on. You can also do this step manually.
• Alternatively, manually make sure the dependencies listed in the table below are resolved.

  Name	Version	Description
  TWiki::Plugins::TopicDataHelperPlugin		Required

• Visit configure in your TWiki installation, and enable the plugin in the Plugins section.

Plugin Info

Authors:	TWiki:Main.VinodKulkarni, TWiki:Main.SopanShewale, TWiki:Main.ArthurClemens
Copyright:	© 2005 TWiki:Main.VinodKulkarni, © 2006 TWiki:Main.SopanShewale, © 2006-2008 TWiki:Main.ArthurClemens, © 2005-2010 TWiki:TWiki.TWikiContributor
License:	GPL
Dependencies:	Name Version Description TWiki::Plugins::TopicDataHelperPlugin Required
Plugin Version:	19248 (2010-07-25)
Change History:
2010-07-25:	TWikibug:Item6530 - doc fixes, fixing TWIKIWEB to SYSTEMWEB
24 Oct 2008 - 1.3	Arthur Clemens: Added sorting on $fileTopic. For performance, attachments are no longer sorted by default; you must explicitly pass the $sort parameter. Added param file to explicitly list attachments. Added special extension placeholder NONE to find attachments that do not have an extension. Major code refactoring. Created unit tests. Various small bug fixes.
17 Oct 2008 - 1.2.7	Fixed bug with undefined todate.
20 Feb 2008 - v.1.2.1 - 1.2.3	Arthur Clemens: Fixed error with format tokens on TWiki older than 4.2; by default sort files by name.
20 Feb 2008 - v.1.2	Arthur Clemens: Added parameter includefilepattern and formatting parameter $fileExtension. When using parameter sort the files are now secondary sorted on filename. Added decoding of format tokens.
19 Feb 2008 - v.1.1.5	Arthur Clemens: Fix display of header.
25 Jan 2008 - v.1.1.4	Arthur Clemens: Removed redundant spacing when no header is defined.
04 Jan 2008 - v.1.1	Arthur Clemens: Added filter parameters user and excludeuser; added format parameters $fileTopic and $fileWeb.
06 Dec 2007 - v.1.0	Arthur Clemens: integrated sort options by TWiki:Main.RohanMoitra. Renamed FileListPlugin to AttachmentListPlugin; changed FILELIST (now deprecated) to ATTACHMENTLIST.
21 Nov 2007 - v.0.9.3	Arthur Clemens: added rendering of images; added $fileExtensions and limit.
20 Nov 2007 - v.0.9.2	Arthur Clemens: deprecated filter in favor of extensions; added more options.
18 Jun 2007	TWiki:Main/AntonioTerceiro: added support for handling hidden attchments.
08 Apr 2007 - v.0.9	TWiki:Main.OliverKrueger: added header, footer and alt params.
17 Dec 2006 - v.0.8	TWiki:Main.ArthurClemens: reworked for TWiki 4.1 and optimized; activated filter parameter, added topic view permission check.
03 Mar 2006 - v.0.7	TWiki:Main.SopanShewale: reworked for TWiki 4
11 Apr 2005 - v.0.6	TWiki:Main.VinodKulkarni: Initial version
21 Nov 2007 - v.0.9.3	Arthur Clemens: added rendering of images; added $fileExtensions and limit.
20 Nov 2007 - v.0.9.2	Arthur Clemens: deprecated filter in favor of extensions; added more options.
18 Jun 2007	TWiki:Main/AntonioTerceiro: added support for handling hidden attchments.
08 Apr 2007 - v.0.9	TWiki:Main.OliverKrueger: added header, footer and alt params.
17 Dec 2006 - v.0.8	TWiki:Main.ArthurClemens: reworked for TWiki 4.1 and optimized; activated filter parameter, added topic view permission check.
03 Mar 2006 - v.0.7	TWiki:Main.SopanShewale: reworked for TWiki 4
11 Apr 2005 - v.0.6	TWiki:Main.VinodKulkarni: Initial version
Home:	http://TWiki.org/cgi-bin/view/Plugins/AttachmentListPlugin
Feedback:	http://TWiki.org/cgi-bin/view/Plugins/AttachmentListPluginDev
Appraisal:	http://TWiki.org/cgi-bin/view/Plugins/AttachmentListPluginAppraisal

Related topics: TWikiPlugins, TopicDataHelperPlugin, FileAttachment