RedmineAttachedFiles » History » Version 2

Mischa The Evil, 2010-10-17 06:58
Slight changes

1 1 Mischa The Evil
h1. Redmine Attached Files
2 1 Mischa The Evil
3 1 Mischa The Evil
{{>toc}}
4 1 Mischa The Evil
5 1 Mischa The Evil
h2. Introduction
6 1 Mischa The Evil
7 2 Mischa The Evil
Attached files can be added to different resources within the Redmine system:
8 2 Mischa The Evil
* issues - using the [[RedmineAttachedFiles#Attach-files-form|"New File" form]] while adding/editing an issue
9 2 Mischa The Evil
* documents - using the [[RedmineAttachedFiles#Attach-files-form|"New File" form]] while adding/editing a document
10 2 Mischa The Evil
* forum messages - using the [[RedmineAttachedFiles#Attach-files-form|"New File" form]] while adding/editing a forum message
11 2 Mischa The Evil
* wiki pages - using the [[RedmineAttachedFiles#Files-added-via-New-File|"New File" link]] at the bottom of the page
12 1 Mischa The Evil
13 1 Mischa The Evil
h2. Usage
14 1 Mischa The Evil
15 1 Mischa The Evil
h3. Inline Images
16 1 Mischa The Evil
17 1 Mischa The Evil
Attached files can be shown within the parent page by targeting it's name via image url (i.e. @!attached_image!@).
18 1 Mischa The Evil
19 1 Mischa The Evil
h3. Non plain text files
20 1 Mischa The Evil
21 1 Mischa The Evil
Keep in mind there is a dedicated [[RedmineDocuments|documents]] module for storing technical and user documentation that can be linked via the [[RedmineWikis|wiki]] and a dedicated [[RedmineFiles|files]] module for publishing versions of the tracked project, as a bundle (release).
22 1 Mischa The Evil
23 1 Mischa The Evil
However, if that doesn't fit the bill, file upload support provides a way to distribute any file for user download.
24 1 Mischa The Evil
25 1 Mischa The Evil
h2. File storage
26 1 Mischa The Evil
27 1 Mischa The Evil
All uploaded attached files are stored at the @/{install dir}/files@ directory.
28 1 Mischa The Evil
29 1 Mischa The Evil
The uploaded file name is prefixed with a unique id based on it's parent for directory storage. Multiple files can be uploaded with the same name, however a link within the wiki will only show the most recently uploaded one.
30 1 Mischa The Evil
31 1 Mischa The Evil
h2. Attach files form
32 1 Mischa The Evil
33 1 Mischa The Evil
Regardless where an attached file is added, the input form is as shown below. Adding multiple attached files at once is possible using the "Add another file" link.
34 1 Mischa The Evil
35 1 Mischa The Evil
The optional description is used for an @alt@ text if the image is shown using @!image_url!@ within the parent.
36 1 Mischa The Evil
37 1 Mischa The Evil
!UploadFile.png!
38 1 Mischa The Evil
39 1 Mischa The Evil
h2. Files added via "New File"
40 1 Mischa The Evil
41 1 Mischa The Evil
At the bottom of many of the pages in Redmine is a "New File" link. Attaching a file makes that page the parent of the file and it is limited in scope to that page.
42 1 Mischa The Evil
43 1 Mischa The Evil
See the [[RedmineFiles#Usage|Usage]] section for more information.