function weight_help in Weight 5

Same name and namespace in other branches

1. 6 weight.module \weight_help()
2. 7 weight.module \weight_help()

Implementation of hook_help().

File

./weight.module, line 15

Code

function weight_help($section) {
  switch ($section) {
    case 'admin/setting/weight':
    case 'admin/modules#description':
      return t('Add weight-based sorting to nodes.');
    case 'admin/help#weight':
      return t('
        <p><strong>Description:</strong> The weight module adds a weight option
        to enabled node types. It uses the "sticky" field in the database to
        store weights as well as sticky information (so that feature is not
        lost). Nodes will be sorted first by stickiness, then by weight
        (lightest to heaviest), then by creation date.</p>

        <p><strong>Setup:</strong> To enable weight sorting on existing nodes,
        visit the <a href="@setup">weight db setup page</a> and click
        "Setup Database" to convert old sticky values to new weight-encoded values for
        proper sorting.</p>

        <p><strong>Permissions:</strong> Users with "administer nodes"
        permission will always be able to adjust weight for enabled node types.
        However, enabling "assign node weight" will allow non-node-admin users
        to adjust weight on their own nodes. Find these settings <a
        href="@access">here</a>.</p>

        <p><strong>Bulk weight management:</strong> You may easily manage the
        weight of multiple nodes simultaneously by using the <a href="@node_admin">
        node admin page</a>.</p>
      ', array(
        '@setup' => url('admin/settings/weight/setup'),
        '@access' => url('admin/user/access'),
        '@node_admin' => url('admin/content/node'),
      ));
  }
}