none
[openafs-wiki.git] / TWiki / FileAttachment.mdwn
index e69de29..7758d83 100644 (file)
@@ -0,0 +1,217 @@
+<div>
+  <ul>
+    <li><a href="#File Attachments"> File Attachments</a><ul>
+        <li><a href="#What Are Attachments Good For?"> What Are Attachments Good For?</a><ul>
+            <li><a href="#Document Management System"> Document Management System</a></li>
+            <li><a href="#File Sharing"> File Sharing</a></li>
+            <li><a href="#Page Content"> Page Content</a></li>
+          </ul>
+        </li>
+        <li><a href="#Uploading Files"> Uploading Files</a></li>
+        <li><a href="#Downloading Files"> Downloading Files</a></li>
+        <li><a href="#Moving Attachment Files"> Moving Attachment Files</a></li>
+        <li><a href="#Deleting Attachments"> Deleting Attachments</a></li>
+        <li><a href="#Linking to Attached Files"> Linking to Attached Files</a></li>
+        <li><a href="#File Attachment Contents Table"> File Attachment Contents Table</a></li>
+        <li><a href="#File Attachment Control Page"> File Attachment Control Page</a></li>
+        <li><a href="#Known Issues"> Known Issues</a></li>
+      </ul>
+    </li>
+  </ul>
+</div>
+
+## <a name="File Attachments"></a> File Attachments
+
+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.
+
+### <a name="What Are Attachments Good For?"></a> What Are Attachments Good For?
+
+#### <a name="Document Management System"></a> Document Management System
+
+- **_document management system: distribution, revision_**
+
+#### <a name="File Sharing"></a> File Sharing
+
+- **_share files: applications, data files; recommended for light use_**
+
+#### <a name="Page Content"></a> Page Content
+
+- **_on-site use: linking to graphics, docs_**
+
+### <a name="Uploading Files"></a> 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|Main/WebHome#FileAttachmentTable]].
+- 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.
+
+### <a name="Downloading Files"></a> Downloading Files
+
+- To download: Click on the file in the [[File Attachment table|Main/WebHome#FileAttachmentTable]].
+- 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.
+
+### <a name="Moving Attachment Files"></a> 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|Main/TWikiDocumentation#Meta_Data_Definition]].
+
+### <a name="Deleting Attachments"></a> 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.
+
+### <a name="Linking to Attached Files"></a> 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://www.dementia.org/twiki//view/%WEB%/%TOPIC%/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: ![Smile.gif](http://www.dementia.org/twiki//view/%WEB%/%TOPIC%/Smile.gif) , it shows up as an image.
+
+<a name="FileAttachmentTable"></a>
+
+### <a name="File Attachment Contents Table"></a> File Attachment Contents Table
+
+Is a table that looks like this:
+
+<table border="1" cellpadding="20" cellspacing="0">
+  <tr>
+    <td>
+      <table border="1" cellpadding="1" cellspacing="0">
+        <tr>
+          <th align="center" bgcolor="#99CCCC"><strong><a href="FileAttachment">Attachment</a>:</strong></th>
+          <th align="center" bgcolor="#99CCCC"><strong>Action:</strong></th>
+          <th align="center" bgcolor="#99CCCC"><strong>Size:</strong></th>
+          <th align="center" bgcolor="#99CCCC"><strong>Date:</strong></th>
+          <th align="center" bgcolor="#99CCCC"><strong>Who:</strong></th>
+          <th align="center" bgcolor="#99CCCC"><strong>Comment:</strong></th>
+        </tr>
+        <tr>
+          <td><img align="top" height="16" src="http://www.dementia.org/twiki//view/icn/txt.gif" width="16" /> <a href="http://www.dementia.org/twiki//viewfile/TWiki/FileAttachment?rev=&filename=Sample.txt">Sample.txt</a></td>
+          <td><a href="http://www.dementia.org/twiki//attach/TWiki/FileAttachment?filename=Sample.txt&revInfo=1">action</a></td>
+          <td> 30 </td>
+          <td> 22 Jul 2000 - 19:37 </td>
+          <td><a href="PeterThoeny">PeterThoeny</a></td>
+          <td> Just a sample </td>
+        </tr>
+        <tr>
+          <td><img align="top" hight="16" src="http://www.dementia.org/twiki//view/icn/bmp.gif" width="16" /> <a href="http://www.dementia.org/twiki//viewfile/TWiki/FileAttachment?rev=&filename=Smile.gif">Smile.gif</a></td>
+          <td><a href="http://www.dementia.org/twiki//attach/TWiki/FileAttachment?filename=Smile.gif&revInfo=1">action</a></td>
+          <td> 94 </td>
+          <td> 22 Jul 2000 - 19:38 </td>
+          <td><a href="PeterThoeny">PeterThoeny</a></td>
+          <td> Smiley face </td>
+        </tr>
+      </table>
+    </td>
+  </tr>
+</table>
+
+### <a name="File Attachment Control Page"></a> File Attachment Control Page
+
+Clicking on an action link takes you to a new page that looks like this:
+
+<form>
+  <table border="1" cellpadding="20" cellspacing="0">
+    <tr>
+      <td>
+        <table border="1" cellpadding="1" cellspacing="0">
+          <tr>
+            <th align="center" bgcolor="#99CCCC"><strong><a href="FileAttachment">Attachment</a>:</strong></th>
+            <th align="center" bgcolor="#99CCCC"><strong>Action:</strong></th>
+            <th align="center" bgcolor="#99CCCC"><strong>Size:</strong></th>
+            <th align="center" bgcolor="#99CCCC"><strong>Date:</strong></th>
+            <th align="center" bgcolor="#99CCCC"><strong>Who:</strong></th>
+            <th align="center" bgcolor="#99CCCC"><strong>Comment:</strong></th>
+            <th align="center" bgcolor="#99CCCC"><strong><a href="FileAttribute">Attribute</a>:</strong></th>
+          </tr>
+          <tr>
+            <td><img align="top" height="16" src="http://www.dementia.org/twiki//view/icn/txt.gif" width="16" /> <a href="http://www.dementia.org/twiki//viewfile/TWiki/FileAttachment?rev=&filename=Sample.txt">Sample.txt</a></td>
+            <td><a href="http://www.dementia.org/twiki//attach/TWiki/FileAttachment?filename=Sample.txt&revInfo=1">action</a></td>
+            <td> 30 </td>
+            <td> 22 Jul 2000 - 19:37 </td>
+            <td><a href="PeterThoeny">PeterThoeny</a></td>
+            <td> Just a sample </td>
+            <td align="center">   </td>
+          </tr>
+          <tr>
+            <td><img align="top" height="16" src="http://www.dementia.org/twiki//view/icn/bmp.gif" width="16" /> <a href="http://www.dementia.org/twiki//viewfile/TWiki/FileAttachment?rev=&filename=Smile.gif">Smile.gif</a></td>
+            <td><a href="http://www.dementia.org/twiki//attach/TWiki/FileAttachment?filename=Smile.gif&revInfo=1">action</a></td>
+            <td> 94 </td>
+            <td> 22 Jul 2000 - 19:38 </td>
+            <td><a href="PeterThoeny">PeterThoeny</a></td>
+            <td> Smiley face </td>
+            <td align="center">   </td>
+          </tr>
+        </table>
+        <p>
+        </p>
+        <h2>Update attachment <code>Sample.txt</code></h2>
+        <p>
+        </p>
+        <table border="1" cellpadding="1" cellspacing="0">
+          <tr>
+            <th align="center" bgcolor="#99CCCC"><strong>Version:</strong></th>
+            <th align="center" bgcolor="#99CCCC"><strong>Action:</strong></th>
+            <th align="center" bgcolor="#99CCCC"><strong>Date:</strong></th>
+            <th align="center" bgcolor="#99CCCC"><strong>Who:</strong></th>
+            <th align="center" bgcolor="#99CCCC"><strong>Comment:</strong></th>
+          </tr>
+          <tr>
+            <td> 1.1 </td>
+            <td><a href="http://www.dementia.org/twiki//viewfile/TWiki/FileAttachment?rev=1.1&filename=Sample.txt">view</a></td>
+            <td> 2001.08.30.09.28.56 </td>
+            <td><a href="PeterThoeny">PeterThoeny</a></td>
+            <td>   </td>
+          </tr>
+        </table>
+        <p>
+        </p>
+        <table width="100%">
+          <tr>
+            <td align="right"> Previous <br /> upload: </td>
+            <td><code>C:\DATA\Sample.txt</code> (<a href="PeterThoeny">PeterThoeny</a>) </td>
+          </tr>
+          <tr>
+            <td align="right"> Local file: </td>
+            <td><input name="filename" type="hidden" value="Sample.txt" /> <input name="filepath" size="50" type="file" value="C:\DATA\Sample.txt" /></td>
+          </tr>
+          <tr>
+            <td align="right"> Comment: </td>
+            <td><input maxlength="50" name="filecomment" size="50" type="text" value="Just a sample" /></td>
+          </tr>
+          <tr>
+            <td align="right"> Link: </td>
+            <td><input name="createlink" type="checkbox" /> Create a link to the attached file at the end of the topic. </td>
+          </tr>
+          <tr>
+            <td align="right"> Hide file: </td>
+            <td><input name="hidefile" type="checkbox" /> Hide attachment in normal topic view. </td>
+          </tr>
+        </table><em>Help text ...</em><p> Topic <b>FileAttachment</b> . { </p><input type="submit" value="   Upload file   " /> | <input name="changeproperties" type="submit" value="Change properties" /> | <a href="http://www.dementia.org/twiki//rename/TWiki/FileAttachment?attachment=Sample.txt">Move attachment</a> | <a href="FileAttachment">Cancel</a> } </td>
+    </tr>
+  </table>
+</form>
+
+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_.
+
+### <a name="Known Issues"></a> 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.