Revision [8249]

This is an old revision of FilesActionInfo made by NilsLindenberg on 2005-05-17 12:46:10.

 

WikkaDocumentation Wikka Documentation

Files Action Documentation

This the documentation page for the Files action.

See also
Mod for the files action


Once the planned 'autodoc' feature for actions is "live", this page will contain the automatically-generated documentation by just including an action; for now, I've just manually created the text.

Documentation


Short description
Allows admins to manage files (upload, deletion) and everyone to view a list of them or download them. Or it provides a download-link to a single file.

Parameters
nametyperequired?defaultdescription
downloadstringoptionalprints a link to the file specified in the string
textstringoptionala text for the link provided with the parameter "download"


Long description
The 'upload_path' in the ConfigurationOptions wikka_config must be a writeble directory. A directory by each page will be created to store their attached files. This action will only show/modify the files attached to the current page!

If you want to manage the files, use the action without parameters. You will see a list of the files attached to wikka with "attachment" (name of the file)., "size" and "Date added", ordered descending after "Date added". To donload a file, simply click on the name. As an WikkaAdmin admin, you will see a "x" left to every file (clicking on it will delete the file). The simple form below the list allows to upload a file.

If you specify a filename with the parameter "download", a link to download this file will be shown (you can change the text for the link with the parameter "text") but not the form.

Usage:
{{files [download="filename"] [text="descriptive text"]}}


example:
Please make sure that the server has write access to a folder named uploads.


Author
?


CategoryDocumentation
There are 14 comments on this page. [Show comments]
Valid XHTML :: Valid CSS: :: Powered by WikkaWiki