function ctools_plugin_example_explanation_page in Chaos Tool Suite (ctools) 7

Same name and namespace in other branches

1. 6 ctools_plugin_example/ctools_plugin_example.module \ctools_plugin_example_explanation_page()

Just provide an explanation page for the admin section.

Return value

unknown_type

1 string reference to 'ctools_plugin_example_explanation_page'

ctools_plugin_example_menu in ctools_plugin_example/ctools_plugin_example.module

Implements hook_menu.

File

ctools_plugin_example/ctools_plugin_example.module, line 77

Working sample module to demonstrate CTools 3 plugins.

Code

function ctools_plugin_example_explanation_page() {
  $content = '<p>' . t("The CTools Plugin Example is simply a developer's demo of how to create plugins for CTools. It provides no useful functionality for an ordinary user.") . '</p>';
  $content .= '<p>' . t('There is a demo panel demonstrating much of the functionality provided at
    <a href="@demo_url">CTools demo panel</a>, and you can find documentation on the examples at
    !ctools_plugin_example_help.
    CTools itself provides documentation at !ctools_help. Mostly, though, the code itself is intended to be the teacher.
    You can find it in %path.', array(
    '@demo_url' => url('ctools_plugin_example/xxxxx'),
    '!ctools_plugin_example_help' => theme('advanced_help_topic', array(
      'module' => 'ctools_plugin_example',
      'topic' => 'Chaos-Tools--CTools--Plugin-Examples',
      'type' => 'title',
    )),
    '!ctools_help' => theme('advanced_help_topic', array(
      'module' => 'ctools',
      'topic' => 'plugins',
      'type' => 'title',
    )),
    '%path' => drupal_get_path('module', 'ctools_plugin_example'),
  )) . '</p>';
  return $content;
}