modules/image_import/TROUBLE.txt

$Id: TROUBLE.txt,v 1.4 2005/06/30 03:22:57 syscrusher Exp $

               TROUBLESHOOTING IMAGE_IMPORT MODULE


There are a few very common errors that seem to occur when people try to use
this module for the first time. Here are some tips for preventing these errors.

* This module's key functions were totally rewritten on 2005-06-01, so if
  the version you have predates that, you need to update. REMEMBER THAT
  THIS MODULE IS STILL IN AN EARLY TEST PHASE, so it is NOT YET READY
  FOR PRODUCTION. Use at your own risk, in a test environment only.

* Be sure that content types of "image" and "image_import" both allow
  attachments. NOTE: You *must* save the settings for these content types
  even if you don't change any of the values.

* Go to the content types configuration for image_import and be sure to
  save the settings at least once; otherwise, a needed configuration variable
  is not properly set in the database. The Drupal path for this setting is
  q=admin/settings/content-types/image_import

* Be sure to visit q=admin/settings/image_import and save settings at least 
  once before you try an import. Do this even if the defaults look okay.

* Make sure you can import one image using image.module itself before you
  even attempt to use image_import.module to do multiples. This module relies
  on the underlying functionality of image.module to do much of its work, so
  if image.module isn't working, image_import.module is guaranteed to fail.

* The image import path is a different setting from the default image path
  set for image.module. In fact, these two paths *must* be different from
  one another. The image_import module now issues an error if they are the
  same.

* The caption feature is very useful, but beware of situations where the
  caption file can be ambiguous because of images that have the same base
  filename but different extensions. For example:

        myphoto-0035.gif
        myphoto-0035.png
        myphoto-0035.jpg
        myphoto-0035.html

  The HTML file (the last one) will be "found" as a caption for each of
  the three image files (the GIF, PNG, and JPG files) -- IF DELETE IS
  DISABLED -- because their names match. Perhaps this is useful, because
  chances are good that files with identical names are just different
  formats of the same image. But be sure this is what you want, not an
  accident. Rename some of the files if you want the caption only to
  apply to one image.

  Note that IF DELETE IS ENABLED, the caption will exist only for the
  first matching image file, and will have been deleted when the others
  are processed.
1	$Id: TROUBLE.txt,v 1.4 2005/06/30 03:22:57 syscrusher Exp $
2
3	TROUBLESHOOTING IMAGE_IMPORT MODULE
4
5
6	There are a few very common errors that seem to occur when people try to use
7	this module for the first time. Here are some tips for preventing these errors.
8
9	* This module's key functions were totally rewritten on 2005-06-01, so if
10	the version you have predates that, you need to update. REMEMBER THAT
11	THIS MODULE IS STILL IN AN EARLY TEST PHASE, so it is NOT YET READY
12	FOR PRODUCTION. Use at your own risk, in a test environment only.
13
14	* Be sure that content types of "image" and "image_import" both allow
15	attachments. NOTE: You must save the settings for these content types
16	even if you don't change any of the values.
17
18	* Go to the content types configuration for image_import and be sure to
19	save the settings at least once; otherwise, a needed configuration variable
20	is not properly set in the database. The Drupal path for this setting is
21	q=admin/settings/content-types/image_import
22
23	* Be sure to visit q=admin/settings/image_import and save settings at least
24	once before you try an import. Do this even if the defaults look okay.
25
26	* Make sure you can import one image using image.module itself before you
27	even attempt to use image_import.module to do multiples. This module relies
28	on the underlying functionality of image.module to do much of its work, so
29	if image.module isn't working, image_import.module is guaranteed to fail.
30
31	* The image import path is a different setting from the default image path
32	set for image.module. In fact, these two paths must be different from
33	one another. The image_import module now issues an error if they are the
34	same.
35
36	* The caption feature is very useful, but beware of situations where the
37	caption file can be ambiguous because of images that have the same base
38	filename but different extensions. For example:
39
40	myphoto-0035.gif
41	myphoto-0035.png
42	myphoto-0035.jpg
43	myphoto-0035.html
44
45	The HTML file (the last one) will be "found" as a caption for each of
46	the three image files (the GIF, PNG, and JPG files) -- IF DELETE IS
47	DISABLED -- because their names match. Perhaps this is useful, because
48	chances are good that files with identical names are just different
49	formats of the same image. But be sure this is what you want, not an
50	accident. Rename some of the files if you want the caption only to
51	apply to one image.
52
53	Note that IF DELETE IS ENABLED, the caption will exist only for the
54	first matching image file, and will have been deleted when the others
55	are processed.