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://qtella.sourceforge.net/twiki/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://qtella.sourceforge.net/twiki/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

Attachments are stored under revision control: uploads can never be lost, and changes can be made to files with a rollback option to any previous version always available.

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.

File Attachment Control Page

File Attachment Controls

• You can't lock an attachment for editing. However, you may want to change the comment to indicate you are doing that - the comment on the specific version isn't lost, you can see it when listing all the versions of an attachments.

• Unlike topics, attachments are not locked during editing. As a workaround, you can change the comment to indicate an attachment file is being worked on - the comment on the specific version isn't lost, it's there when you list all versions of the attachment.

Each topic can have files attached to it. This is similar to an e-mail attachment. Just use your browser to upload or download a file. Attachments are stored under revision control - no upload is lost.

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: uploads can never be lost, and changes can be made to files with a rollback option to any previous version always available.

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

• document management system: distribution, revision

• 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.

• share files: applications, data files; recommended for light use

• For file sharing, FileAttachments on a series of topics can be used to quickly create a well-documented, categorized digital download center for all types of files: documents; graphics and other media; drivers and patches; applications; anything you can safely upload!

Page Content

Web Authoring

• on-site use: linking to graphics, docs

• 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.

• 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, i.e. *.php files are renamed to *.php.txt.

• 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.

• The previous upload path is retained for convenience. In case you make some changes to the local file and want to upload it again you can copy the previous upload path into the Local file field.

• • The previous upload path is retained for convenience. In case you make some changes to the local file and want to upload it, again you can copy the previous upload path into the Local file field.

• There is no access control on individual attachments. If you need to have this type of control create separate topics and define access restrictions on the topics.

• 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.

An attachement can be moved between topics. To do this click action on the attachment to be moved. On the subsequent page select the new Web and Topic, the click Move. The attachment and its version history is moved. The original location is stored in the topic meta data.

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.

• • Attach file: Sample.txt
  • Edit topic and write text: %ATTACHURL%/Sample.txt
  • Text is shown as: http://qtella.sourceforge.net/twiki/pub/TWiki/FileAttachment/Sample.txt, ex: it is a link.
  • To reference an attachment located in another topic write text:
    • %PUBURL%/%WEB%/OtherTopic/Sample.txt (for same web)
    • %PUBURL%/Otherweb/OtherTopic/Sample.txt (for different web)

1. 1. Attach file: Sample.txt
   2. Edit topic and write text: %ATTACHURL%/Sample.txt
   3. Preview - %ATTACHURL text appears as: http://qtella.sourceforge.net/twiki/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)

• • Attach file: Sample.txt
  • 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"}%

• • Attach file: Smile.gif
  • Edit topic and write text: %ATTACHURL%/Smile.gif
  • Text is shown as: , it shows up 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.

Is a table that looks like this:

Files attached to a topic are displayed in a directory table, displayed at the bottom of the page, or optionally, hidden and accessed when you click Attach.

Attachment: Action: Size: Date: Who: Comment: Sample.txt action 30 22 Jul 2000 - 19:37 PeterThoeny Just a sample Smile.gif action 94 22 Jul 2000 - 19:38 PeterThoeny Smiley face

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:

Move attachment |

Move attachment |

The first table is a list of all attachments, including their attributes. A h means the attachment is hidden i.e. isn't listed when viewing a topic.

• The first table is a list of all attachments, including their attributes. An h means the attachment is hidden, it isn't listed when viewing a topic.

The second table is all the versions of the attachment. Click on view to see that version, if it is the most recent version you'll be taken to a URL that always displays the latest version, which is usually what you want to email out.

• The second table is all the versions of the attachment. Click on View to see that version. If it's the most recent version, you'll be taken to an URL that always displays the latest version, which is usually what you want.

If you just want to change the comment on an attachment - enter a new comment and then press Change properties. Note that the comment listed against the specific version will not change, however the comment displayed when viewing the topic does change.

