// $Id$
---------------------------
-- CONTENTS OF THIS FILE --
---------------------------
* Introduction
  - SimpleUpdateProtocol (SUP)
  - PubSubHubbbub
* Summary
  - fastwebfeed.module
  - fastwebfeed_sup.module
  - fastwebfeed_pubsubhubbub.module
  - fastwebfeed_commentrss.module
* Installation
* Configuration
* Contact

------------------
-- Introduction --
------------------

The "Fastwebfeed" module is a simple way to let people know in real-time when your blog is updated.

This Module supports:
* SimpleUpdateProtocol (SUP)
* PubSubHubbub
* PubSubHubbub and SUP in the "rss.xml"
* PubSubHubbub and SUP in the "taxonomy" feeds
* PubSubHubbub and SUP in the "comment" feeds

The "Fastwebfeed" module is a Beta version, please contact me if you have issues/features requests.
Current maintainer: Jo Bollen (JoBo) http://drupal.org/user/111415
Documentation: http://cupid-project.be/project/fastwebfeed-module

Licensed under the GNU/GPL License

SimpleUpdateProtocol (SUP)
==========================
Simple Update Protocol (SUP) is quickly gaining adoption and is already being used by Friendfeed, ...

For more information about the Simple Update Protocol (SUP) protocol, please visit:
* http://code.google.com/p/simpleupdateprotocol/

PubSubHubbub
============
PubSubHubbub is quickly gaining adoption and is already being used by Google (GTalk), SuperFeedr, ...

For more information about the PubSubHubbub protocol, please visit:
* http://code.google.com/p/pubsubhubbub/

-------------
-- SUMMARY --
-------------

