Skip to content

Template: Wiki Special Files

robinsowell edited this page Nov 3, 2015 · 1 revision

#Wiki Special Files Template

This template displays all the wiki's upload files as outlined below:

wiki_files_highlight

Displays all the wiki's upload files.

In addition to the variables in the Wiki Page template, the Special Files template has:

{wiki:files Tag


The Wiki Special Files template has the {wiki:files} tag available which is used to display a list of all the files that have been uploaded to the wiki. This tag has Parameters and Variables available to it.

{wiki:files} | Parameters


limit

{wiki:files limit="#"}

This determines the number of files to display on a page. For example, this: {wiki:files limit="10"}

Would limit the number of files displayed to 10.

paginate

{wiki:files paginate=""}

The Wiki module uses the same pagination syntax as all first-party modules. Please look at the :doc:/templates/pagination documentation for more information.

orderby

{wiki:files orderby="file_name"}

This determines the field that is used to order the files. "file_name" is the default behavior. ::

{wiki:files orderby="file_size"}

Would list the files in order of file size.

sort

{wiki:files sort="asc"}

The sort order can be ascending or descending. The default is "asc", ascending.

{wiki:files orderby="upload_date" sort="desc"}

Would list the files in order of the date uploaded, from most recent to oldest.

{wiki:files} Variables


Single Variables


absolute_count

{absolute_count}

Running "count" of the displayed file, taking pagination into consideration.

author

{author}

Displays the Screen Name of the person who uploaded the file.

count

{count}

"count" of the file currently being displayed

email

{email}

This displays the email address of the person who uploaded the file.

file_name

{file_name}

Displays the file's File name.

file_type

{file_type}

Displays the file's MIME Type.

path:author_profile

{path:author_profile}

Displays the path to the member profile of the person who uploaded the file.

path:view_file

{path:view_file}

Displays the URL to view a file's page. This is not the raw path to the file.

summary

{summary}

Displays the file's summary.

switch=

{switch="option_one|option_two|option_three"}

This variable permits you to rotate through any number of values as the files are displayed. The first file will use "option_one", the second will use "option_two", the third "option_three", the fourth "option_one", and so on.

Multiple instances of the {switch=} tag may be used and the system will intelligently keep track of each one.

upload date

{upload_date format=""}

Displays the date the file was uploaded.

The format parameter is used to determine the date's formatting using ExpressionEngine's Date Variable Formatting.

url

{url}

This displays the author's URL.

Conditional Variables


if is_image

{if is_image}

Checks to see if the uploaded file is an image. If yes, then do something.