modules/textimage/README.txt

// $Id$

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


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.

1	// $Id$
2
3	Textimage adds text to image functionality using GD2 and Freetype, enabling
4	users to create crisp images on the fly for use as theme objects, headings or
5	limitless other possibilities.
6
7	Textimage was written by Fabiano Sant'Ana (wundo).
8	- http://wundo.net
9
10	Maintained by Stuart Clark (Deciphered).
11	- http://stuar.tc/lark
12
13
14	Features
15	------------
16
17	* Support for TrueType fonts and OpenType fonts.
18	* Rotate your text at any angle.
19	* Configurable opacity in text color.
20	* Backgrounds:
21	* Define a color or simply have a transparent background.
22	* Use a pre-made image to integrate directly with your theme.
23	* Use another Textimage preset to achieve a multi-layered image (see image above).
24	* CCK and Views formatter integration.
25	* Support for non-alphanumeric characters.
26
27
28	Usage
29	------------
30
31	1. via theme_textimage_image():
32
33	Use the theme_textimage_image() function at the theme/module level with the
34	following format:
35
36	theme('textimage_image', 'Preset', 'Text', array('Additional', 'Text'),
37	'extension', 'alt', 'title')
38
39
40	2. via CCK/Views formatter:
41
42	Select a Textimage preset in a text field display options.
43
44
45	3. via URL:
46
47	Create an image with the URL in following format:
48	/[files directory]/textimages/[Preset](/Additional/Text)/[Text].[extension]
49
50	Note: This method can only be used by users with the 'create textimages'
51	permission. This is to prevent Anonymous users from creating random images.
52
53	If you need dynamically created Textimages, it is strongly advised you use
54	one of the methods detailed above.
55
56
57	Requirements
58	------------
59
60	* GD2
61	* FreeType
62
63
64	Updating
65	------------
66
67	* Always run update.php on your Drupal site after updating Textimage.
68	* Note: Due to certain changes in the Textimage module, some of your presets may
69	require alterations after updating.
70