mysite.module

INSTALL v 1.0
=========
Author: agentrickard
Drupal version: 4.7.x

CONTENTS
=======

1.     Installation
2.     Initial Configuration
3.     MySite Settings
3.1      User Settings
3.1.1   MySite Behavior
3.1.2   Content Types
3.1.3   Item Count
3.1.4   Element Count
3.2    Icon Settings
3.3    MySite Cache
3.4    Default MySite Page
3.5    Type-specific settings
3.5.1     Aggregator Settings
3.5.1.1     Aggregator Feeds
3.5.1.2     Allowed Feed Categories
3.5.1.3     Default Feed Category
3.5.1.4     Update Interval
3.5.2     Taxonomy Settings


/***
  1. Installation
  
MySite uses the standard Drupal 4.7 install system.  Simply put the module directory into your modules directory.  Then navigate to http://example.com/administer/modules and activate the mysite module.

After installation, you should check the Access Control settings.  See the README for details.

/***
  2. Initial Configuration
  
The MySite module is dependent on other modules, since all MySite does is present content in a new format.  To use MySite correctly, at least one of the following modules needs to be active:

  a) Aggregator
      If Aggregator is active, you must also configure at least one Aggregator category at http://example.com/admin/aggregator.
      If you wish to allow users to add new RSS feeds, set the appropriate Aggregator settings for MySite at http://example.com/admin/settings/mysite.
      Note that there are two types of feed handling in MySite.  'Web Feeds' refer to individual RSS feeds.  'Web Headlines' refer to Aggregator categories containing multiple RSS feeds.
      
  b) Blog
      If the Blog module is active, MySite will allow users to add any active blogger to their MySite page.
      
  c) Taxonomy
      If the taxonomy module is active, MySite will allow users to add tagged content to their MySite page.
      For this feature to work, you must have at least one Vocabulary and one Term created at http://example.com/admin/taxonomy.
      Note that Forum categories are not included in MySite's taxonomy-based lists.
      
  d) Forum
      If the Forum module is active, MySite will allow users to add Forum topics to their MySite page.
      For this feature to work, at least one forum container and one forum topic must be present.

/***
  3. MySite Settings
  
The following module settings are available.

/***
  3.1 User Settings
  
Options that affect user interaction with MySite.  

/***
  3.1.1 MySite Behavior

This option tells MySite how to behave when a vistor goes to http://example.com/mysite.
Most installation will use the default setting 'Go to User mysite,' which directs the user to http://example.com/mysite/UID/view.
The additional option mirrors the menu callback for http://example.com/mysite/all and is mainly used for debugging.
  
/***
  3.1.2 Content Types
  
On the MySite settings page (http://example.com/admin/settings/mysite), you have the option of enabling all content types that are available.  However, you are not required to offer all content to users.  Use these settings to determine which content types can be added to a MySite page.
Note: when a new Type plug-in is added to your module, a new option should appear in this list.

/***
  3.1.3 Item Count
  
Since MySite collects content from a variety of Drupal content, it can be resource intensive.  This setting puts a cap on the number of content groups a user can add to a MySite page.  The default is 10.

/***
  3.1.4 Element Count

MySite is meant to give a quick overview, not to substitute for reading the original content in context.  This setting limits the number of items (links) presented under each content group.  The default is 5.

/***
  3.2 Icon Settings
  
MySite ships with a small set of GPL icons, which can be used to present the action buttons to users.  Select the option that you prefer.  Default is 'text.'

/***
  3.3 Cache Settings

For high-traffic sites,  MySite might cause a high volume of database requests (especially if the Item and Element Count settings are very high).  If you have performance issues, you can cache the results of a MySite page view for a set amount of time.
For more information, see the README, section 2.3 MySite Cache.

/***
  3.4 Default MySite Page

In response to http://drupal.org/node/93012, the administrator can now set a default user id for MySite.  Visitors who browse to http://example.com/mysite/default will be taken to that user page.
Default value is NULL; if default user is not configured, then the page will return users to the standard behaviors defined in 3.1.1.

/***
  3.5 Type-specific settings
  
Type includes now contain their own configuration elements.   

/***
  3.5.1 Aggregator Settings
  
If the Aggregator module is enabled and you have given users the permission to 'add mysite feeds,' you will need to configure the default settings for handling new Aggregator feeds.  These settings help prevent users from overloading the Aggregator be setting throttles on update frequency.

/***
  3.5.1.1 Aggregator feeds
  
Only if you 'Allow users to add new feeds' will the access control settings appear.  Then you can give specific roles the ability to add new feeds.  Recommended use is to allow all registered users to add new feeds.

/***
  3.5.1.2 Allowed Feed Categories
  
When a user adds a new feed through MySite, they will only be given the catagory options that you allow.  If only one option is selected, there is no choice allowed and all user feeds will be filed under the default feed category.

/***
  3.5.1.3 Default Feed Category
  
Establishes the default feed cateogry for user-submitted feeds.

/***
  3.5.1.4 Update Interval
  
Sets the update interval for all user-submitted feeds.  

/***
  3.5.2  Taxonomy Settings

If the Taxonomy module is enabled, you must configure which taxonomy categories (Drupal vocabularies) that users may add to MySite pages.  At least one vocabulary must be selected, and that vocabulary must have active terms.  