function event_help in Event 5

Same name and namespace in other branches

1. 8 event.module \event_help()
2. 5.2 event.module \event_help()

Displays the help text for this module.

Parameters

$section the page which is requesting help:

Return value

the help text

Related topics

File

./event.module, line 2188

Code

function event_help($section) {
  switch ($section) {
    case 'admin/help#event':
      $output = '<p>' . t('The event module allows for any type of content to be event enabled,  meaning content can have a start and end time, and appear in calendars.  The ability to event enable any content type combined with the ability to create new types of content make it possible to create unlimited types of calendars.  The ability to broadly event enable content will allow for creative applications combining information and real world events.') . '</p>';
      $output .= '<p>' . t('The administrator can decide which content types should be events for their site.  In content type configuration, administrators can select the calendar view options: never, all views, or only views for this type. For example, this makes it possible to have a general calendar which shows all meetups and house parties in the same calendar, and have a separate calendar for rallies which only contains the rallies content type. Calendars can be customized to view a specific content type or a category of content, using taxonomies.') . '</p>';
      $output .= '<p>' . t('Administrators can also set two types of options for events; general event options, and event overview options.  General event options are for timezone configuration, time notation formats, and event block configuration.  Event overview options allow calendar and table event default views.  Administrators can also set general filter controls for content types and categories, via the event taxonomy controls.') . '</p>';
      $output .= t('<p>You can</p>
<ul>
<li>enable content types to be event enabled at <a href="!admin-node-configure-types" title="content type configuration">administer &gt;&gt; content &gt;&gt; content types </a> then click configure for a content type.</li>
<li>administer general event options <a href="!admin-settings-event" title="administer events">administer &gt;&gt; settings &gt;&gt; events</a>.</li>
<li><a href="!node-add" title="list of content types that can be created">create content</a> and set a start and end time, if the administrator has set that content type to be event enabled.</li>
<li>use <a href="!external-http-drupal-org-handbook-modules-rsvp">RSVP</a> or <a href="!external-http-drupal-org-handbook-modules-signup">signup</a> module to invite users to events.</li>
', array(
        '!admin-node-configure-types' => url('admin/content/types'),
        '!admin-settings-event' => url('admin/event/event'),
        '!node-add' => url('node/add'),
        '!external-http-drupal-org-handbook-modules-signup' => 'http://drupal.org/project/signup',
        '!external-http-drupal-org-handbook-modules-rsvp' => 'http://drupal.org/project/rsvp',
      )) . '</ul>';
      $output .= '<p>' . t('For more information please read the configuration and customization handbook <a href="!event">Event page</a>.', array(
        '!event' => 'http://www.drupal.org/handbook/modules/event/',
      )) . '</p>';
      return $output;
    case 'event/dst':
      return t('This is a listing of all the event system\'s time zones, sorted by daylight savings time regions, and their respective offsets from GMT in seconds. Time zones in the \'None\' region do not observe daylight savings time. If you believe there is an error, please first search for the locale on !timeanddate and confirm it. If there is indeed an error please submit a !bugreport on drupal.org so we can fix it.', array(
        '!timeanddate' => l('http://timeanddate.com/worldclock/search.html', 'http://timeanddate.com/worldclock/search.html'),
        '!bugreport' => l('bug report', 'http://drupal.org/node/add/project-issue/event'),
      ));
  }
}