RedmineFiles » History » Version 5

James Rowe, 2010-09-23 22:59
distinction of files module and new file link

1 1 Huyen Khanh
h1. RedmineFiles
2 2 James Rowe
3 2 James Rowe
{{toc}}
4 2 James Rowe
5 2 James Rowe
h2. Introduction
6 2 James Rowe
7 5 James Rowe
Files can be added just about anywhere in the Remdine system you see a "New File" link at the bottom of the page.
8 5 James Rowe
9 5 James Rowe
There is also a *Files* module for each project. From that tab new files are added via the !/images/add.png! *New File* button in the upper right hand corner.
10 1 Huyen Khanh
11 3 James Rowe
h2. Usage
12 3 James Rowe
13 3 James Rowe
h3. Inline Images
14 3 James Rowe
15 3 James Rowe
Attached files can be shown within the parent page by targeting it's name via image url (i.e. @!attached_image!@).
16 3 James Rowe
17 3 James Rowe
h3. Non plain text files
18 3 James Rowe
19 3 James Rowe
Keep in mind there is a [[RedmineDocuments]] module for storing technical and user documentation that can be linked via the wiki.
20 3 James Rowe
21 3 James Rowe
However, if that doesn't fit the bill, file upload support provides a way to distribute any file for user download.
22 3 James Rowe
23 3 James Rowe
h2. File storage
24 3 James Rowe
25 3 James Rowe
All uploaded files are stored at the @/{install dir}/files@ directory.
26 3 James Rowe
27 4 James Rowe
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.
28 3 James Rowe
29 2 James Rowe
h2. Attach files form
30 2 James Rowe
31 1 Huyen Khanh
Regardless where a file is added, the input form is as shown below. Adding multiple files at once is possible using the "Add another file" link.
32 2 James Rowe
33 3 James Rowe
The optional description is used for an @alt@ text if the image is shown using @!image_url!@ within the parent.
34 2 James Rowe
35 2 James Rowe
!UploadFile.png!
36 1 Huyen Khanh
37 1 Huyen Khanh
h2. Files Module
38 1 Huyen Khanh
39 3 James Rowe
Each project can have a files module enabled/disabled via the settings menu.
40 3 James Rowe
41 3 James Rowe
A sortable HTML table shows the details on the uploaded files. Of note are the MD5 hash, and D/L(Download Count).
42 3 James Rowe
43 3 James Rowe
!Files.png!
44 3 James Rowe
45 3 James Rowe
h2. Files added via "New File"
46 3 James Rowe
47 3 James Rowe
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.
48 3 James Rowe
49 3 James Rowe
See the [[RedmineFiles#Usage|Usage]] section for more information.