Project

General

Profile

RedmineAttachedFiles » History » Version 5

Etienne Massip, 2013-04-12 09:50

1 1 Mischa The Evil
h1. Redmine Attached Files
2
3
{{>toc}}
4
5
h2. Introduction
6
7 2 Mischa The Evil
Attached files can be added to different resources within the Redmine system:
8
* issues - using the [[RedmineAttachedFiles#Attach-files-form|"New File" form]] while adding/editing an issue
9
* documents - using the [[RedmineAttachedFiles#Attach-files-form|"New File" form]] while adding/editing a document
10
* forum messages - using the [[RedmineAttachedFiles#Attach-files-form|"New File" form]] while adding/editing a forum message
11
* 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
h2. Usage
14
15
h3. Inline Images
16
17
Attached files can be shown within the parent page by targeting it's name via image url (i.e. @!attached_image!@).
18
19
h3. Non plain text files
20
21
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
23
However, if that doesn't fit the bill, file upload support provides a way to distribute any file for user download.
24
25
h2. File storage
26
27 3 Etienne Massip
Uploaded attached files are stored in @<Redmine install dir>/files@ directory subdirectories named after the year the file has been uploaded.
28 1 Mischa The Evil
29
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
31 5 Etienne Massip
h4. Unattached uploaded files
32
33
Uploaded files can be left unattached if the user don't submit the form; a [[RedmineMaintenance#rake-redmineattachementsprune|Rake task]] is made available and can be scheduled for regular deletion of these files.
34
35
36 1 Mischa The Evil
h2. Attach files form
37
38 4 Etienne Massip
The input form is as shown below.
39 1 Mischa The Evil
40 4 Etienne Massip
Starting from version version:2.3.0 and depending on the browser supporting it (IE10+), it is possible to:
41
* select and attach multiple files at once
42
* drag and drop files over the form
43
44
The optional description field, which appears once the file upload is finished, is also used as the alternate text of the image file inserted using @!image_url!@ syntax within the parent content (i.e. issue description or note, forum message, wiki page, document, &hellip;).
45 1 Mischa The Evil
46
!UploadFile.png!
47
48
h2. Files added via "New File"
49
50
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.
51
52
See the [[RedmineFiles#Usage|Usage]] section for more information.