modules/path_image/README.txt

// $Id$

1. Installation
---------------

Copy the path_image.tar.gz file to your modules/ directory and unpack.
This will create modules/path_image folder.

Go to "Administer >> Site building >> Modules" and enable the "Path
image" module.

Go to "Administer >> User management >> Permissions" and setup the
roles to whom you wish to allow administration of the module.

Go to "Administer >> Site configuration >> Path image" to setup the
module (see below).

Go to "Administer >> Site building >> Blocks" to setup the block on
your page.

2. Configuration
----------------

  Block title: [default 'Path image']
    This sets the block title, blank out for no title.

  Image repository: [default 'images']
    The name of the folder in which the images are stored. Folder
    is relative the drupal 'files' folder as specified on the File
    system configuration page. No leading or trailing slashes.

  Allowable file types in repository: [default 'gif, jpg, png']
    A list of comma separated file extensions that will be scanned
    for in the file repsoitory. 

  Numeric parse halt: [default on]
    When searching paths the default is not to "look beyond" a numeric
    so for example node/243 would only search up to node/
    However, you may have a path like taxonomy/term/24/53 and you want
    at search all componets of the path inclusing the trailing numerics.
    If that's the case, switch this setting off.

  Default image for the homepage:
    This allows you to select an image that is displayed on the / root
    homepage of your site. A checkbox is provided to switch this feature
    on or off.

  Default image when no match made:
    This allows you to select an image that is displayed when no path 
    match is made. A checkbox is provided to switch this feature
    on or off.	

  Add a new path: Select an image:
    Enter here a new path to associate with an image (no leading/trailing
    slashes).

  Alter a path:  Select an image:
    An existing path can be amended here.

3. Paths
--------

A path match is done is reverse length order. Let's look at an example:

  taxonomy/term/3
  taxonomy

Searching is currently terminating at the first full numeric component of
the path, in this example, 3. The search would match any path that begins
'taxonomy/term' . If no match was found then the next search would be for
'taxonomy', etc.

Switching "Numeric parse halt" off would scan for all components of the path
including the numeric 3 in the example.

1	// $Id$
2
3	1. Installation
4	---------------
5
6	Copy the path_image.tar.gz file to your modules/ directory and unpack.
7	This will create modules/path_image folder.
8
9	Go to "Administer >> Site building >> Modules" and enable the "Path
10	image" module.
11
12	Go to "Administer >> User management >> Permissions" and setup the
13	roles to whom you wish to allow administration of the module.
14
15	Go to "Administer >> Site configuration >> Path image" to setup the
16	module (see below).
17
18	Go to "Administer >> Site building >> Blocks" to setup the block on
19	your page.
20
21	2. Configuration
22	----------------
23
24	Block title: [default 'Path image']
25	This sets the block title, blank out for no title.
26
27	Image repository: [default 'images']
28	The name of the folder in which the images are stored. Folder
29	is relative the drupal 'files' folder as specified on the File
30	system configuration page. No leading or trailing slashes.
31
32	Allowable file types in repository: [default 'gif, jpg, png']
33	A list of comma separated file extensions that will be scanned
34	for in the file repsoitory.
35
36	Numeric parse halt: [default on]
37	When searching paths the default is not to "look beyond" a numeric
38	so for example node/243 would only search up to node/
39	However, you may have a path like taxonomy/term/24/53 and you want
40	at search all componets of the path inclusing the trailing numerics.
41	If that's the case, switch this setting off.
42
43	Default image for the homepage:
44	This allows you to select an image that is displayed on the / root
45	homepage of your site. A checkbox is provided to switch this feature
46	on or off.
47
48	Default image when no match made:
49	This allows you to select an image that is displayed when no path
50	match is made. A checkbox is provided to switch this feature
51	on or off.
52
53	Add a new path: Select an image:
54	Enter here a new path to associate with an image (no leading/trailing
55	slashes).
56
57	Alter a path: Select an image:
58	An existing path can be amended here.
59
60	3. Paths
61	--------
62
63	A path match is done is reverse length order. Let's look at an example:
64
65	taxonomy/term/3
66	taxonomy
67
68	Searching is currently terminating at the first full numeric component of
69	the path, in this example, 3. The search would match any path that begins
70	'taxonomy/term' . If no match was found then the next search would be for
71	'taxonomy', etc.
72
73	Switching "Numeric parse halt" off would scan for all components of the path
74	including the numeric 3 in the example.
75