You are here

Home » API reference » Textimage 5.2

README.txt in Textimage 5.2

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

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.


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.


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

* GD2
* FreeType


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.

  Note: To get Vertical Tabs for Drupal 5, please refer to the following:
  - http://drupal.org/node/296148


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.

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. Textimage was written by Fabiano Sant'Ana (wundo).

  7. - http://wundo.net

  8. 

  9. Maintained by Stuart Clark (Deciphered).

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

  11. 

  12. 

  13. Features

  14. ------------

  15. 

  16. * Support for TrueType fonts and OpenType fonts.

  17. * Rotate your text at any angle.

  18. * Configurable opacity in text color.

  19. * Backgrounds:

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

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

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

  23. * CCK and Views formatter integration.

  24. * Support for non-alphanumeric characters.

  25. 

  26. 

  27. Usage

  28. ------------

  29. 

  30. 1. via theme_textimage_image():

  31. 

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

  33.    following format:

  34. 

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

  36.    'extension', 'alt', 'title')

  37. 

  38. 

  39. 2. via CCK/Views formatter:

  40. 

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

  42. 

  43. 

  44. 3. via URL:

  45. 

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

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

  48. 

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

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

  51. 

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

  53.    one of the methods detailed above.

  54. 

  55. 

  56. Requirements

  57. ------------

  58. 

  59. * GD2

  60. * FreeType

  61. 

  62. 

  63. Recommended

  64. ------------

  65. 

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

  67. 

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

  69.   interface when creating and editing Textimage presets.

  70. 

  71.   Note: To get Vertical Tabs for Drupal 5, please refer to the following:

  72.   - http://drupal.org/node/296148

  73. 

  74. 

  75. Updating

  76. ------------

  77. 

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

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

  80.   require alterations after updating.

  81.