Attachment List Plugin

Displays a formattable list of topic attachments, anywhere in a topic.

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

Syntax Rules

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

Formatting parameters

These parameters can be used in the format tag:

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

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

Test

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

Output (if installed):

Image output

%ATTACHMENTLIST{
topic="WabiSabi"
web="%TWIKIWEB%"
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):

Images:

Number of images: 1

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. None
• Visit configure in your TWiki installation, and enable the plugin in the {Plugins} section.

Plugin Info

. Renamed FileListPlugin to AttachmentListPlugin; changed FILELIST to ATTACHMENTLIST. |