[project/filefield.git] / README.txt

// $Id$

FileField provides an "File" field type to CCK. It provides many advantages over
the Drupal core "Upload" module including:

 * Per-field upload control (file extensions, file size).
 * Per-node upload size limits.
 * Multiple fields per content type.
 * Customizable paths for saving uploads (plus token support for dynamic paths).
 * Icons for uploaded file types.

FileField was written by Darrel Opry (dopry).
Maintained by Nathan Haug (quicksketch) and Andrew Morton (drewish).

Dependencies
------------
 * Content

FileField also provides additional features when used with the following:

 * ImageField (See an image preview during editing.)
 * Token (Generate dynamic paths when saving images.)
 * ImageCache (Create thumbnails of images on output.)

If your site is any larger than a personal blog, you should definitely install
the following modules to increase the security and stability of your uploads.

 * Transliteration (Convert unsafe characters to file system safe names.)
 * MimeDetect (Check the content of files to ensure they match the extension.)

Install
-------

1) Copy the filefield folder to the modules folder in your installation.

2) Enable the module using Administer -> Site building -> Modules
   (/admin/build/modules).

3) Create a new file field in through CCK's interface. Visit Administer ->
   Content management -> Content types (admin/content/types), then click
   Manage fields on the type you want to add an file upload field. Select
   "File" as the field type and "File" as the widget type to create a new
   field.

4) Upload files on the node form for the type that you set up.
Commit	Line	Data
8a3bf923	1	// $Id$
d93afe47	2
8a3bf923 NH	3	FileField provides an "File" field type to CCK. It provides many advantages over
8a3bf923 NH	4	the Drupal core "Upload" module including:
d93afe47	5
8a3bf923 NH	6	* Per-field upload control (file extensions, file size).
	7	* Per-node upload size limits.
	8	* Multiple fields per content type.
	9	* Customizable paths for saving uploads (plus token support for dynamic paths).
	10	* Icons for uploaded file types.
d93afe47	11
8a3bf923 NH	12	FileField was written by Darrel Opry (dopry).
8a3bf923 NH	13	Maintained by Nathan Haug (quicksketch) and Andrew Morton (drewish).
a9804949	14
8a3bf923 NH	15	Dependencies
	16	------------
	17	* Content
a9804949	18
8a3bf923	19	FileField also provides additional features when used with the following:
a9804949	20
8a3bf923 NH	21	* ImageField (See an image preview during editing.)
	22	* Token (Generate dynamic paths when saving images.)
	23	* ImageCache (Create thumbnails of images on output.)
	24
0532922a NH	25	If your site is any larger than a personal blog, you should definitely install
	26	the following modules to increase the security and stability of your uploads.
	27
	28	* Transliteration (Convert unsafe characters to file system safe names.)
	29	* MimeDetect (Check the content of files to ensure they match the extension.)
	30
8a3bf923 NH	31	Install
	32	-------
	33
	34	1) Copy the filefield folder to the modules folder in your installation.
	35
	36	2) Enable the module using Administer -> Site building -> Modules
	37	(/admin/build/modules).
	38
	39	3) Create a new file field in through CCK's interface. Visit Administer ->
	40	Content management -> Content types (admin/content/types), then click
	41	Manage fields on the type you want to add an file upload field. Select
	42	"File" as the field type and "File" as the widget type to create a new
	43	field.
0532922a NH	44
0532922a NH	45	4) Upload files on the node form for the type that you set up.