modules/subscribe/README.txt

********************************************************************
                     D R U P A L    M O D U L E
********************************************************************
Name: Subscribe Module
Author: John VanDyk <jvandyk at iastate dot edu>
Drupal: cvs
********************************************************************
DESCRIPTION:

Subscribes to channels published by publish.module. Nodes flow
through the channel from the publishing site to the subscribing
site.

Nodes can be pushed or pulled through the channel. When you set
up a new subscription, you choose whether you will be pulling the
nodes or whether the publishing site will be pushing them out
to you.

Here is how the node transfer works in a nutshell:

1. Publishing site does a node_load() on the node to be transferred.
2. Publishing site collects some metadata about itself.
3. Publishing site encodes and sends node via XML-RPC.

4. Subscribing site receives and decodes node via XML-RPC.
5. Subscribing site unpacks metadata, consisting of

site_url   the URL of the publishing site
site_name  the site name of the publishing site

6. Subscribing site touches up the node so it will be comfortable
   in the new site. Some of the things that happen:
   
   - a node_save() is done. Note that if the subscribing site
     is set up with the same modules as the publishing site, any
     data that was added to the node during the remote
     node_load() will be taken care of during the node and
     nodeapi callbacks on the subscribing site.
   
   - remote node ID, remote UID, and remote author username are
     saved in the subscribe_node database table
     
   - any taxonomy terms that arrive with the node are taken care
     of. Because remote-to-local vocabulary mapping is set up
     when a subscription is established, the subscribe module
     knows which vocabulary to add terms to. Or it may discard
     the terms if that's what you've selected.

********************************************************************
INSTALLATION:

1. Place the entire subscribe folder in the modules folder of
   your Drupal installation.
   
2. Go to administer > modules and enable the subscribe module.

3. You should now see a "subscribe" option in your menu tree.
   Click on it and you're read to add a channel.

********************************************************************
GETTING STARTED:

Note that when you subscribe to a channel, you must specify the
URL representing the XML-RPC endpoint of the site publishing the
channel (so Drupal knows where on the internet to make the request)
and you must specify the number of the channel you will subscribe
to (so Drupal knows which channel to request from the publishing
site). If the publishing site is a Drupal site, the URL will
typically be something like http://example.com/xmlrpc.php

********************************************************************
1	********************************************************************
2	D R U P A L M O D U L E
3	********************************************************************
4	Name: Subscribe Module
5	Author: John VanDyk <jvandyk at iastate dot edu>
6	Drupal: cvs
7	********************************************************************
8	DESCRIPTION:
9
10	Subscribes to channels published by publish.module. Nodes flow
11	through the channel from the publishing site to the subscribing
12	site.
13
14	Nodes can be pushed or pulled through the channel. When you set
15	up a new subscription, you choose whether you will be pulling the
16	nodes or whether the publishing site will be pushing them out
17	to you.
18
19	Here is how the node transfer works in a nutshell:
20
21	1. Publishing site does a node_load() on the node to be transferred.
22	2. Publishing site collects some metadata about itself.
23	3. Publishing site encodes and sends node via XML-RPC.
24
25	4. Subscribing site receives and decodes node via XML-RPC.
26	5. Subscribing site unpacks metadata, consisting of
27
28	site_url the URL of the publishing site
29	site_name the site name of the publishing site
30
31	6. Subscribing site touches up the node so it will be comfortable
32	in the new site. Some of the things that happen:
33
34	- a node_save() is done. Note that if the subscribing site
35	is set up with the same modules as the publishing site, any
36	data that was added to the node during the remote
37	node_load() will be taken care of during the node and
38	nodeapi callbacks on the subscribing site.
39
40	- remote node ID, remote UID, and remote author username are
41	saved in the subscribe_node database table
42
43	- any taxonomy terms that arrive with the node are taken care
44	of. Because remote-to-local vocabulary mapping is set up
45	when a subscription is established, the subscribe module
46	knows which vocabulary to add terms to. Or it may discard
47	the terms if that's what you've selected.
48
49	********************************************************************
50	INSTALLATION:
51
52	1. Place the entire subscribe folder in the modules folder of
53	your Drupal installation.
54
55	2. Go to administer > modules and enable the subscribe module.
56
57	3. You should now see a "subscribe" option in your menu tree.
58	Click on it and you're read to add a channel.
59
60	********************************************************************
61	GETTING STARTED:
62
63	Note that when you subscribe to a channel, you must specify the
64	URL representing the XML-RPC endpoint of the site publishing the
65	channel (so Drupal knows where on the internet to make the request)
66	and you must specify the number of the channel you will subscribe
67	to (so Drupal knows which channel to request from the publishing
68	site). If the publishing site is a Drupal site, the URL will
69	typically be something like http://example.com/xmlrpc.php
70
71	********************************************************************