You are here

Home » API reference » Imagecache Token 7

README.txt in Imagecache Token 7 

ImageCache Token
----------------
This module provides additional tokens for image fields.

For each image style available, a token [node:field_image_field:STYLENAME] will
be provided.

Various properties for each image style are also available:
* [node:field_image_field:STYLENAME:height] - The image's height.
* [node:field_image_field:STYLENAME:width] - The image's width.
* [node:field_image_field:STYLENAME:mimetype] - The image's MIME type.
* [node:field_image_field:STYLENAME:extension] - The image's file extension.
* [node:field_image_field:STYLENAME:filesize] - The image's file size.
* [node:field_image_field:STYLENAME:path] - The image's path.
* [node:field_image_field:STYLENAME:render] - Full HTML for the image, as
  generated via theme('image_formatter').


Configuration
--------------------------------------------------------------------------------
Because "file" and "media" file types may contain other types of files, not just
images, it is necessary to indicate which fields hold images. Field selection is
controlled via the settings page:
  * admin/config/media/imagecache-token

All image fields are automatically supported by Imagecache Token, nothing needs to be done.

Both "File" and "Media" fields may be used for images, but they may also be
used for other types of files. Select the fields that are used for images so
that tokens can be added for them.


Known Issues
--------------------------------------------------------------------------------
After creating new image style it might not appear immediately in available
tokens list. To resolve this try reseting the cache on the Performance page or
using Drush.

A known problem with the Token module can result in a timeout attempting to load
the token browser if there are a lot of entity types and/or fields on the site.
The problem is most notable when using the Entity Token module part of the
Entity API module, which is required when using the Commerce system. There is no
current fix for the problem, though there are some workarounds available:
* Even if the token browser is unresponsive, the tokens themselves will still
  work, so experiment with manually creating the tokens.
* Use the Token Tweaks module to limit how many levels of the token tree will
  be displayed: https://www.drupal.org/project/token_tweaks
* Collaborate on fixing the problem in the Token module:
  https://www.drupal.org/node/1334456
* Use the Fast Token Browser module which extends the Token module with a faster
  and more usable interface for browsing and inserting Tokens. It resolves
  excessive server-side memory usage and client-side unresponsiveness when
  using the token browser on sites with many tokens. Due to the magnitude of
  memory savings, this allows the token browser to work with a very low PHP
  memory limit, even without needing to constrain the maximum token depth.
  https://www.drupal.org/project/fast_token_browser


Drupal 8 port
--------------------------------------------------------------------------------
Thanks to work from Sascha Grossenbacher [1], Francis de Lasalle [2],
silkogelman [3] and others, the functionality has been merged into the Token module itself, so a separate module will not be needed for D8.


Credits
--------------------------------------------------------------------------------
Currently maintained by Damien McKenna [4]. Originally written by Pavel A.
Karoukin [5] with contributions by Pascal Crott [6] and others in the community.

Ongoing development is sponsored by Mediacurrent [7].

The best way to contact the authors is to submit an issue, be it a support
request, a feature request or a bug report, in the project issue queue:
  https://www.drupal.org/project/issues/metatag


References
--------------------------------------------------------------------------------
1: https://www.drupal.org/u/berdir
2: https://www.drupal.org/u/bambell
3: https://www.drupal.org/u/silkogelman
4: https://www.drupal.org/u/damienmckenna
5: https://www.drupal.org/u/hydra
6: https://www.drupal.org/u/monstrfolk
7: https://www.mediacurrent.com/

File

README.txt
View source 
  1. ImageCache Token

  2. ----------------

  3. This module provides additional tokens for image fields.

  4. 

  5. For each image style available, a token [node:field_image_field:STYLENAME] will

  6. be provided.

  7. 

  8. Various properties for each image style are also available:

  9. * [node:field_image_field:STYLENAME:height] - The image's height.

  10. * [node:field_image_field:STYLENAME:width] - The image's width.

  11. * [node:field_image_field:STYLENAME:mimetype] - The image's MIME type.

  12. * [node:field_image_field:STYLENAME:extension] - The image's file extension.

  13. * [node:field_image_field:STYLENAME:filesize] - The image's file size.

  14. * [node:field_image_field:STYLENAME:path] - The image's path.

  15. * [node:field_image_field:STYLENAME:render] - Full HTML for the image, as

  16.   generated via theme('image_formatter').

  17. 

  18. 

  19. Configuration

  20. --------------------------------------------------------------------------------

  21. Because "file" and "media" file types may contain other types of files, not just

  22. images, it is necessary to indicate which fields hold images. Field selection is

  23. controlled via the settings page:

  24.   * admin/config/media/imagecache-token

  25. 

  26. All image fields are automatically supported by Imagecache Token, nothing needs to be done.

  27. 

  28. Both "File" and "Media" fields may be used for images, but they may also be

  29. used for other types of files. Select the fields that are used for images so

  30. that tokens can be added for them.

  31. 

  32. 

  33. Known Issues

  34. --------------------------------------------------------------------------------

  35. After creating new image style it might not appear immediately in available

  36. tokens list. To resolve this try reseting the cache on the Performance page or

  37. using Drush.

  38. 

  39. A known problem with the Token module can result in a timeout attempting to load

  40. the token browser if there are a lot of entity types and/or fields on the site.

  41. The problem is most notable when using the Entity Token module part of the

  42. Entity API module, which is required when using the Commerce system. There is no

  43. current fix for the problem, though there are some workarounds available:

  44. * Even if the token browser is unresponsive, the tokens themselves will still

  45.   work, so experiment with manually creating the tokens.

  46. * Use the Token Tweaks module to limit how many levels of the token tree will

  47.   be displayed: https://www.drupal.org/project/token_tweaks

  48. * Collaborate on fixing the problem in the Token module:

  49.   https://www.drupal.org/node/1334456

  50. * Use the Fast Token Browser module which extends the Token module with a faster

  51.   and more usable interface for browsing and inserting Tokens. It resolves

  52.   excessive server-side memory usage and client-side unresponsiveness when

  53.   using the token browser on sites with many tokens. Due to the magnitude of

  54.   memory savings, this allows the token browser to work with a very low PHP

  55.   memory limit, even without needing to constrain the maximum token depth.

  56.   https://www.drupal.org/project/fast_token_browser

  57. 

  58. 

  59. Drupal 8 port

  60. --------------------------------------------------------------------------------

  61. Thanks to work from Sascha Grossenbacher [1], Francis de Lasalle [2],

  62. silkogelman [3] and others, the functionality has been merged into the Token module itself, so a separate module will not be needed for D8.

  63. 

  64. 

  65. Credits

  66. --------------------------------------------------------------------------------

  67. Currently maintained by Damien McKenna [4]. Originally written by Pavel A.

  68. Karoukin [5] with contributions by Pascal Crott [6] and others in the community.

  69. 

  70. Ongoing development is sponsored by Mediacurrent [7].

  71. 

  72. The best way to contact the authors is to submit an issue, be it a support

  73. request, a feature request or a bug report, in the project issue queue:

  74.   https://www.drupal.org/project/issues/metatag

  75. 

  76. 

  77. References

  78. --------------------------------------------------------------------------------

  79. 1: https://www.drupal.org/u/berdir

  80. 2: https://www.drupal.org/u/bambell

  81. 3: https://www.drupal.org/u/silkogelman

  82. 4: https://www.drupal.org/u/damienmckenna

  83. 5: https://www.drupal.org/u/hydra

  84. 6: https://www.drupal.org/u/monstrfolk

  85. 7: https://www.mediacurrent.com/