File Attachments

File Attachments

Each topic can have files attached to it, similar to an email attachment. Use your browser to upload or download a file. Attachments are stored under revision control, so uploads can never be lost, and files changes can be made with a rollback option that lets you retrieve all previous versions.

Each topic can have one or more files of any type attached to it by using the Attach screen to upload (or download) files from your local PC. Attachments are stored under revision control: uploads are automatically backed up; all previous versions of a modified file can be retrieved.

What Are Attachments Good For?

What Are Attachments Good For?

File Attachments can be used to create powerful groupware solutions - file sharing, document management - and for speedy Web authoring.

File Attachments can be used to create powerful customized groupware solutions, like file sharing and document management systems, and quick Web page authoring.

Document Management System

Document Management System

• You can use Attachments to store and retrieve documents (in any format, with associated graphics, and other media files); attach documents to specific TWiki topics; collaborate on documents with full revision control; distribute documents on a need-to-know basis using; create a central reference library that's easy to access and manage by an entire user group.

• You can use Attachments to store and retrieve documents (in any format, with associated graphics, and other media files); attach documents to specific TWiki topics; collaborate on documents with full revision control; distribute documents on a need-to-know basis using web and topic-level access control; create a central reference library that's easy to share with an user group spread around the world.

File Sharing

File Sharing

Web Authoring

Web Authoring

• Through your Web browser, you can easily upload graphics (or sound files, or anything else you want to embed on a page) and place them anywhere in on a single page, or for use across a web, or site-wide.
  • NOTE: You can also add graphics - any files - directly, typically by FTP upload. This requires server access, and may be more convenient if a large number of files, or a particular directory location, is required. These files can't be managed using browser-based Attachment controls.

• Through your Web browser, you can easily upload graphics (or sound files, or anything else you want to link to on a page) and place them on a single page, or use them across a web, or site-wide.
  • NOTE: You can also add graphics - any files - directly, typically by FTP upload. This requires FTP access, and may be more convenient if you have a large number of files to load. FTP-ed files can't be managed using browser-based Attachment controls. You can use your browser to create TWikiVariables shortcuts, like this %H% = .

Uploading Files

Uploading Files

• To upload: Click on the Attach link at the bottom of each page. A form is shown where you can browse for a file and upload it. The uploaded file will show up in the File Attachment table.
  • Files of any type can be uploaded. Some files that might impose a security risk are renamed, ex: *.php files are renamed to *.php.txt.
  • Currently there is no file size limit besides the disk space on the server.

• Click on the Attach link at the bottom of the page. The Attach screen lets you browse for a file, add a comment, and upload it. The uploaded file will show up in the File Attachment table.
  • Any type of file can be uploaded. Some files that might pose a security risk are renamed, ex: *.php files are renamed to *.php.txt so that no one can place code that would be read in a .php file.

• • Currently there is no file size limit other than the disk space on the server. * It's not recommended to upload files greater than a few hundred K through a browser. Large files can be extremely slow-loading, and often time out. Use FTP for large file uploads.

Downloading Files

Downloading Files

• To download: Click on the file in the File Attachment table.

• Click on the file in the File Attachment table.

• NOTE: There is no access control on individual attachments. If you need this type of control, create separate topics and define access restrictions per topic.

• NOTE: There is no access control on individual attachments. If you need control over single files, create a separate topic per file and set topic-level access restrictions for each.

Moving Attachment Files

Moving Attachment Files

An attachement can be moved between topics. To do this click Action on the attachment to be moved. On the control page, select the new web and topic, the click Move. The attachment and its version history are moved. The original location is stored as topic Meta Data.

An attachment can be moved between topics.

• Click Action on the Attachment to be moved.
• On the control screen, select the new web and/or topic.
• Click Move. The attachment and its version history are moved. The original location is stored as topic Meta Data.

Deleting Attachments

Deleting Attachments

It is not possible to delete attached files with the current TWiki implementation. However, they can be moved to another topic. You may care to have a topic Trash.TrashAttachments - move attachments that are no longer wanted here.

It is not possible to delete attached files directly. You can delete a topic, and its attachments with it.

• One easy workaround is to create a Trash.TrashAttachments - then, simply move unwanted Attachments to that topic.

Linking to Attached Files

Linking to Attached Files

1. 1. Attach file: Sample.txt
   2. Edit topic and write text: %ATTACHURL%/Sample.txt
   3. Preview - %ATTACHURL text appears as: http://jhydra.sourceforge.net/pub/TWiki/FileAttachment/Sample.txt, a link.

• To reference an attachment located in another topic, write text:
  • %PUBURL%/%WEB%/OtherTopic/Sample.txt (for the same web)
  • %PUBURL%/Otherweb/OtherTopic/Sample.txt (for adifferent web)

1. 1. Attach file: Sample.txt
   2. Edit topic and enter: %ATTACHURL%/Sample.txt
   3. Preview: %ATTACHURL%/Sample.txt text appears as: http://jhydra.sourceforge.net/pub/TWiki/FileAttachment/Sample.txt, a link to the text file.

• To reference an attachment located in another topic, enter:
  • %PUBURL%/%WEB%/OtherTopic/Sample.txt (if it's within the same web)
  • %PUBURL%/Otherweb/OtherTopic/Sample.txt (if it's in a different web)

1. 1. Attach file: Sample.txt
   2. Edit topic and write text: %INCLUDE{"%ATTACHURL%/Sample.txt"}%

1. 1. Attach file: Sample.txt
   2. Edit topic and write text: %INCLUDE{"%ATTACHURL%/Sample.txt"}%

1. 1. Attach file: Smile.gif
   2. Edit topic and write text: %ATTACHURL%/Smile.gif
   3. Preview - text appears as , an image.

1. 1. Attach file: Smile.gif
   2. Edit topic and write text: %ATTACHURL%/Smile.gif
   3. Preview: text appears as , an image.

File Attachment Contents Table

File Attachment Contents Table

File Attachment Controls

File Attachment Controls

Clicking on an Action link takes you to a new page that looks like this:

Clicking on an Action link takes you to a new page that looks like this:

• • To hide/unhide an attachment, enable the Hide file checkbox, then click Change properties.

• • To hide/unhide an attachment, enable the Hide file checkbox, then click Change properties.

Known Issues

Known Issues