[Show/Hide Right Column]

Link to a file that's attached or in a gallery or archive
Print
Tags: attachments plugin files images
TOC Previous page Parent page Next page

Plugin File

This Wiki Plugin displays a link to an attachment to a wiki page and can display an image attachment. In tw >=5, it can display a link to file in the file gallery or to a specific archive.

noteNote
This plugin is very similar to PluginAttach.

Usage and Parameters

To use this plugin in a wiki page, use the syntax:

Syntax for the FILE plugin
{FILE(name=>file.ext, desc=> , page=>WikiPage, showdesc=>0|1, image=>0|1)} {FILE}

Parameter Accepted values Default Effect Required? Since
name The file name of an attachment none Results in a link to the given file using the file name as the link text as long as desc and showdesc parameters are not specified. If the page parameter is not set, the file name must be for a file attached to the page where the plusin is being used. n
page A wiki page name none To specify an attachment on another page n
desc Any text string none Custom text that will be used for the link instead of the file name or file description. The file name will be used as the link text if the desc or showdesc parameters are not set. n
showdesc 0 or 1 0 The description for the attachment will be used as the link text instead of the file name or custom text when set to 1. The file name will be used as the link text if the desc or showdesc parameters are not set. n
image 0 or 1 0 Identifies the attachment as an image, which will be displayed inline using the img tag (see Wiki-Syntax Images) with no link generated. n
fileId ID Numeric ID of a file in file gallery n tw>=5
date date Look the archive witht he closest smaller creation date (see explanation below) n tw>=5

tipMore tips on how the plugin works in tw
Only files listed as an attachment at the bottom of a page are captured by this plugin. That means that images that have been uploaded through the "Upload picture:" option on the edit panel or uploaded to an image or file gallery and only linked to on the page will not be included. Other types of files (other than images) uploaded in the edit panel will be included because they appear in the list of attachments.

Examples

Using name and page parameters

This code,
Using name and page parameters
{FILE(name=>doctwo.png, page=>PluginAttach, showdesc=>0, image=>0)}{FILE}
arrow-right.png
 Would produce this:


doctwo.png

Using custom link text

This code,

Using custom link text
{FILE(name=>tikigold.jpg, desc=>Custom link text, showdesc=>0, image=>0)}{FILE}
arrow-right.png
 Would produce this:


Custom link text

Using image parameter

This code,

Using the image parameter
{FILE(name=>tikigold.jpg, image=>1)}{FILE}
arrow-right.png
 Would produce this:


tikigold.jpg

simple link to a file
{FILE(fileId=1)}Link to this file{FILE}

will produce the wiki code
Result
[tiki-download_file.php?fileId=1|Link to this file]

The fileId can be the ID of a file or an archive.
If date is specified, the archive with the closest smaller creation date will be linked. The format of the date is described http://us2.php.net/manual/en/function.strtotime.php:here. If the date parameter is specified with no value, it will use the last date specified in the page.
Example of technical documentation linked to specific version of paper
On the 01/20/2010
{FILE(fileId=1, date="2010/01/20)}The specification{FILE}
{FILE(fileId=2, date="")}The estimation associated to the specification{FILE}
On the 01/25/2010
{FILE(fileId=1, date="2010/01/25")}The specification{FILE}
{FILE(fileId=2, date="")}The estimation associated to the specification{FILE}

fielId can be any fileId of the archive tree.

Contributors to this page: lindon2331 points  and sylvie4333 points  .
Page last modified on Saturday 03 July, 2010 22:14:24 UTC by lindon2331 points .

SourceHistorySlides 2 Comments 1 File Attached

Find by Page Name

Exact match

Keywords

The following is a list of keywords that should serve as hubs for navigation within the Tiki documentation and should correspond to development keywords (bug reports and feature requests):