Fullscreen
Loading...
 
[Show/Hide Right Column]

Plugin File

This Wiki Plugin displays a link to an attachment to a wiki page and can display an image attachment.

Since Tiki5.0, it can display a link to file in the file gallery or to a specific archive.

And Since Tiki6.1, it allows easily selecting a file from a file gallery in a visual way, similarly to what can be achieved for images with the equivalent tool in the default toolbar. Moreover, it is included in the default toolbar shown in tiki textareas.

Close
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 plugin 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 with the closest smaller creation date (see explanation below) n tw>=5



Close
tipMore tips on how the plugin works in tw <5
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
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 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.



List of attached files
ID Name desc uploaded Size Downloads Actions
16 jpg tikigold.jpg Mon 04 May, 2009 06:10 CEST by lindon 4.46 Kb 5550 View Download  

doc.tiki.org
[toggle]





Site Language

Keywords

These keywords serve as "hubs" for navigation within the Tiki documentation. They correspond to development keywords (bug reports and feature requests):



Tiki Newsletter

Delivered fresh to your email inbox!
Newsletter subscribe icon
Don't miss major announcements and other news!
Contribute to Tiki