summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJennifer Hodgdon2014-02-13 16:07:59 (GMT)
committerJennifer Hodgdon2014-02-13 16:07:59 (GMT)
commit1f77ad5ac4aa0f98f50162c378550156bfd78705 (patch)
tree83e4ed5e2e44a87a8b8abe120cebcab119fca65a
parent552cdd261a1114fb77391d4fb587632a3ae0a4ba (diff)
Issue #2035145 by batigolix, larowlan, nick_schuch, -enzo-, clemens.tolboom, drupalninja99, Nitesh Sethia: Add hook_help to Tour module
-rw-r--r--core/modules/tour/tour.module20
1 files changed, 20 insertions, 0 deletions
diff --git a/core/modules/tour/tour.module b/core/modules/tour/tour.module
index 16fe5f0..9991c0c 100644
--- a/core/modules/tour/tour.module
+++ b/core/modules/tour/tour.module
@@ -8,6 +8,26 @@ use Drupal\Core\Cache\CacheBackendInterface;
use Symfony\Cmf\Component\Routing\RouteObjectInterface;
/**
+ * Implements hook_help().
+ */
+function tour_help($path, $arg) {
+ switch ($path) {
+ case 'admin/help#tour':
+ $output = '';
+ $output .= '<h3>' . t('About') . '</h3>';
+ $output .= '<p>' . t("The Tour module provides users with guided tours of the site interface. Each tour consists of several tips that highlight elements of the user interface, guide the user through a workflow, or explain key concepts of the website. For more information, see <a href='!tour'>the online documentation for the Tour module</a>.", array('!tour' => 'https://drupal.org/documentation/modules/tour')) . '</p>';
+ $output .= '<h3>' . t('Uses') . '</h3>';
+ $output .= '<dl>';
+ $output .= '<dt>' . t('Viewing tours') . '</dt>';
+ $output .= '<dd>' . t("If a tour is available on a page, a <em>Tour</em> button will be visible in the toolbar. If you click this button the first tip of the tour will appear. The tour continues after clicking the <em>Next</em> button in the tip. To see a tour users must have the permission <em>Access tour</em> and JavaScript must be enabled in the browser") . '</dd>';
+ $output .= '<dt>' . t('Creating tours') . '</dt>';
+ $output .= '<dd>' . t("Tours can be written as YAML-documents with a text editor, or using the contributed <a href='!tour_ui'>Tour UI</a> module. For more information, see <a href='!doc_url'>the online documentation for writing tours</a>.", array('!doc_url' => 'https://drupal.org/developing/api/tour', '!tour_ui' => 'https://drupal.org/project/tour_ui')) . '</dd>';
+ $output .= '</dl>';
+ return $output;
+ }
+}
+
+/**
* Implements hook_permission().
*/
function tour_permission() {