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 behaviour 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"]]).

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

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

"Embedding in the page" an image with spaces is not supported: just upload the images with names without spaces, and use the markup Attach:image.jpg.

The following workaround is possible, but is unsupported and not recommended:

International characters in file names

See UploadsAdmin and $UploadNameChars.

Listing Uploaded Files On A Page

To list files that have been uploaded, use the markup: (:attachlist:)

This will list attachments to the current group or page, depending whether attachments are organised per group 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 uploads page 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.

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 such as ".gif", ".jpeg", ".doc", ".txt", and ".pdf".

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

By default the upload allows the following extensions. Note that by default, it is possible to upload files with no extensions.

  gif, jpg, jpeg, png, bmp, ico, wbmp, svg, svgz, xcf,       # images

  mp3, au, wav, ogg, flac,                                   # audio
  ogv, mp4, webm, mpg, mpeg, wmf, mov, qt, avi,              # video
  zip, 7z, gz, tgz, rpm, hqx, sit,                           # archives
  odt, ods, odp, odg, doc, docx, ppt, pptx, xls, mdb, rtf,   # Office
  exe,                                                       # executables
  pdf, psd, ps, ai, eps,                                     # Adobe
  htm, html, css, fla, swf,                                  # web stuff
  txt, tex, dvi,                                             # text files
  epub, kml, kmz, (files with no extension)                  # misc

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.