You are here

README.txt in Image Assist 5.3

Same filename and directory in other branches
  1. 5 README.txt
  2. 5.2 README.txt
  3. 6.2 README.txt
  4. 6 README.txt
-- 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>

* 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 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. Users with the 'access all images' permission will also be able to
  use other images, but only if they are published.

* 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.

File

README.txt
View source
  1. -- SUMMARY --
  2. Image Assist provides a user interface for adding images to any textarea that is
  3. aware of input formats.
  4. For a full description visit the project page:
  5. http://drupal.org/project/img_assist
  6. Bug reports, feature suggestions and latest developments:
  7. http://drupal.org/project/issues/img_assist
  8. -- REQUIREMENTS --
  9. * Image module
  10. * Token module (optional)
  11. * Wysiwyg API module (optional)
  12. -- INSTALLATION --
  13. * Install as usual, see http://drupal.org/node/70151 for further information.
  14. -- CONFIGURATION --
  15. * Configure an input format and enable the filter 'Inline images' by visiting:
  16. Administer >> Site configuration >> Input formats
  17. If you want to enable Inline images for the input format 'Filtered HTML',
  18. you additionally need to click the 'Configure' tab and add
  19. to the text field 'Allowed HTML tags'.
  20. * Configure user permissions in Administer >> User management >> Access control
  21. >> Image assist.
  22. * Optionally fine tune how Image Assist operates by navigating to:
  23. Administer >> Site configuration >> Image assist
  24. If Taxonomy module is enabled, you use a gallery module like Acidfree, and you
  25. want your users to be able to easily choose images from their galleries, select
  26. for example "Acidfree albums" as the vocabulary to use for Image assist.
  27. * If Wysiwyg API module is installed, you need to edit your Wysiwyg profiles
  28. and enable the plugin for Image assist.
  29. -- USAGE --
  30. * Using this module with TinyMCE via Wysiwyg API module:
  31. 1. Click the camera icon on the TinyMCE toolbar.
  32. 2. Upload a new photo or choose an existing image.
  33. 3. Set the properties for how you want the image to display.
  34. 4. Click the Insert button.
  35. * Using this module with any textarea:
  36. 1. Click the "Add image" link or camera icon under any textarea box.
  37. 2. Upload a new photo or choose an existing image.
  38. 3. Set the properties for how you want the image to display.
  39. 4. Click the Insert button.
  40. * Most browsers, such as Internet Explorer and Mozilla clones, will insert the
  41. image exactly where you place your cursor in the textarea of your content
  42. form. Otherwise the image will be appended to the end of your entry.
  43. * Adding images with Image module
  44. Users with the 'access img_assist' permission will see the 'add image' link
  45. or icon (configurable). Access to img_assist via the TinyMCE plugin is
  46. controlled by the Wysiwyg API module.
  47. Users with the 'create images' permission will be able to upload images using
  48. img_assist. Users with the 'access all images' permission will also be able to
  49. use other images, but only if they are published.
  50. * Image presentation
  51. A full img_assist tag looks like this:
  52. [img_assist|nid=2|title=My title|desc=My description|align=right|width=200|height=150|link=url,http://www.google.com]
  53. -- TROUBLESHOOTING --
  54. * If your site is accessible from multiple domains, embedded image tags and
  55. links in contents will point to the domain/URL that was accessed upon first
  56. view of a content. In most cases, you want to re-generate this cached content
  57. after staging from a development server to a live server. For this purpose,
  58. go to Image Assist's settings page and click on the link (pointing to
  59. 'img_assist/cache/clear') in the help text at the beginning of the page.
  60. To circumvent this permanently, as with any other module, you need to setup
  61. separate database tables for Drupal's cache. Image Assist primarily works in
  62. the cache_filter table. See sites/default/settings.php for more information.
  63. * In front of submitting a new bug report, support or feature request, please
  64. search the issue queue for already existing issues.
  65. Note: FAILURE TO DO SO WILL EXTEND THE TIME FOR ISSUES TO BE SOLVED.
  66. * If you are successfully using this module, please consider helping out on
  67. support requests in the issue queue.
  68. * If you have a development site in progress, please test patches needing review.
  69. See http://drupal.org/patch/apply for further information.
  70. -- CONTACT --
  71. Current maintainers:
  72. * Daniel F. Kudwien (sun)
  73. * Hannes Lilljequist (zoo33)
  74. * Darren Oh (darrenoh)
  75. Previous maintainers:
  76. * Benjamin Shell (benshell)
  77. * Matt Westgate (matt westgate)
  78. This project has been sponsored by:
  79. * UNLEASHED MIND
  80. Specialized in consulting and planning of Drupal powered sites, UNLEASHED
  81. MIND offers installation, development, theming, customization, and hosting
  82. to get you started. Visit http://www.unleashedmind.com for more information.