function location_help in Location 5

Same name and namespace in other branches

1. 5.3 location.module \location_help()
2. 6.3 location.module \location_help()
3. 7.5 location.module \location_help()
4. 7.3 location.module \location_help()
5. 7.4 location.module \location_help()

Implementation of hook_help.

File

./location.module, line 48

Code

function location_help($section) {
  switch ($section) {
    case 'admin/help#location':
      $output = '<p>' . t('The location module allows you to associate a geographic location with content and users. Users can do proximity searches by postal code.  This is useful for organizing communities that have a geographic presence.') . '</p>';
      $output .= '<p>' . t('To administer locative information for content, use the content type administration page.  To support most location enabled features, you will need to install the country specific include file.  To support postal code proximity searches for a particular country, you will need a database dump of postal code data for that country.  As of June 2007 only U.S. and German postal codes are supported.') . '</p>';
      $output .= t('<p>You can</p>
<ul>
<li>administer locative information at <a href="@admin-node-configure-types">Administer &gt;&gt; Content management &gt;&gt; Content types</a> to configure a type and see the locative information.</li>
<li>administer location at <a href="@admin-settings-location">Administer &gt;&gt; Site configuration &gt;&gt; Location</a>.</li>
<li>use a database dump for a U.S. and/or German postal codes table that can be found at <a href="@external-http-cvs-drupal-org">zipcode database</a>.</li>
', array(
        '@admin-node-configure-types' => url('admin/content/types'),
        '@admin-settings-location' => url('admin/settings/location'),
        '@external-http-cvs-drupal-org' => 'http://cvs.drupal.org/viewcvs/drupal/contributions/modules/location/database/',
      )) . '</ul>';
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="@location">Location page</a>.', array(
        '@location' => 'http://www.drupal.org/handbook/modules/location/',
      )) . '</p>';
      return $output;
  }
}