root / htmltest / modules / help / help.api.php @ 85ad3d82
1 | 85ad3d82 | Assos Assos | <?php
|
---|---|---|---|
2 | |||
3 | /**
|
||
4 | * @file
|
||
5 | * Hooks provided by the Help module.
|
||
6 | */
|
||
7 | |||
8 | /**
|
||
9 | * @addtogroup hooks
|
||
10 | * @{
|
||
11 | */
|
||
12 | |||
13 | /**
|
||
14 | * Provide online user help.
|
||
15 | *
|
||
16 | * By implementing hook_help(), a module can make documentation available to
|
||
17 | * the user for the module as a whole, or for specific paths. Help for
|
||
18 | * developers should usually be provided via function header comments in the
|
||
19 | * code, or in special API example files.
|
||
20 | *
|
||
21 | * For a detailed usage example, see page_example.module.
|
||
22 | *
|
||
23 | * @param $path
|
||
24 | * The router menu path, as defined in hook_menu(), for the help that is
|
||
25 | * being requested; e.g., 'admin/people' or 'user/register'. If the router
|
||
26 | * path includes a wildcard, then this will appear in $path as %, even if it
|
||
27 | * is a named %autoloader wildcard in the hook_menu() implementation; for
|
||
28 | * example, node pages would have $path equal to 'node/%' or 'node/%/view'.
|
||
29 | * To provide a help page for a whole module with a listing on admin/help,
|
||
30 | * your hook implementation should match a path with a special descriptor
|
||
31 | * after a "#" sign:
|
||
32 | * 'admin/help#modulename'
|
||
33 | * The main module help text, displayed on the admin/help/modulename
|
||
34 | * page and linked to from the admin/help page.
|
||
35 | * @param $arg
|
||
36 | * An array that corresponds to the return value of the arg() function, for
|
||
37 | * modules that want to provide help that is specific to certain values
|
||
38 | * of wildcards in $path. For example, you could provide help for the path
|
||
39 | * 'user/1' by looking for the path 'user/%' and $arg[1] == '1'. This given
|
||
40 | * array should always be used rather than directly invoking arg(), because
|
||
41 | * your hook implementation may be called for other purposes besides building
|
||
42 | * the current page's help. Note that depending on which module is invoking
|
||
43 | * hook_help, $arg may contain only empty strings. Regardless, $arg[0] to
|
||
44 | * $arg[11] will always be set.
|
||
45 | *
|
||
46 | * @return
|
||
47 | * A localized string containing the help text.
|
||
48 | */
|
||
49 | function hook_help($path, $arg) { |
||
50 | switch ($path) { |
||
51 | // Main module help for the block module
|
||
52 | case 'admin/help#block': |
||
53 | return '<p>' . t('Blocks are boxes of content rendered into an area, or region, of a web page. The default theme Bartik, for example, implements the regions "Sidebar first", "Sidebar second", "Featured", "Content", "Header", "Footer", etc., and a block may appear in any one of these areas. The <a href="@blocks">blocks administration page</a> provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions.', array('@blocks' => url('admin/structure/block'))) . '</p>'; |
||
54 | |||
55 | // Help for another path in the block module
|
||
56 | case 'admin/structure/block': |
||
57 | return '<p>' . t('This page provides a drag-and-drop interface for assigning a block to a region, and for controlling the order of blocks within regions. Since not all themes implement the same regions, or display regions in the same way, blocks are positioned on a per-theme basis. Remember that your changes will not be saved until you click the <em>Save blocks</em> button at the bottom of the page.') . '</p>'; |
||
58 | } |
||
59 | } |
||
60 | |||
61 | /**
|
||
62 | * @} End of "addtogroup hooks".
|
||
63 | */ |