modules/image_import/INSTALL.txt

$Id: INSTALL.txt,v 1.3 2005/06/06 13:20:57 syscrusher Exp $

                     UPGRADE INSTRUCTIONS

To upgrade this module from a previous version:

0. Read, or at least skim, the files README.txt and CHANGELOG.txt to see
   what has changed in the new version.

1. Copy the new version of this module over the old version.

2. Visit the settings page for the module to see if there are new options
   you may wish to use. BE SURE TO SAVE THE SETTINGS AT LEAST ONCE, even
   if you haven't changed anything.


                  INSTALLATION INSTRUCTIONS


To install and use this module:

0. Read the README.txt file thoroughly, and at least skim the TROUBLE.txt
   file, which contains some common problems and how to avoid them.

1. Make sure the new version of image.module by "walkah" is installed and is
   working properly. Verify that you can upload and display images alone and
   in thumbnail galleries.  This will require the 'upload' module to be
   enabled and configured according to the instructions for Drupal itself.

2. Place image_import.module into your modules directory or an appropriate
   subdirectory.

3. Enable the module in "admin/modules".

4. Enable the appropriate security permissions in "admin/access".

5. Configure image_import in "admin/settings/image_import". Create any
   needed directories to hold the uploaded files for import, or change
   the settings so that the import is from an existing directory.
   CAUTION: DO NOT use the same directory where the images will be
   permanently stored, and DO NOT use a directory containing other
   Drupal files. It is STRONGLY suggested to have a directory (or a
   directory tree) dedicated only to this function, with no other
   files in that area of your web site.

   Note that the above settings page will provide links (near the bottom)
   that point to system settings pages that are relevant to this module.
   You will want to visit each of those pages and make sure the settings
   are correct. As mentioned in item #1 above, it is VERY important to
   ensure that image.module, on which this module depends, is working
   correctly before installing image_import.module.

   The image import path must *not* be the same as the image module's
   default image path. If you try to make them the same, image_import
   will issue an error message.

There should now be an extra navigation menu entry under "create content"
(though in the current version, *no* menu entry appears in the main part of
the "create content" page, only in the side menu). The entry "import images"
from the menu will take you to the import screen.

6. Correct any errors that are reported as you arrive at the "import images"
   screen.

Now you are ready to begin uploading and importing images! Here are the
steps:

0. (Optional) Go to the path node/add/image_import/help and review the
   extensive built-in instructions for using the module.

1. Upload your image files (*.jpg, *.gif, and so on) together with their
   caption files (*.txt, and so on) into the correct import directory based
   on the module settings and your Drupal username. Caption filenames must
   match *exactly* the corresponding image filenames, except for the extension.
   So the caption file for "vacation-london-0032.jpg" must be precisely
   "vacation-london-0032.txt", for example.

2. In the "import images" screen, choose the appropriate options such as
   which image album and other categories (if applicable) to assign to
   the images you are about to import. The same album and categories
   will be assigned to all the images from a given import run.

3. Click "Preview" to have image_import scan to see if it thinks it can
   successfully import these files. You will get a report of what the
   preview found. Correct any problems before proceeding.

4. Click "Import images" to do the real import. If your import is
   set to delete the uploaded files, it will erase the images and their
   captions from the import directory each time an image is successfully
   added to Drupal.

5. Visit the galleries to see how your images look.
1	$Id: INSTALL.txt,v 1.3 2005/06/06 13:20:57 syscrusher Exp $
2
3	UPGRADE INSTRUCTIONS
4
5	To upgrade this module from a previous version:
6
7	0. Read, or at least skim, the files README.txt and CHANGELOG.txt to see
8	what has changed in the new version.
9
10	1. Copy the new version of this module over the old version.
11
12	2. Visit the settings page for the module to see if there are new options
13	you may wish to use. BE SURE TO SAVE THE SETTINGS AT LEAST ONCE, even
14	if you haven't changed anything.
15
16
17	INSTALLATION INSTRUCTIONS
18
19
20	To install and use this module:
21
22	0. Read the README.txt file thoroughly, and at least skim the TROUBLE.txt
23	file, which contains some common problems and how to avoid them.
24
25	1. Make sure the new version of image.module by "walkah" is installed and is
26	working properly. Verify that you can upload and display images alone and
27	in thumbnail galleries. This will require the 'upload' module to be
28	enabled and configured according to the instructions for Drupal itself.
29
30	2. Place image_import.module into your modules directory or an appropriate
31	subdirectory.
32
33	3. Enable the module in "admin/modules".
34
35	4. Enable the appropriate security permissions in "admin/access".
36
37	5. Configure image_import in "admin/settings/image_import". Create any
38	needed directories to hold the uploaded files for import, or change
39	the settings so that the import is from an existing directory.
40	CAUTION: DO NOT use the same directory where the images will be
41	permanently stored, and DO NOT use a directory containing other
42	Drupal files. It is STRONGLY suggested to have a directory (or a
43	directory tree) dedicated only to this function, with no other
44	files in that area of your web site.
45
46	Note that the above settings page will provide links (near the bottom)
47	that point to system settings pages that are relevant to this module.
48	You will want to visit each of those pages and make sure the settings
49	are correct. As mentioned in item #1 above, it is VERY important to
50	ensure that image.module, on which this module depends, is working
51	correctly before installing image_import.module.
52
53	The image import path must not be the same as the image module's
54	default image path. If you try to make them the same, image_import
55	will issue an error message.
56
57	There should now be an extra navigation menu entry under "create content"
58	(though in the current version, no menu entry appears in the main part of
59	the "create content" page, only in the side menu). The entry "import images"
60	from the menu will take you to the import screen.
61
62	6. Correct any errors that are reported as you arrive at the "import images"
63	screen.
64
65	Now you are ready to begin uploading and importing images! Here are the
66	steps:
67
68	0. (Optional) Go to the path node/add/image_import/help and review the
69	extensive built-in instructions for using the module.
70
71	1. Upload your image files (.jpg, .gif, and so on) together with their
72	caption files (*.txt, and so on) into the correct import directory based
73	on the module settings and your Drupal username. Caption filenames must
74	match exactly the corresponding image filenames, except for the extension.
75	So the caption file for "vacation-london-0032.jpg" must be precisely
76	"vacation-london-0032.txt", for example.
77
78	2. In the "import images" screen, choose the appropriate options such as
79	which image album and other categories (if applicable) to assign to
80	the images you are about to import. The same album and categories
81	will be assigned to all the images from a given import run.
82
83	3. Click "Preview" to have image_import scan to see if it thinks it can
84	successfully import these files. You will get a report of what the
85	preview found. Correct any problems before proceeding.
86
87	4. Click "Import images" to do the real import. If your import is
88	set to delete the uploaded files, it will erase the images and their
89	captions from the import directory each time an image is successfully
90	added to Drupal.
91
92	5. Visit the galleries to see how your images look.