modules/img_assist/README.txt

/* $Id: README.txt,v 1.19 2008/08/01 19:06:52 sun Exp $ */

-- SUMMARY --

Image Assist provides a user interface for adding images to any textarea that is
aware of input formats.

For a full description visit the project page:
  http://drupal.org/project/img_assist
Bug reports, feature suggestions and latest developments:
  http://drupal.org/project/issues/img_assist


-- REQUIREMENTS --

* Image module <http://drupal.org/project/image>

* Views module <http://drupal.org/project/views>

* Token module (optional) <http://drupal.org/project/token>

* Wysiwyg API module (optional) <http://drupal.org/project/wysiwyg>


-- INSTALLATION --

* Install as usual, see http://drupal.org/node/70151 for further information.


-- CONFIGURATION --

* Configure an input format and enable the filter 'Inline images' by visiting:

  Administer >> Site configuration >> Input formats

  If you want to enable Inline images for the input format 'Filtered HTML',
  you additionally need to click the 'Configure' tab and add

  <span> <img>

  to the text field 'Allowed HTML tags'.

* Configure user permissions in Administer >> User management >> Access control
  >> Image assist.

* Optionally go to the Views administration page and edit or clone Image
  Assist's default 'img_assist_browser' view for the image browser. If you
  intend to make major changes to the default view, you should click on 'Clone'
  and modify the new (duplicated) view instead.  When you are done, enable this
  view on Image Assist's settings page.

* Optionally fine tune how Image Assist operates by navigating to:

  Administer >> Site configuration >> Image assist

  If Taxonomy module is enabled, you use a gallery module like Acidfree, and you
  want your users to be able to easily choose images from their galleries, select
  for example "Acidfree albums" as the vocabulary to use for Image assist.

* If Wysiwyg API module is installed, you need to edit your Wysiwyg profiles
  and enable the plugin for Image assist.


-- USAGE --

* Using this module with TinyMCE via Wysiwyg API module:
  1. Click the camera icon on the TinyMCE toolbar.
  2. Upload a new photo or choose an existing image.
  3. Set the properties for how you want the image to display.
  4. Click the Insert button.

* Using this module with any textarea:
  1. Click the "Add image" link or camera icon under any textarea box. 
  2. Upload a new photo or choose an existing image.
  3. Set the properties for how you want the image to display.
  4. Click the Insert button.

* Most browsers, such as Internet Explorer and Mozilla clones, will insert the
  image exactly where you place your cursor in the textarea of your content
  form. Otherwise the image will be appended to the end of your entry.

* Adding images with Image module

  Users with the 'access img_assist' permission will see the 'add image' link
  or icon (configurable). Access to img_assist via the TinyMCE plugin is
  controlled by the Wysiwyg API module.  

  Users with the 'create images' permission will be able to upload images using
  img_assist. All users will be able to see and insert their own pictures, even
  if the image nodes are unpublished. Users with the 'access all images'
  permission will also be able to use other images, but only if they are
  published.

  One possible workflow would be to set images to be UNPUBLISHED by default.
  That way users can upload, categorize, and use images in img_assist without
  the images showing up anyway else on the site. Images that should  also be
  shown elsewhere on the site can manually be published by going to
  administer > content.

* Image presentation

  A full img_assist tag looks like this:

  [img_assist|nid=2|title=My title|desc=My description|align=right|width=200|height=150|link=url,http://www.google.com]


-- TROUBLESHOOTING --

* If your site is accessible from multiple domains, embedded image tags and
  links in contents will point to the domain/URL that was accessed upon first
  view of a content.  In most cases, you want to re-generate this cached content
  after staging from a development server to a live server.  For this purpose,
  go to Image Assist's settings page and click on the link (pointing to
  'img_assist/cache/clear') in the help text at the beginning of the page.

  To circumvent this permanently, as with any other module, you need to setup
  separate database tables for Drupal's cache.  Image Assist primarily works in
  the cache_filter table.  See sites/default/settings.php for more information.

* In front of submitting a new bug report, support or feature request, please
  search the issue queue for already existing issues.

  Note: FAILURE TO DO SO WILL EXTEND THE TIME FOR ISSUES TO BE SOLVED.

* If you are successfully using this module, please consider helping out on
  support requests in the issue queue.

* If you have a development site in progress, please test patches needing review.
  See http://drupal.org/patch/apply for further information.


-- CONTACT --

Current maintainers:
* Daniel F. Kudwien (sun) <http://www.unleashedmind.com>
* Hannes Lilljequist (zoo33) <http://www.perrito.se>
* Darren Oh (darrenoh) <http://darrenoh.dnsalias.com>

Previous maintainers:
* Benjamin Shell (benshell) <http://www.benjaminshell.com>
* Matt Westgate (matt westgate) <http://drupal.org/user/2275>

This project has been sponsored by:
* UNLEASHED MIND
  Specialized in consulting and planning of Drupal powered sites, UNLEASHED
  MIND offers installation, development, theming, customization, and hosting
  to get you started. Visit http://www.unleashedmind.com for more information.

