[project/filefield.git] / README.txt


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