fastwebfeed.module
==================
invoke PubSubHubbub and Sup in the
* "rss.xml"
* "taxonomy" feeds (ex. /taxonomy/term/?/0/feed

fastwebfeed_sup.module
==========================
* supports multiple SUP services
* pings your SUP services every time a feed is updated
* includes the SUP-ID HTTP header on your RSS feed, e.g. X-SUP-ID: http://friendfeed.com/api/public-sup.json#SUP-ID
* announces which SUP services you are using by adding <atom:link rel=" ...> declarations to your feed.
* adds <atom:link ...> to your RSS feeds along with the necessary XMLNS declaration for RSS 0.92/1.0

By default this plugin will ping the following services:
* http://friendfeed.com/api/public-sup-ping [Friendfeed]

fastwebfeed_pubsubhubbub.module
===============================
* supports multiple hubs
* pings your hubs every time a feed is updated
* announces which hubs you are using by adding <link rel="hub" ...> declarations to your feed
* adds <atom:link rel="hub" ...> to your RSS feeds along with the necessary XMLNS declaration for RSS 0.92/1.0

By default this plugin will ping the following hubs:
* http://pubsubhubbub.appspot.com [Demo hub on Google App Engine]
* http://superfeedr.com/hubbub [SuperFeedr]

fastwebfeed_commentrss.module
=============================
Invokes PubSubHubbub and Sup in the "comment" feeds
* crss
* crss/node/?
* crss/term/?

------------------
-- REQUIREMENTS --
------------------

* fastwebfeed_pubsubhubbub.module
  - Copy the publisher.php file from PHP library (http://code.google.com/p/pubsubhubbub/source/browse/trunk/publisher_clie...)
    to sites/all/module/fastwebfeed/fastwebfeed_pubsubhubbub/includes/

------------------
-- INSTALLATION --
------------------

* Copy the Fastwebfeed module directory to your sites/all/modules directory.

* Enable the module at Administer >> Site building >> Modules.

* If desired, configure the module at Administer >> Site configuration >> Fastwebfeed

-------------------
-- CONFIGURATION --
-------------------
  
1. Administer >> Site configuration >> Fastwebfeed

1.1. Administer >> Site configuration >> Fastwebfeed >> Settings

   1.1.1. "Settings: Fastwebfeed"
   1.1.1.1. "When to ping (or notify)?"
            The question is, when to ping a service (or notify a hub) with an one of the following "default" feeds?.
            example: * http://local-cupid-d6/rss.xml
                     * http://local-cupid-d6/taxonomy/term/1/0/feed
   1.1.1.1.a (checkbox) On "node" submission.
             If checked, the hubs/services will be notified on "node" submission with a update notification refered to one of the above "default" feeds.
   1.1.1.2. "What to ping (or notify)?"
            The question is, which default feed must be pinged (or must be notified) to a service (or a hub)?.
   1.1.1.2.1. "rss.xml feed"
              example: http://local-cupid-d6/rss.xml
   1.1.1.2.1.a. "rss.xml"
                If checked, the following feed will be notified/pinged.
   1.1.1.2.2. "node type"
   1.1.1.2.2.a. (checkbox) "All node types"
                If checked, the feeds of "All node types" will be notified/pinged.
   1.1.1.2.2.b. (checkbox) "One of the following node types"
                If checked, only the feeds of "One of the following node types" will be notified/pinged.
   1.1.1.2.2.c. (select) "Overview of node types:"
                Select one of the following node types.
                This effects the update notification of
                 * the "rss.xml" above.
                 * the "taxonomy feed(s)" below.
   1.1.1.2.3. "taxonomy feed(s)"
                example: http://local-cupid-d6/taxonomy/term/1/0/feed
   1.1.1.2.3.a. (checkbox) "All terms"
                If checked, the taxonomy feeds of "All terms" will be notified/pinged.
   1.1.1.2.3.a. (checkbox) "One of the following terms"
                If checked, only the taxonomy feeds of "One of the following terms" will be notified/pinged.
   1.1.1.2.3.c. (select) "Overview of terms"
  
   1.1.2. "Settings: PubSubHubbub"
   1.1.2.1. "Hubs"
   1.1.2.1.a. (checkbox) "Active Hubs"
              This multiple-select activates the hubs where the module pings to by an insertion of a new node in the feed.

   1.1.3. "Settings: SUP"
   1.1.3.1. "Services"
   1.1.3.1.a. (checkbox) "Activate the SUP service"
              If checked, the SUP services will be activated and your website will send update notifications to them.
   1.1.3.1.b. (select) "Active services"
              This multiple-select activates the hubs where the module pings to by an insertion of a new node in the feed.
              
   1.1.4. "Watchdog Log"
          This will activate the watchdog log each time you ping a service or hub.

1.2. Administer >> Site configuration >> Fastwebfeed >> Plugged Module

1.2.1. "Settings: RSS comment"
   1.2.1.1. "When to ping (or notify)?"
            The question is, when to ping a service (or notify a hub) with an one of the following "comment" feeds?.
            example: * http://local-cupid-d6/crss
                     * http://local-cupid-d6/crss/node/1
                     * http://local-cupid-d6/crss/term/1
   1.2.1.1.a (checkbox) On "comment" submission.
             If checked, the hubs/services will be notified on "comment" submission with a update notification refered to one of the above "comment" feeds.
   1.2.1.2. "What to ping (or notify)?"
            The question is, which "comment" feed must be pinged (or must be notified) to a service (or a hub)?.
   1.2.1.2.1. "crss feed"
              example: http://local-cupid-d6/crss
   1.2.1.2.1.a. "Crss"
                If checked, the following "comment" feed will be notified/pinged.
   1.2.1.2.2. "node type fee(s)"
              example: http://local-cupid-d6/crss/node/1
   1.2.1.2.2.a. (checkbox) "All node types"
                If checked, the "comment" feeds of "All node types" will be notified/pinged.
   1.2.1.2.2.b. (checkbox) "One of the following node types"
                If checked, only the "comment" feeds of "One of the following node types" will be notified/pinged.
   1.2.1.2.2.c. (select) "Overview of node types:"
                Select one of the following node types.
                This effects the update notification of
                 * the "crss feed" above.
                 * the "taxonomy feed(s)" below.
   1.2.1.2.3. "taxonomy feed(s)"
                example: http://local-cupid-d6/crss/term/1
   1.2.1.2.3.a. (checkbox) "All terms"
                If checked, the "comment" feeds of "All terms" will be notified/pinged.
   1.2.1.2.3.a. (checkbox) "One of the following terms"
                If checked, only the "comment" feeds of "One of the following terms" will be notified/pinged.
   1.2.1.2.3.c. (select) "Overview of terms"
                

1.3. Administer >> Site configuration >> Fastwebfeed >> Info
     A Overview of the Fastwebfeed URL's and extra links.

2. Administer >> Site configuration >> Fastwebfeed >> SubPubHubbub

2.1. Administer >> Site configuration >> Fastwebfeed >> SubPubHubbub >> Hub(s) settings
   2.1.1. "Hub(s) settings"
   2.1.1.1. "Edit a specific Hub"
            Here you can editing existing hub definitions.
   2.1.1.2. "Add a Hub"
            Here you can add new hub definitions.
            * Status: If checked then the PubSubHubbub service will be activated. So you can find this service in the multiple select of the "Fastwebfeed settings" page.
            * Service name: The name of the PubSubHubbub service.
            * Service name description: A description of the PubSubHubbub service.
            * Service URL: The PubSubHubbub URL. So when the feed is updated, the module notifies this URL.

    
3. Administer >> Site configuration >> Fastwebfeed >> SUP

3.1. Administer >> Site configuration >> Fastwebfeed >> SUP >> Service(s) settings
   3.1.1. "Service(s) settings"
   3.1.1.1. "Edit a specific Service"
            Here you can editing existing SUP service definitions.
   3.1.1.2. "Add a service"
            Here you can add new SUP service definitions.
            * Status: If checked then the SUP service will be activated. So you can find this service in the multiple select of the "Fastwebfeed settings" page.
            * Service name: The name of the SUP service.
            * Service name description: A description of the SUP service.
            * Service ping URL: The ping URL. So when the feed is updated, the module pings this URL.
            * Service URL: The URL of the SUP service. This URL is set in the header of your RSS feed, e.g. X-SUP-ID: http://friendfeed.com/api/public-sup.json#SUP-ID
            * SUP-ID length: The length of the SUP-ID.
            
            
3.2. Administer >> Site configuration >> Fastwebfeed >> SUP >> Service <LINK> attributes
   3.2.1. "%service_name% <LINK> attributes"
   3.2.1.1. "Edit a specific attribute"
            Edit a <LINK>-attribute of the "friendfeed_public"-service definition.
   3.2.1.2. "Add a attribute"
            Add a <LINK>-attribute to the "friendfeed_public"-service definition.
            * Status: If checked then the attribute will be active in the <LINK> element.
            * SUP service ID: This is the ID of the SUP service you want to add a attribute to de <LINK> defenition. This field is disabled.
            * Attr. Key: This is the attribute name.
            * Attr. Value: This is the attribute name.

-------------
-- CONTACT --
-------------

Current maintainer(s):
* Jo Bollen (JoBo) http://drupal.org/user/111415

Documentation:
* http://cupid-project.be/project/fastwebfeed-module