modules/tapatio/README.txt

DESCRIPTION
===============================================================================
Enable users to leverage a drupal system as a front end to twitter.com (and 
other sources in the future) allowing them to use drupal as a hub for message 
aggregation, moderation, and dispatching.

FEATURES
===============================================================================
* Tight integration with twitter.
    Operators, users with access to the drupal system, associate twitter 
    accounts with organic groups.  All tweets from followers of those accounts 
    will automatically get pulled into the drupal system as nodes.

* Communications moderation
    Operators will then add and moderate posts, voteing on them (automatically 
    dispatching at a configureable value), specifying priority levels, 
    associating with other groups (twitter accounts), marking as a duplicate of 
    another post, and dispatching.

* Detailed search / display interface
    Operators also have the abilty of searching for nodes by minutes since last 
    recieved, wether or not the node has been dispatched, the current vote 
    level, and wether or not the node has been prioritized.

* SMS Dispatching through twitter
    After a operator deems that a node is valid (ie. it has been verified by an 
    alternate source, it has been assigned a SMS message, and it has been 
    associated with a group) he or she can dispatch it.  This is essentially 
    posting the sms message of the node as a tweet for each twitter account 
    (group) that is associated with the node.

INSTALLATION
===============================================================================
It is recommended that you install this module through the tapatio install 
profille (http://rnc08coms.hackbloc.org/download).  However if you chose to 
install this module manually you will need to take the following steps:
- Download and install the required modules: userpoints
(http://drupal.org/project/userpoints), og (http://drupal.org/project/og),
views (http://drupal.org/project/views), votingapi 
(http://drupal.org/project/votingapi), and comms 
(http://rnc08coms.hackbloc.org/download).

- Download and unpack the ARC90 PHP Twitter API 
(http://lab.arc90.com/2008/06/php_twitter_api_client.php or 
http://rnc08coms.hackbloc.org/download) into the comms directory. After you do 
this the directory structure should look like
  comms/
    Arc90_Service_Twitter/
      lib/
        Arc90/
          Service/
            TwitterSearch.php
            Twitter.php
            Twitter/
              Exception.php
              Response.php
anything else in the Arc90_Service_Twitter can be deleted if you would like.

- Add a new content type named "Group" of type "group" that is used by og as a
"Group node" (administer > Content management > Content types > Add content type).

- Specify the Comms content type as one that can be used by og as "Standard 
group post (typically only author may edit). No email notification." 
(Administer > Content types > Content management > Content types > edit on the 
"Comms" line).

- Add a vocabulary name "Priority" for "Comms" nodes (Administer > Content 
management > Categories > Add Vocabulary).

- Add at least the following terms in the "Priority" vocabulary: "Emergency", 
"Info", "Warning" (Administer > Content management > Categories > add terms 
on the "Priority" line).

- Configure your cron job (http://drupal.org/cron) to run  at least on the 
minute.  The module is designed to pull content from twitter.com everytime 
the cron job runs.

NOTES
===============================================================================
- There are two views for comms data located respectively at /comms/slim and 
comms/full.  Each view takes the following arguments: minutes since recieved,
vote value, have or have not been dispatched, has or has not been categorized,
and priority level.  For example:
http://<url>/comms/slim/10/2/1/0/Emergency - shows the slim view for all nodes
recieved int he last 10 minutes, with a vote of 2, that have been dispatched, 
have not been categorized, and are marked with an Emergency priority.

- There is a search page with a form that will fill out of the view arguments for
you at comms/search

- Various settings for the module can be configured at Administer > Site
configuration > Comms module settings (TwitterAPI settings is a tab there
titled 'Comms Twitter API settings')


TODO/BUGS/FEATURE REQUESTS
===============================================================================
- see http://rnc08coms.hackbloc.org/node/1


CREDITS
===============================================================================
This module was written by the hackbloc staff <staff@hackbloc.org>, in hopes 
of "smashing the state" at the 2008 Rupublican National Convention.  They are 
probably down by the river smoking weeds as you read this.  
Contributers:
Mesuir Burf Letet <evoltech@hackbloc.org>
Impact!!! <impact@riseup.net>
Frenzy <frenzy@hackbloc.org>
Dixie Flatline <evoltech@hackbloc.org>
AlxCIAda <alxciada@hackbloc.org>
Mark Burdett <mark@indymedia.org>
Juozas Gaigalas <juozasgaigalas@gmail.com>
Rabble <evan@protest.net>
Blaine Cook <romeda@gmail.com>
1	DESCRIPTION
2	===============================================================================
3	Enable users to leverage a drupal system as a front end to twitter.com (and
4	other sources in the future) allowing them to use drupal as a hub for message
5	aggregation, moderation, and dispatching.
6
7	FEATURES
8	===============================================================================
9	* Tight integration with twitter.
10	Operators, users with access to the drupal system, associate twitter
11	accounts with organic groups. All tweets from followers of those accounts
12	will automatically get pulled into the drupal system as nodes.
13
14	* Communications moderation
15	Operators will then add and moderate posts, voteing on them (automatically
16	dispatching at a configureable value), specifying priority levels,
17	associating with other groups (twitter accounts), marking as a duplicate of
18	another post, and dispatching.
19
20	* Detailed search / display interface
21	Operators also have the abilty of searching for nodes by minutes since last
22	recieved, wether or not the node has been dispatched, the current vote
23	level, and wether or not the node has been prioritized.
24
25	* SMS Dispatching through twitter
26	After a operator deems that a node is valid (ie. it has been verified by an
27	alternate source, it has been assigned a SMS message, and it has been
28	associated with a group) he or she can dispatch it. This is essentially
29	posting the sms message of the node as a tweet for each twitter account
30	(group) that is associated with the node.
31
32	INSTALLATION
33	===============================================================================
34	It is recommended that you install this module through the tapatio install
35	profille (http://rnc08coms.hackbloc.org/download). However if you chose to
36	install this module manually you will need to take the following steps:
37	- Download and install the required modules: userpoints
38	(http://drupal.org/project/userpoints), og (http://drupal.org/project/og),
39	views (http://drupal.org/project/views), votingapi
40	(http://drupal.org/project/votingapi), and comms
41	(http://rnc08coms.hackbloc.org/download).
42
43	- Download and unpack the ARC90 PHP Twitter API
44	(http://lab.arc90.com/2008/06/php_twitter_api_client.php or
45	http://rnc08coms.hackbloc.org/download) into the comms directory. After you do
46	this the directory structure should look like
47	comms/
48	Arc90_Service_Twitter/
49	lib/
50	Arc90/
51	Service/
52	TwitterSearch.php
53	Twitter.php
54	Twitter/
55	Exception.php
56	Response.php
57	anything else in the Arc90_Service_Twitter can be deleted if you would like.
58
59	- Add a new content type named "Group" of type "group" that is used by og as a
60	"Group node" (administer > Content management > Content types > Add content type).
61
62	- Specify the Comms content type as one that can be used by og as "Standard
63	group post (typically only author may edit). No email notification."
64	(Administer > Content types > Content management > Content types > edit on the
65	"Comms" line).
66
67	- Add a vocabulary name "Priority" for "Comms" nodes (Administer > Content
68	management > Categories > Add Vocabulary).
69
70	- Add at least the following terms in the "Priority" vocabulary: "Emergency",
71	"Info", "Warning" (Administer > Content management > Categories > add terms
72	on the "Priority" line).
73
74	- Configure your cron job (http://drupal.org/cron) to run at least on the
75	minute. The module is designed to pull content from twitter.com everytime
76	the cron job runs.
77
78	NOTES
79	===============================================================================
80	- There are two views for comms data located respectively at /comms/slim and
81	comms/full. Each view takes the following arguments: minutes since recieved,
82	vote value, have or have not been dispatched, has or has not been categorized,
83	and priority level. For example:
84	http://<url>/comms/slim/10/2/1/0/Emergency - shows the slim view for all nodes
85	recieved int he last 10 minutes, with a vote of 2, that have been dispatched,
86	have not been categorized, and are marked with an Emergency priority.
87
88	- There is a search page with a form that will fill out of the view arguments for
89	you at comms/search
90
91	- Various settings for the module can be configured at Administer > Site
92	configuration > Comms module settings (TwitterAPI settings is a tab there
93	titled 'Comms Twitter API settings')
94
95
96
97	TODO/BUGS/FEATURE REQUESTS
98	===============================================================================
99	- see http://rnc08coms.hackbloc.org/node/1
100
101
102	CREDITS
103	===============================================================================
104	This module was written by the hackbloc staff <staff@hackbloc.org>, in hopes
105	of "smashing the state" at the 2008 Rupublican National Convention. They are
106	probably down by the river smoking weeds as you read this.
107	Contributers:
108	Mesuir Burf Letet <evoltech@hackbloc.org>
109	Impact!!! <impact@riseup.net>
110	Frenzy <frenzy@hackbloc.org>
111	Dixie Flatline <evoltech@hackbloc.org>
112	AlxCIAda <alxciada@hackbloc.org>
113	Mark Burdett <mark@indymedia.org>
114	Juozas Gaigalas <juozasgaigalas@gmail.com>
115	Rabble <evan@protest.net>
116	Blaine Cook <romeda@gmail.com>