You are here

Home » API reference » Textimage 6.2

README.txt in Textimage 6.2

Same filename and directory in other branches
  1. 8.4 README.txt
  2. 8.3 README.txt
  3. 5.2 README.txt
  4. 5 README.txt
  5. 7.3 README.txt
  6. 7.2 README.txt
Textimage adds text to image functionality using GD2 and Freetype, enabling
users to create crisp images on the fly for use as theme objects, headings or
limitless other possibilities.

This module requires clean URLs be enabled. Without clean URL support Textimage
is unable to cache images, which can cause serious performance problems.


Textimage was written by Fabiano Sant'Ana (wundo).
- http://wundo.net

Maintained by Stuart Clark (Deciphered).
- http://stuar.tc/lark


Features
------------

* Support for TrueType fonts and OpenType fonts.
* Rotate your text at any angle.
* Configurable opacity in text color.
* Backgrounds:
  * Define a color or simply have a transparent background.
  * Use a pre-made image to integrate directly with your theme.
  * Use another Textimage preset to achieve a multi-layered image (see image above).
* CCK and Views formatter integration.
* Support for non-alphanumeric characters.


Requirements
------------

* GD2
* FreeType


Install instructions
------------

1. Make sure your server supports the needed PHP extensions, if you're in a
   shared environment you may need help from your host.
   
2. Upload fonts files you want to use for Textimages to the 'fonts' directory
   inside textimage directory. If you want you can change this directory to 
   anywhere accessible by Drupal


Usage
------------

1. via theme_textimage_image():

   Use the theme_textimage_image() function at the theme/module level with the
   following format:

   theme('textimage_image', 'Preset', 'Text', array('Additional', 'Text'),
   'extension', 'alt', 'title')


2. via CCK/Views formatter:

   Select a Textimage preset in a text field display options.


3. via URL:

   Create an image with the URL in following format:
   /[files directory]/textimages/[Preset](/Additional/Text)/[Text].[extension]

   Note: This method can only be used by users with the 'create textimages'
   permission. This is to prevent Anonymous users from creating random images.

   If you need dynamically created Textimages, it is strongly advised you use
   one of the methods detailed above.


Recommended
------------

* Vertical Tabs - http://drupal.org/project/vertical_tabs

  When the Vertical Tabs module is enabled you will receive a modified user
  interface when creating and editing Textimage presets.


Updating
------------

* Always run update.php on your Drupal site after updating Textimage.
* Note: Due to certain changes in the Textimage module, some of your presets may
  require alterations after updating from 1.x to 2.x.

File

README.txt
View source 
  1. 

  2. Textimage adds text to image functionality using GD2 and Freetype, enabling

  3. users to create crisp images on the fly for use as theme objects, headings or

  4. limitless other possibilities.

  5. 

  6. This module requires clean URLs be enabled. Without clean URL support Textimage

  7. is unable to cache images, which can cause serious performance problems.

  8. 

  9. 

  10. Textimage was written by Fabiano Sant'Ana (wundo).

  11. - http://wundo.net

  12. 

  13. Maintained by Stuart Clark (Deciphered).

  14. - http://stuar.tc/lark

  15. 

  16. 

  17. Features

  18. ------------

  19. 

  20. * Support for TrueType fonts and OpenType fonts.

  21. * Rotate your text at any angle.

  22. * Configurable opacity in text color.

  23. * Backgrounds:

  24.   * Define a color or simply have a transparent background.

  25.   * Use a pre-made image to integrate directly with your theme.

  26.   * Use another Textimage preset to achieve a multi-layered image (see image above).

  27. * CCK and Views formatter integration.

  28. * Support for non-alphanumeric characters.

  29. 

  30. 

  31. Requirements

  32. ------------

  33. 

  34. * GD2

  35. * FreeType

  36. 

  37. 

  38. Install instructions

  39. ------------

  40. 

  41. 1. Make sure your server supports the needed PHP extensions, if you're in a

  42.    shared environment you may need help from your host.

  43.    

  44. 2. Upload fonts files you want to use for Textimages to the 'fonts' directory

  45.    inside textimage directory. If you want you can change this directory to 

  46.    anywhere accessible by Drupal

  47. 

  48. 

  49. Usage

  50. ------------

  51. 

  52. 1. via theme_textimage_image():

  53. 

  54.    Use the theme_textimage_image() function at the theme/module level with the

  55.    following format:

  56. 

  57.    theme('textimage_image', 'Preset', 'Text', array('Additional', 'Text'),

  58.    'extension', 'alt', 'title')

  59. 

  60. 

  61. 2. via CCK/Views formatter:

  62. 

  63.    Select a Textimage preset in a text field display options.

  64. 

  65. 

  66. 3. via URL:

  67. 

  68.    Create an image with the URL in following format:

  69.    /[files directory]/textimages/[Preset](/Additional/Text)/[Text].[extension]

  70. 

  71.    Note: This method can only be used by users with the 'create textimages'

  72.    permission. This is to prevent Anonymous users from creating random images.

  73. 

  74.    If you need dynamically created Textimages, it is strongly advised you use

  75.    one of the methods detailed above.

  76. 

  77. 

  78. Recommended

  79. ------------

  80. 

  81. * Vertical Tabs - http://drupal.org/project/vertical_tabs

  82. 

  83.   When the Vertical Tabs module is enabled you will receive a modified user

  84.   interface when creating and editing Textimage presets.

  85. 

  86. 

  87. Updating

  88. ------------

  89. 

  90. * Always run update.php on your Drupal site after updating Textimage.

  91. * Note: Due to certain changes in the Textimage module, some of your presets may

  92.   require alterations after updating from 1.x to 2.x.

  93.