summaryrefslogtreecommitdiff
path: root/modules
diff options
context:
space:
mode:
authorDries Buytaert <dries@buytaert.net>2009-12-04 16:02:42 +0000
committerDries Buytaert <dries@buytaert.net>2009-12-04 16:02:42 +0000
commit3e6d6e115fe925debc7f153c8e535199da365e63 (patch)
tree8c869882be3f5a77981dfcaad529b19c28da799f /modules
parente039780f51ec034735d6594c48582319a74ec917 (diff)
downloadbrdo-3e6d6e115fe925debc7f153c8e535199da365e63.tar.gz
brdo-3e6d6e115fe925debc7f153c8e535199da365e63.tar.bz2
- Patch #636822 by jhodgdon, arianek, David_Rothstein, JuliaKM: help improvements for shortcut and toolbar.
Diffstat (limited to 'modules')
-rw-r--r--modules/shortcut/shortcut.module20
-rw-r--r--modules/toolbar/toolbar.info2
-rw-r--r--modules/toolbar/toolbar.module17
3 files changed, 38 insertions, 1 deletions
diff --git a/modules/shortcut/shortcut.module b/modules/shortcut/shortcut.module
index 5f8da1835..02b89296c 100644
--- a/modules/shortcut/shortcut.module
+++ b/modules/shortcut/shortcut.module
@@ -15,6 +15,26 @@
define('SHORTCUT_DEFAULT_SET_NAME', 'shortcut-set-1');
/**
+ * Implements hook_help().
+ */
+function shortcut_help($path, $arg) {
+ switch ($path) {
+ case 'admin/help#shortcut':
+ $output = '<h3>' . t('About') . '</h3>';
+ $output .= '<p>' . t('The Shortcut module allows users to create sets of <em>shortcut</em> links to commonly-visited pages of the site. Shortcuts are contained within <em>sets</em>, and each user with <em>switch shortcut sets</em> permissions can select a preferred set of shortcuts. For more information, see the online handbook entry for <a href="@shortcut">Shortcut module</a>.', array('@shortcut' => 'http://drupal.org/handbook/modules/shortcut/')) . '</p>';
+ $output .= '<h3>' . t('Uses') . '</h3>';
+ $output .= '<dl><dt>' . t('Creating and modifying shortcuts and sets') . '</dt>';
+ $output .= '<dd>' . t('Users with the appropriate permissions can manage shortcut sets, choose a preferred shortcut set, and edit the shortcuts within sets from the <a href="@shortcuts">Shortcuts administration page</a>.', array('@shortcuts' => url('admin/config/system/shortcut'))) . '</dd>';
+ $output .= '<dt>' . t('Adding and removing shortcuts') . '</dt>';
+ $output .= '<dd>' . t('The Shortcut module creates an add/remove link for each page on your site; the link lets you add or remove the current page from the currently-enabled set of shortcuts (if your theme displays it). The core Seven administration theme displays this link next to the page title, as a small + or - sign. If you click on the + sign, you will add that page to your preferred set of shortcuts. If the page is already part of your shortcut set, the link will be a - sign, and will allow you to remove the current page from your shortcut set.') . '</dd>';
+ $output .= '<dt>' . t('Displaying shortcuts') . '</dt>';
+ $output .= '<dd>' . t('You can display your shortcuts by enabling the Shortcuts block on the <a href="@blocks">Blocks administration page</a>. Certain administrative modules also display your shortcuts; for example, the core <a href="@toolbar-help">Toolbar module</a> displays them near the top of the page, along with an <em>edit shortcuts</em> link.', array('@blocks' => url('admin/structure/block'), '@toolbar-help' => url('admin/help/toolbar'))) . '</dd>';
+ $output .= '</dl>';
+ return $output;
+ }
+}
+
+/**
* Implement hook_permission().
*/
function shortcut_permission() {
diff --git a/modules/toolbar/toolbar.info b/modules/toolbar/toolbar.info
index 23b6b477d..92fd7bb45 100644
--- a/modules/toolbar/toolbar.info
+++ b/modules/toolbar/toolbar.info
@@ -1,6 +1,6 @@
; $Id$
name = Toolbar
-description = Toolbar exposing the top level administration menu items.
+description = Provides a toolbar that shows the top-level administration menu items and links from other modules.
core = 7.x
package = Core
version = VERSION
diff --git a/modules/toolbar/toolbar.module b/modules/toolbar/toolbar.module
index f668cb135..3c3667fde 100644
--- a/modules/toolbar/toolbar.module
+++ b/modules/toolbar/toolbar.module
@@ -7,6 +7,23 @@
*/
/**
+ * Implements hook_help().
+ */
+function toolbar_help($path, $arg) {
+ switch ($path) {
+ case 'admin/help#toolbar':
+ $output = '<h3>' . t('About') . '</h3>';
+ $output .= '<p>' . t('The Toolbar module displays links to top-level administration menu items and links from other modules at the top of the screen. For more information, see the online handbook entry for <a href="@toolbar">Toolbar module</a>.', array('@toolbar' => 'http://drupal.org/handbook/modules/toolbar/')) . '</p>';
+ $output .= '<h3>' . t('Uses') . '</h3>';
+ $output .= '<dl>';
+ $output .= '<dt>' . t('Displaying administrative links') . '</dt>';
+ $output .= '<dd>' . t('The Toolbar module displays a bar containing top-level administrative links across the top of the screen. Below that, the Toolbar module has a <em>drawer</em> section where it displays links provided by other modules, such as the core <a href="@shortcuts-help">Shortcut</a> module. The drawer can be hidden/shown by using the close/open drawer link at the end of the toolbar.', array('@shortcuts-help' => url('admin/help/shortcut'))) . '</dd>';
+ $output .= '</dl>';
+ return $output;
+ }
+}
+
+/**
* Implementation of hook_permission().
*/
function toolbar_permission() {