• • To change the comment on an attachment, enter a new comment and then click Change properties. Note that the comment listed against the specific version will not change, however the comment displayed when viewing the topic does change.

Similarly to hide/unhide an attachment click in the Hide file checkbox are press Change properties.

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

Dev Reorg Note:

• File Attachments

File Attachments

The latest version of FileAttachments includes attachments under revision control. It's in the 01 Sep 2001 TWiki release.

Each topic can have files attached to it. This is similar to an e-mail attachment. Just use your browser to upload or download a file. Attachments are stored under revision control - no upload is lost.

• Current Dev topic: AttachmentsUnderRevisionControl?

What Are Attachments Good For?

Document Management System

Each topic can have files attached to it. This is similar to an e-mail attachment. Just use your browser to upload or download a file.

• 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 FileAttachment table.
• To download: Click on the file in the FileAttachment table.

• document management system: distribution, revision

File Sharing

• share files: applications, data files; recommended for light use

Page Content

• on-site use: linking to graphics, docs

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, i.e. *.php files are renamed to *.php.txt.
• Currently there is no file size limit besides the disk space on the server.
• The previous upload path is retained for convenience. In case you make some changes to the local file and want to upload it again you can copy the previous upload path into the Local file field.

Downloading Files

• To download: Click on the file in the File Attachment table.
• There is no access control on individual attachments. If you need to have this type of control create separate topics and define access restrictions on the topics.

Moving Attachment Files

An attachement can be moved between topics. To do this click action on the attachment to be moved. On the subsequent page select the new Web and Topic, the click Move. The attachment and its version history is moved. The original location is stored in the topic meta data.

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.

FileAttachment table

Linking to Attached Files

• Once a file is attached it can be referenced in the topic. Example:
  • Attach file: Sample.txt
  • Edit topic and write text: %ATTACHURL%/Sample.txt
  • Text is shown as: http://qtella.sourceforge.net/twiki/pub/TWiki/FileAttachment/Sample.txt, ex: it is a link.
  • To reference an attachment located in another topic write text:
    • %PUBURL%/%WEB%/OtherTopic/Sample.txt (for same web)
    • %PUBURL%/Otherweb/OtherTopic/Sample.txt (for different web)

• Attached HTML files and text files can be inlined in a topic. Example:
  • Attach file: Sample.txt
  • Edit topic and write text: %INCLUDE{"%ATTACHURL%/Sample.txt"}%
  • Content of attached file is shown inlined.
  • Read more in IncludeTopicsAndWebPages.

• GIF, JPG and PNG images can be attached and shown embedded in a topic. Example:
  • Attach file: Smile.gif
  • Edit topic and write text: %ATTACHURL%/Smile.gif
  • Text is shown as: , it shows up as an image.

File Attachment Contents Table

Attachment: Action: Size: Date: Who: Comment: Sample.txt action 30 22 Jul 2000 - 19:37 PeterThoeny Just a sample Smile.gif action 94 22 Jul 2000 - 19:38 PeterThoeny Smiley face

File Attachment Control Page

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

Attachment: Action: Size: Date: Who: Comment: Attribute: Sample.txt action 30 22 Jul 2000 - 19:37 PeterThoeny Just a sample   Smile.gif action 94 22 Jul 2000 - 19:38 PeterThoeny Smiley face   Update attachment Sample.txt Version: Action: Date: Who: Comment: 1.1 view 2001.08.30.09.28.56 PeterThoeny   Previous upload: C:\DATA\Sample.txt (PeterThoeny) Local file: Comment:

(view, update, add)

Create a link to the attached file at the end of the topic.

Help text ...

Action is:

• view: View file. This is the same as clicking on the filename.
• update: Update file that is already attached.
• add: Add a new attachment.

Topic FileAttachment . { | | Move attachment | Cancel }

Remarks

• Once a file is attached it can be referenced in the topic by %ATTACHURL%/{filename} . Example:
  • Attach file: Sample.txt
  • Text is shown as: http://qtella.sourceforge.net/twiki/pub/TWiki/FileAttachment/Sample.txt , i.e. it is a link.
