function drupal_help in Drupal 5

Same name and namespace in other branches

1. 4 modules/drupal.module \drupal_help()

Implementation of hook_help().

1 call to drupal_help()

drupal_page_help in modules/drupal/drupal.module

Menu callback; print Drupal-authentication-specific information from user/help.

File

modules/drupal/drupal.module, line 11

Lets users log in using a Drupal ID and can notify a central server about your site.

Code

function drupal_help($section) {
  switch ($section) {
    case 'admin/help#drupal':
      $output = '<p>' . t('The Drupal module uses the XML-RPC network communication protocol to connect your site with a central server that maintains a directory of client sites.') . '</p>';
      $output .= t('<p>Enabling the Drupal module will allow you to:</p>
<ul>
  <li>register your site with a server, including (optionally) posting information on your installed modules and themes and summary statistics on your number of posts and users, information that can help rank Drupal modules and themes</li>
  <li>enable other sites to register with your site</li>
  <li>allow members on all sites using the Drupal module to log in to your site without registering using their distributed identification</li>
  <li>allow members to log in to any other site that uses the Drupal module, using a login name that looks much like an e-mail address: <em>username@example.com</em></li>
</ul>
');
      $output .= '<p>' . t('The Drupal module administration page allows you to set the xml-rpc server page and other related options.') . '</p>';
      $output .= t('<p>If you maintain a directory of sites, you can list them on a page using the <code>drupal_client_page()</code> function. Sample instructions: </p>
<ul>
  <li>Ensure that you have the page content type enabled, and you can use PHP in an input format.</li>
  <li>Select create content &gt;&gt; page.</li>
  <li>For input format, select PHP code.</li>
  <li>Give the page a title. For body, put:
<pre>
&lt;?php
print drupal_client_page();
?&gt;
</pre>
  <li>Save the page.</li>
</ul>');
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="@drupal">Drupal page</a>.', array(
        '@drupal' => 'http://drupal.org/handbook/modules/drupal/',
      )) . '</p>';
      return $output;
    case 'admin/settings/distributed-authentication':
      return '<p>' . t('Using this your site can "call home" to another Drupal server. By calling home to drupal.org and sending a list of your installed modules and themes, you help rank projects on drupal.org and so assist all Drupal administrators to find the best components for meeting their needs. If you want to register with a different server, you can change the Drupal XML-RPC server setting -- but the server has to be able to handle Drupal XML. Some XML-RPC servers may present directories of all registered sites. To get all your site information listed, go to the <a href="@site-settings">site information settings page</a> and set the site name, the e-mail address, the slogan, and the mission statement.', array(
        '@site-settings' => url('admin/settings/site-information'),
      )) . '</p>';
    case 'user/help#drupal':
      return variable_get('drupal_authentication_service', 0) ? t('<p><a href="@Drupal">Drupal</a> is the name of the software that powers %this-site. There are Drupal websites all over the world, and many of them share their registration databases so that users may freely log in to any Drupal site using a single <strong>Drupal ID</strong>.</p>
<p>So please feel free to log in to your account here at %this-site with a username from another Drupal site. The format of a Drupal ID is similar to an e-mail address: <strong>username</strong>@<em>server</em>. An example of a valid Drupal ID is <strong>mwlily</strong>@<em>drupal.org</em>.</p>', array(
        '@Drupal' => 'http://drupal.org',
        '%this-site' => variable_get('site_name', 'Drupal'),
      )) : '';
  }
}