1	/* $Id: README.txt,v 1.19 2008/08/01 19:06:52 sun Exp $ */
2
3	-- SUMMARY --
4
5	Image Assist provides a user interface for adding images to any textarea that is
6	aware of input formats.
7
8	For a full description visit the project page:
9	http://drupal.org/project/img_assist
10	Bug reports, feature suggestions and latest developments:
11	http://drupal.org/project/issues/img_assist
12
13
14	-- REQUIREMENTS --
15
16	* Image module <http://drupal.org/project/image>
17
18	* Views module <http://drupal.org/project/views>
19
20	* Token module (optional) <http://drupal.org/project/token>
21
22	* Wysiwyg API module (optional) <http://drupal.org/project/wysiwyg>
23
24
25	-- INSTALLATION --
26
27	* Install as usual, see http://drupal.org/node/70151 for further information.
28
29
30	-- CONFIGURATION --
31
32	* Configure an input format and enable the filter 'Inline images' by visiting:
33
34	Administer >> Site configuration >> Input formats
35
36	If you want to enable Inline images for the input format 'Filtered HTML',
37	you additionally need to click the 'Configure' tab and add
38
39	<span> <img>
40
41	to the text field 'Allowed HTML tags'.
42
43	* Configure user permissions in Administer >> User management >> Access control
44	>> Image assist.
45
46	* Optionally go to the Views administration page and edit or clone Image
47	Assist's default 'img_assist_browser' view for the image browser. If you
48	intend to make major changes to the default view, you should click on 'Clone'
49	and modify the new (duplicated) view instead. When you are done, enable this
50	view on Image Assist's settings page.
51
52	* Optionally fine tune how Image Assist operates by navigating to:
53
54	Administer >> Site configuration >> Image assist
55
56	If Taxonomy module is enabled, you use a gallery module like Acidfree, and you
57	want your users to be able to easily choose images from their galleries, select
58	for example "Acidfree albums" as the vocabulary to use for Image assist.
59
60	* If Wysiwyg API module is installed, you need to edit your Wysiwyg profiles
61	and enable the plugin for Image assist.
62
63
64	-- USAGE --
65
66	* Using this module with TinyMCE via Wysiwyg API module:
67	1. Click the camera icon on the TinyMCE toolbar.
68	2. Upload a new photo or choose an existing image.
69	3. Set the properties for how you want the image to display.
70	4. Click the Insert button.
71
72	* Using this module with any textarea:
73	1. Click the "Add image" link or camera icon under any textarea box.
74	2. Upload a new photo or choose an existing image.
75	3. Set the properties for how you want the image to display.
76	4. Click the Insert button.
77
78	* Most browsers, such as Internet Explorer and Mozilla clones, will insert the
79	image exactly where you place your cursor in the textarea of your content
80	form. Otherwise the image will be appended to the end of your entry.
81
82	* Adding images with Image module
83
84	Users with the 'access img_assist' permission will see the 'add image' link
85	or icon (configurable). Access to img_assist via the TinyMCE plugin is
86	controlled by the Wysiwyg API module.
87
88	Users with the 'create images' permission will be able to upload images using
89	img_assist. All users will be able to see and insert their own pictures, even
90	if the image nodes are unpublished. Users with the 'access all images'
91	permission will also be able to use other images, but only if they are
92	published.
93
94	One possible workflow would be to set images to be UNPUBLISHED by default.
95	That way users can upload, categorize, and use images in img_assist without
96	the images showing up anyway else on the site. Images that should also be
97	shown elsewhere on the site can manually be published by going to
98	administer > content.
99
100	* Image presentation
101
102	A full img_assist tag looks like this:
103
104	[img_assist\|nid=2\|title=My title\|desc=My description\|align=right\|width=200\|height=150\|link=url,http://www.google.com]
105
106
107	-- TROUBLESHOOTING --
108
109	* If your site is accessible from multiple domains, embedded image tags and
110	links in contents will point to the domain/URL that was accessed upon first
111	view of a content. In most cases, you want to re-generate this cached content
112	after staging from a development server to a live server. For this purpose,
113	go to Image Assist's settings page and click on the link (pointing to
114	'img_assist/cache/clear') in the help text at the beginning of the page.
115
116	To circumvent this permanently, as with any other module, you need to setup
117	separate database tables for Drupal's cache. Image Assist primarily works in
118	the cache_filter table. See sites/default/settings.php for more information.
119
120	* In front of submitting a new bug report, support or feature request, please
121	search the issue queue for already existing issues.
122
123	Note: FAILURE TO DO SO WILL EXTEND THE TIME FOR ISSUES TO BE SOLVED.
124
125	* If you are successfully using this module, please consider helping out on
126	support requests in the issue queue.
127
128	* If you have a development site in progress, please test patches needing review.
129	See http://drupal.org/patch/apply for further information.
130
131
132	-- CONTACT --
133
134	Current maintainers:
135	* Daniel F. Kudwien (sun) <http://www.unleashedmind.com>
136	* Hannes Lilljequist (zoo33) <http://www.perrito.se>
137	* Darren Oh (darrenoh) <http://darrenoh.dnsalias.com>
138
139	Previous maintainers:
140	* Benjamin Shell (benshell) <http://www.benjaminshell.com>
141	* Matt Westgate (matt westgate) <http://drupal.org/user/2275>
142
143	This project has been sponsored by:
144	* UNLEASHED MIND
145	Specialized in consulting and planning of Drupal powered sites, UNLEASHED
146	MIND offers installation, development, theming, customization, and hosting
147	to get you started. Visit http://www.unleashedmind.com for more information.
148