• GIF and JPG images can be attached and shown in the text like this:
  • Attach file: Smile.gif
  • Edit topic and write text: %ATTACHURL%/Smile.gif
  • Text is shown as: , i.e. it shows up as an image.
• It is not possible to delete attached files with the current TWiki implementation. Contact webmaster@your.company if you need to delete files.

The first table is a list of all attachments, including their attributes. A h means the attachment is hidden i.e. isn't listed when viewing a topic.

The second table is all the versions of the attachment. Click on view to see that version, if it is the most recent version you'll be taken to a URL that always displays the latest version, which is usually what you want to email out.

If you just want to change the comment on an attachment - enter a new comment and then press Change properties. Note that the comment listed against the specific version will not change, however the comment displayed when viewing the topic does change.

Similarly to hide/unhide an attachment click in the Hide file checkbox are press Change properties.

Known Issues

• You can't lock an attachment for editing. However, you may want to change the comment to indicate you are doing that - the comment on the specific version isn't lost, you can see it when listing all the versions of an attachments.

FileAttachment

Dev Reorg Note:

The latest version of FileAttachments includes attachments under revision control. It's in the 01 Sep 2001 TWiki release.

• Current Dev topic: AttachmentsUnderRevisionControl?

%META:FILEATTACHMENT{name="Sample.txt" attr="" comment="Just a sample" date="964294620" path="C:\DATA\Sample.txt" size="30" user="thoeny" version=""}% %META:FILEATTACHMENT{name="Smile.gif" attr="" comment="Smiley face" date="964294680" path="C:\DATA\Smile.gif" size="94" user="thoeny" version=""}%

• To download: Click on the file in FileAttachment table.

• To download: Click on the file in the FileAttachment table.

• • Edit topic and write text: %ATTACHURL%/Sample.txt
  • Text is shown as: http://qtella.sourceforge.net/twiki/pub/TWiki/FileAttachment/Sample.txt , i.e. it is a link.

• • Text is shown as: http://qtella.sourceforge.net/twiki/pub/TWiki/FileAttachment/Sample.txt , i.e. it is a link.

• • Text is shown as: , i.e. it shows up as an image.

• • Text is shown as: , i.e. it shows up as an image.

FileAttachment:

FileAttachment:

 Sample.txt

 Sample.txt

view update

view update

26 Mar 1999 - 04:05

22 Jul 2000 - 19:37

 Smile.gif

 Smile.gif

view update

view update

26 Mar 1999 - 04:05

22 Jul 2000 - 19:38

add

add

FileAttachment

Each topic can have files attached to it. This is similar to an e-mail attachment. Just use your browser to upload or download a file.

• 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 FileAttachment table.
• To download: Click on the file in FileAttachment table.

FileAttachment table

Is a table that looks like this:

Action is:

• view: View file. This is the same as clicking on the filename.
• update: Update file that is already attached.
• add: Add a new attachment.

Remarks

• Once a file is attached it can be referenced in the topic by %ATTACHURL%/{filename} . Example:
  • Attach file: Sample.txt
  • Edit topic and write text: %ATTACHURL%/Sample.txt
  • Text is shown as: http://qtella.sourceforge.net/twiki/pub/TWiki/FileAttachment/Sample.txt , i.e. it is a link.
• GIF and JPG images can be attached and shown in the text like this:
  • Attach file: Smile.gif
  • Edit topic and write text: %ATTACHURL%/Smile.gif
  • Text is shown as: , i.e. it shows up as an image.
• It is not possible to delete attached files with the current TWiki implementation. Contact webmaster@your.company if you need to delete files.

FileAttachment:	Action:	Size:	Date:	Who:	Comment:
Sample.txt	view update	30	26 Mar 1999 - 04:05	PeterThoeny	Just a sample
Smile.gif	view update	94	26 Mar 1999 - 04:05	PeterThoeny	Smiley face
	add