modules/taxonomy_ticker/README.txt

$Id$

README
------

Provides a block displaying titles of nodes in a scrolling news
ticker.

This module was sponsored by Koumbit.org.

Installation
------------

1. Copy all files in this directory to modules/taxonomy_ticker (i.e. a
   directory named 'taxonomy_ticker inside the Drupal modules/
   directory).

2. Make this module active (go to admin/modules page...).

3. Create a [taxonomy, category] to 'flag' nodes that are to be shown in
   the ticker.

4. Go to admin/settings/taxonomy_ticker and select the [taxonomy, category]
   that you just created.

5. Activate the block in admin/block.

6. Position the taxonomy_ticker block in your theme using something that
   looks like that :

#block-taxonomy_ticker-0 {
  position: absolute;
  left: 200px;
  top: 20px;
  background: transparent;
}

7. Test it! Create a node, put it in the [taxonomy, category] associated
   with the ticker and save.

Known Issues
--------------

You can have only one ticker block per page, because the javascript
relies on the id tag.

Only one block is exported.

...see todo, at the end of this file.

Authors
-------

 * Laurent Villeneuve created the javascript magic to make this happen.
 * Mathieu Petit-Clair (mathieu on drupal / scyrma  on freenode) made
   the basic framework of the module, glued everything together and
   is the current maintainer for the module.
 * The Anarcat provided CVS access, provided Drupal counseling and
   made the settings page.

Credits
------

Basic README structure and inspiration for the hooks implementaion
taken from taxonomy_dhtml.module by weitzman.

History
-------

 * First version written in Fall 2005.
 * Update to 4.7 done mid-June 2006 :
    Derek Kayfisher (kayfish) sent a patch for forms api
    Mathieu did the rest (mostly javascript activation)
 * Some improvements integrated at the same time (flexinode example in
    code and "better flowing")

Todo
----
 * Use regions!  Now that Drupal supports block in the header/footer, it would be nicer than using css
 * Better integration with Flexinode (or CCK, someday)
 * More options : empty lines (top/bottom), css classes to use ...
 * Support for more than one ticker per page
 * ...probably heaps of other stuff.
1	$Id$
2
3	README
4	------
5
6	Provides a block displaying titles of nodes in a scrolling news
7	ticker.
8
9	This module was sponsored by Koumbit.org.
10
11	Installation
12	------------
13
14	1. Copy all files in this directory to modules/taxonomy_ticker (i.e. a
15	directory named 'taxonomy_ticker inside the Drupal modules/
16	directory).
17
18	2. Make this module active (go to admin/modules page...).
19
20	3. Create a [taxonomy, category] to 'flag' nodes that are to be shown in
21	the ticker.
22
23	4. Go to admin/settings/taxonomy_ticker and select the [taxonomy, category]
24	that you just created.
25
26	5. Activate the block in admin/block.
27
28	6. Position the taxonomy_ticker block in your theme using something that
29	looks like that :
30
31	#block-taxonomy_ticker-0 {
32	position: absolute;
33	left: 200px;
34	top: 20px;
35	background: transparent;
36	}
37
38	7. Test it! Create a node, put it in the [taxonomy, category] associated
39	with the ticker and save.
40
41	Known Issues
42	--------------
43
44	You can have only one ticker block per page, because the javascript
45	relies on the id tag.
46
47	Only one block is exported.
48
49	...see todo, at the end of this file.
50
51	Authors
52	-------
53
54	* Laurent Villeneuve created the javascript magic to make this happen.
55	* Mathieu Petit-Clair (mathieu on drupal / scyrma on freenode) made
56	the basic framework of the module, glued everything together and
57	is the current maintainer for the module.
58	* The Anarcat provided CVS access, provided Drupal counseling and
59	made the settings page.
60
61	Credits
62	------
63
64	Basic README structure and inspiration for the hooks implementaion
65	taken from taxonomy_dhtml.module by weitzman.
66
67	History
68	-------
69
70	* First version written in Fall 2005.
71	* Update to 4.7 done mid-June 2006 :
72	Derek Kayfisher (kayfish) sent a patch for forms api
73	Mathieu did the rest (mostly javascript activation)
74	* Some improvements integrated at the same time (flexinode example in
75	code and "better flowing")
76
77	Todo
78	----
79	* Use regions! Now that Drupal supports block in the header/footer, it would be nicer than using css
80	* Better integration with Flexinode (or CCK, someday)
81	* More options : empty lines (top/bottom), css classes to use ...
82	* Support for more than one ticker per page
83	* ...probably heaps of other stuff.