File

Overview
Prototype

Parameters

Examples
See Also
Related

Overview
The File standard function displays a link to an attached file.
When editing a page you can attach files (images, executables, zip-files, etc.). The files are stored with and managed on the page for which they are attached. Displaying these files as images or download links is straightforward with some flexibility for the way they are displayed.
While the files are attached to a single page, they can also be referenced on one page from another.

Prototype
##File(string [name], string [linkText], bool {showSize})

Parameters

Name: name [Required]

Type: string
Description: The name of the attached file.

Name: linkText [Required]

Type: string
Description: The optional text for the file link.

Name: showSize {Optional}

Type: bool
Default: false
Description: Whether or not to show the file size beside the link.

Examples

##file(Example Attachment 1.txt)

##File(Example Attachment 1.txt, Download now!)

##File(Example Attachment 1.txt, Download now!, true)