function path_help in Drupal 4

Same name and namespace in other branches

1. 8 core/modules/path/path.module \path_help()
2. 5 modules/path/path.module \path_help()
3. 6 modules/path/path.module \path_help()
4. 7 modules/path/path.module \path_help()
5. 9 core/modules/path/path.module \path_help()

Implementation of hook_help().

File

modules/path.module, line 11

Enables users to rename URLs.

Code

function path_help($section) {
  switch ($section) {
    case 'admin/help#path':
      $output = '<p>' . t('The path module allows you to specify aliases for Drupal URLs.  Such aliases improve readability of URLs for your users and may help internet search engines to index your content more effectively.  More than one alias may be created for a given page.') . '</p>';
      $output .= t('<p>Some examples of URL aliases are:</p>
<ul>
<li>user/login =&gt; login</li>
<li>image/tid/16 =&gt; store</li>
<li>taxonomy/term/7+19+20+21 =&gt; store/products/whirlygigs</li>
<li>node/3 =&gt; contact</li>
</ul>
');
      $output .= '<p>' . t('The path module enables an extra field for aliases in all node input and editing forms (when users have the appropriate permissions).  It also provides an interface to view and edit all URL aliases.  The two permissions are related to URL aliasing are "administer a list of URL aliases" and "add url aliases".  ') . '</p>';
      $output .= '<p>' . t('This module also comes with user-defined mass URL aliasing capabilities, which is useful if you wish to uniformly use URLs different from the default.  For example, you may want to have your URLs presented in a different language. Access to the Drupal source code on the web server is required to set up these kinds of aliases. ') . '</p>';
      $output .= t('<p>You can</p>
<ul>
<li>set the path for a post with the path module.</li>
<li>add a URL alias: <a href="%admin-path-add">administer &gt;&gt; url aliases &gt;&gt; add alias</a>.</li>
<li>administer the list of URL aliases: <a href="%admin-path">administer &gt;&gt; url aliases</a>.</li>
<li>read how to <a href="%external-http-drupal-org-node-15365">configure clean URLs</a> for your webserver.
<li>enable clean url\'s to remove the =? at <a href="%admin-settings">administer &gt;&gt; settings</a>.</li>
</ul>
', array(
        '%admin-path-add' => url('admin/path/add'),
        '%admin-path' => url('admin/path'),
        '%external-http-drupal-org-node-15365' => 'http://drupal.org/node/15365',
        '%admin-settings' => url('admin/settings'),
      ));
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="%path">Path page</a>.', array(
        '%path' => 'http://drupal.org/handbook/modules/path/',
      )) . '</p>';
      return $output;
    case 'admin/modules#description':
      return t('Allows users to rename URLs.');
    case 'admin/path':
      return t("<p>Drupal provides users complete control over URLs through aliasing.  This feature is typically used to make URLs human-readable or easy to remember.  For example, one could map the relative URL 'node/1' onto 'about'. Each system path can have multiple aliases.</p>");
    case 'admin/path/add':
      return t('<p>Enter the path you wish to create the alias for, followed by the name of the new alias.</p>');
  }
}