function system_help in Drupal 5

Same name and namespace in other branches

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

Implementation of hook_help().

File

modules/system/system.module, line 13

Configuration system that lets administrators modify the workings of the site.

Code

function system_help($section) {
  global $base_url;
  switch ($section) {
    case 'admin/help#system':
      $output = '<p>' . t('The system module provides system-wide defaults such as running jobs at a particular time, and storing web pages to improve efficiency. The ability to run scheduled jobs makes administering the web site more usable, as administrators do not have to manually start jobs. The storing of web pages, or caching, allows the site to efficiently re-use web pages and improve web site performance. The system module provides control over preferences, behaviours including visual and operational settings.') . '</p>';
      $output .= '<p>' . t('Some modules require regularly scheduled actions, such as cleaning up logfiles. Cron, which stands for chronograph, is a periodic command scheduler executing commands at intervals specified in seconds. It can be used to control the execution of daily, weekly and monthly jobs (or anything with a period measured in seconds). The aggregator module periodically updates feeds using cron. Ping periodically notifies services of new content on your site. Search periodically indexes the content on your site. Automating tasks is one of the best ways to keep a system running smoothly, and if most of your administration does not require your direct involvement, cron is an ideal solution. Cron can, if necessary, also be run manually.') . '</p>';
      $output .= '<p>' . t("There is a caching mechanism which stores dynamically generated web pages in a database. By caching a web page, the system module does not have to create the page each time someone wants to view it, instead it takes only one SQL query to display it, reducing response time and the server's load. Only pages requested by <em>anonymous</em> users are cached. In order to reduce server load and save bandwidth, the system module stores and sends cached pages compressed.") . '</p>';
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="@system">System page</a>.', array(
        '@system' => 'http://drupal.org/handbook/modules/system/',
      )) . '</p>';
      return $output;
    case 'admin':
      return '<p>' . t('Welcome to the administration section. Here you may control how your site functions.') . '</p>';
    case 'admin/by-module':
      return '<p>' . t('This page shows you all available administration tasks for each module.') . '</p>';
    case 'admin/build/themes':
      return '<p>' . t('Select which themes are available to your users and specify the default theme. To configure site-wide display settings, click the "configure" task above. Alternately, to override these settings in a specific theme, click the "configure" link for the corresponding theme. Note that different themes may have different regions available for rendering content like blocks. If you want consistency in what your users see, you may wish to enable only one theme.') . '</p>';
    case 'admin/build/themes/settings':
      return '<p>' . t('These options control the default display settings for your entire site, across all themes. Unless they have been overridden by a specific theme, these settings will be used.') . '</p>';
    case 'admin/build/themes/settings/' . arg(4):
      $reference = explode('.', arg(4), 2);
      $theme = array_pop($reference);
      return '<p>' . t('These options control the display settings for the <code>%template</code> theme. When your site is displayed using this theme, these settings will be used. By clicking "Reset to defaults," you can choose to use the <a href="@global">global settings</a> for this theme.', array(
        '%template' => $theme,
        '@global' => url('admin/build/themes/settings'),
      )) . '</p>';
    case 'admin/build/modules':
      return t('<p>Modules are plugins for Drupal that extend its core functionality. Here you can select which modules are enabled. Click on the name of the module in the navigation menu for their individual configuration pages. Once a module is enabled, new <a href="@permissions">permissions</a> might be made available. Modules can automatically be temporarily disabled to reduce server load when your site becomes extremely busy by enabling the throttle.module and checking throttle. The auto-throttle functionality must be enabled on the <a href="@throttle">throttle configuration page</a> after having enabled the throttle module.</p>
<p>It is important that <a href="@update-php">update.php</a> is run every time a module is updated to a newer version.</p><p>You can find all administration tasks belonging to a particular module on the <a href="@by-module">administration by module page</a>.</p>', array(
        '@permissions' => url('admin/user/access'),
        '@throttle' => url('admin/settings/throttle'),
        '@update-php' => $base_url . '/update.php',
        '@by-module' => url('admin/by-module'),
      ));
    case 'admin/build/modules/uninstall':
      return '<p>' . t('The uninstall process removes all data related to a module. To uninstall a module, you must first disable it. Not all modules support this feature.') . '</p>';
    case 'admin/logs/status':
      return '<p>' . t("Here you can find a short overview of your Drupal site's parameters as well as any problems detected with your installation. It is useful to copy/paste this information when you need support.") . '</p>';
  }
}