Uploads

PmWiki can be configured to allow authors to upload and store files and images (known as attaching them). These attachments may then be referenced from any page.

Attach: syntax

To add or link to an attachment, an author edits a page to include the markup "Attach:" followed by a name of an attachment (e.g., "Attach:resume.pdf"). When the page is displayed, the Attach: markup becomes one of the following:

• A link to the named attachment (if uploaded, ie already in the upload directory)
• A link to a form whereby the author can specify a file to be uploaded and used as the new attachment (if not yet uploaded, ie not in the upload directory)
• If the attachment is an image file with an extension such as .gif, .jpeg, or .png, it is displayed as an image.

The behavior of links can be modified to

• prevent an image attachment from displaying as an image, place it in double brackets (e.g., [[Attach:image.jpg]]).
• have a link to an attachment appear without the "Attach:" at the beginning of the link, use [[(Attach:)file.ext]].
• display a tool tip on mouse over (e.g., Attach:image.jpg"mouse over tool tip").
• display a tool tip and a caption (e.g., Attach:image.jpg"mouse over tool" | Caption text).

Attachments on other pages and groups

To link to an uploaded attachment (image or file) from another group, you simply refer the group itself (make sure "Groupname" has the dot in it).

If PmWiki is configured with an individual directory per page use

Names with spaces and special characters

To link to a filename with spaces in it use the bracket link notation, eg

To embed an image with spaces or special characters escape them with the markup Attach:[=image name.jpg=].

International characters in file names

See UploadsAdmin and $UploadNameChars.

Listing uploaded files on a page

To list files that have been uploaded, use the directive (:attachlist:) -- see PageDirectives#attachlist for more options.

This will list attachments to the current group or page, depending whether attachments are organized per group (default) or per page; each instance includes a link to the attachment for viewing or downloading. A list of attachments is also shown as part of the upload file form.

Upload form / upload replacement

One can go directly to the upload form by appending "?action=upload" to the URI for any page that has file uploads enabled by the Wiki Administrator. Replace a file by simply uploading a new version of the file with the same name.

• Be sure to clear your browser cache after replacing an upload. Otherwise, it may appear that the original upload is still on the server.

If you put $EnableUploadVersions=1; in your local/config.php, the old versions of the same files are renamed and not removed.

Upload drop zone

If config.php has $EnableUploadDrop=1; then a "drop zone" will appear above the edit form, and above the upload form. Users with upload permissions can drag files from a folder in their file manager, and drop them on the drop zone. The files will be uploaded one after another, if their size and extension are acceptable.

Unlike the upload form, there is no "Name attachment as:" field, the files are uploaded with their original names. Upon reception the files may still be renamed to match the characters admissible on the server.

In the edit form, after an upload completes, the user can click on the filename to insert a link to the file in the text area.

• Clicking on a filename will insert a link like Attach:New-file.jpg.
• Holding down the "Ctrl" key, and clicking on a filename will insert a link like Attach:Group.CurrentPage/New-file.jpg.
• If the filename contains spaces, the link will be wrapped in square brackets like [[Attach:Spaced name.txt]].
• Middle-clicking on the filename will open the file for preview in a new browser tab.

Type and size restrictions

For security reasons, the upload feature is disabled when PmWiki is first installed. When enabled uploads are restricted as to the types and sizes of files that may be uploaded to the server (see Uploads Admin). PmWiki's default configuration limits file sizes to 50 kilobytes and file extensions to common types of images, audio, video, and documents as shown below.

In addition, the administrator can configure the system to require an upload password--see Passwords and Passwords Admin.

By default the upload feature allows the following extensions.

Removal

At present uploaded files can only be deleted from the server by the wiki administrator. Any uploads-authorized user may over-write an existing file by uploading another of the same name and extension to the same location.

The administrator may remove an uploaded file by accessing the server via ftp (or via a control panel, if the host offers such a feature). The recipe Cookbook:Attachtable allows the deletion of the files from the wiki.

FAQ

Unless noted otherwise, pictures in this page come from Public domain collections at Wikimedia Commons.