function subscriptions_help in Subscriptions 5

Implementation of hook_help().

File

./subscriptions.module, line 24

Code

function subscriptions_help($section) {
  switch ($section) {
    case 'admin/help#subscriptions':

      // appears on the admin module help page
      return t('
        <p>This module enables users to subscribe to be notified of changes to threads, categories and content types.
        Once enabled, all nodes will have an additional link that allows the user to subscribe to them.
        Additionally, all users will be given an account option to auto-subscribe to any thread to which they post.
        No configuration is required for this module, although roles must be given permission to
        use it.</p>
        <p>While no configuration is required, administrators are offered a few configurable options:</p>
        <p>"<b>Omitted vocabularies</b>" allows the admin to exclude certain node categories from this list of those
        available for subscription.</p>
        <p>"<b>Omitted content types</b>" allows the admin to exclude certain content types from this list of those
        available for subscription.</p>
        <p>"<b>Notify poster of own posts</b>" sends a notification to a node poster about their own posts. Useful principally during testing. Default is OFF.</p>
        <p>"<b>Use cron for notifications</b>" allows you to postpone subscription
        notifications until the next cron job is run.  Default behavior is to notify all subscribers immediately
        upon content change.  This behavior is probably best for low volume sites, but high volume sites could
        observe appreciable pauses upon node or comment insert, and should probably use the cron option.
        <p>"<b>Display watchdog entries for successful mailings</b>" should also probably be disabled for high volume sites,
        as a large number of mailings could completely fill the log.</p>
        <p>"<b>Test held posts prior to sending</b>" tells Subscriptions to test if a node or comment
        is still active\\published prior toi sending a notification.  This is mainly to avoid sending
        notifications for for posts that have been deleted.  This will result in a small performance
        hit, and only makes sense if you are delaying the notifications with "Use cron for notifications".</p>
        <p>"<b>Show Subscriptions users menu on main menu</b>" tells Subscriptions to display the
        Subscriptions user menu, used to manage one\'s own subscriptions, on the main menu.  The default
        setting is OFF.</p>
        <p>"<b>Show Subscriptions users menu under \'my account\'</b>" tells Subscriptions to display the
        Subscriptions user menu, used to manage one\'s own subscriptions, under the \'My Account\' menu.  The default
        setting is ON.</p>
        <p>"<b>Set all users to \'autosubscribe\' by default</b>" set\'s the default value of the \'autosubscribe\'
        option in each user\'s account to ON.  This value will not be set, however, until the user saves their
        account preferences.  This, essentially, pre-checks the option associated with \'autosubscribe\'. The
        default value is OFF.</p>

      ');
  }
}