1 |
86fa8ee5
|
Assos Assos
|
<p>The <strong>Advanced Help</strong> module provides a framework that
|
2 |
d51f9c7d
|
Assos Assos
|
allows help texts to be viewed as integrated into a Drupal
|
3 |
|
|
website.</p>
|
4 |
|
|
|
5 |
|
|
<p>These help texts are stored in ordinary <code>.html</code>-files
|
6 |
|
|
that lives in the file system (as opposed to the database). These
|
7 |
|
|
files are distributed from the project Drupal.org repo in the same
|
8 |
|
|
package as the module or theme, and placed in a subdirectory named
|
9 |
|
|
<code>help</code> in the project or theme directory.</p>
|
10 |
|
|
|
11 |
|
|
<p>The help texts can be placed in an hierarchical book, allowing for
|
12 |
|
|
top-down navigation, or programmatically placed in popups that can be
|
13 |
|
|
added to a page with plain text links or themed icon links.</p>
|
14 |
|
|
|
15 |
|
|
<p>If there is a <code>README.md</code> or <code>README.txt</code> in
|
16 |
|
|
the package, the content of that file may be shown as well.</p>
|
17 |
|
|
|
18 |
|
|
<p>Cross-linking book-sections,using fragment identifiers, works as
|
19 |
|
|
one would expect.</p>
|
20 |
|
|
|
21 |
|
|
<p>The help texts may be made searchable, but are not so by default (see
|
22 |
|
|
“<a href="&topic:advanced_help/using-advanced-help#search&">Using advanced help</a>”
|
23 |
|
|
for details). If search is enabled, all help texts are fully
|
24 |
|
|
indexed. This means that the entire contents of the advanced help set
|
25 |
|
|
of pages can be searched for keywords.</p>
|
26 |
|
|
|
27 |
|
|
<p>Modules and themes can even insert help texts into another
|
28 |
|
|
project's hierarchy.</p>
|
29 |
|
|
|
30 |
|
|
<p>May be integrated into <code>hook_help()</code> using companion
|
31 |
|
|
module
|
32 |
86fa8ee5
|
Assos Assos
|
<a href="https://www.drupal.org/project/advanced_help_hint"><strong>Advanced Help Hint</strong></a>.</p>
|
33 |
d51f9c7d
|
Assos Assos
|
|
34 |
|
|
<h2 id="demo">Demonstration</h2>
|
35 |
|
|
|
36 |
|
|
<p>The project comes with a small demo module named
|
37 |
86fa8ee5
|
Assos Assos
|
<strong>Advanced Help Example</strong> to demonstrate how it works.
|
38 |
d51f9c7d
|
Assos Assos
|
This example also shows how to make use of some of the css classes
|
39 |
|
|
provided.</p>
|
40 |
|
|
|
41 |
|
|
<p>For an example of a project that makes extensive use of the
|
42 |
|
|
advanced help features, see the <strong>Views</strong> project.</p>
|
43 |
|
|
|
44 |
|
|
<p>For an example of translation of help text, see the
|
45 |
|
|
directory <code>translations/help/nb</code> in the <strong>Advanced
|
46 |
86fa8ee5
|
Assos Assos
|
Help Example</strong> submodule. For translation instructions, see the
|
47 |
d51f9c7d
|
Assos Assos
|
section named “<a href="&topic:advanced_help/translation&">Translating
|
48 |
|
|
advanced help</a>”.</p>
|
49 |
|
|
|
50 |
|
|
<h2 id="theme">Theme</h2>
|
51 |
|
|
|
52 |
86fa8ee5
|
Assos Assos
|
<p>The <strong>Advanced Help</strong> and
|
53 |
|
|
<strong>Advanced Help Example</strong> modules implements
|
54 |
d51f9c7d
|
Assos Assos
|
<code>hook_admin_paths_alter()</code> to render the help
|
55 |
|
|
texts rendered using the site's administrative theme.
|
56 |
|
|
The <code>help.css</code> provided is created with the
|
57 |
|
|
theme <strong>Seven</strong> in mind. Using a different
|
58 |
|
|
administrative theme may require you to create custom css for the
|
59 |
|
|
site.</p>
|
60 |
|
|
|
61 |
|
|
<p>The contributed module
|
62 |
|
|
<a href="https://www.drupal.org/project/admin_path"><strong>Administrative pages</strong></a>
|
63 |
|
|
seems to override <code>hook_admin_paths_alter()</code>. If you use this module,
|
64 |
|
|
you also need to navigate to
|
65 |
|
|
<span class="nav">Configuration » User interface » Administrative pages</span>
|
66 |
|
|
and declare these paths as administrative pages:</p>
|
67 |
|
|
|
68 |
|
|
<pre>
|
69 |
|
|
help/advanced_help/*
|
70 |
|
|
help/help_example/*
|
71 |
|
|
</pre>
|
72 |
|
|
|
73 |
|
|
<p>You may attach your own custom css to any project that
|
74 |
86fa8ee5
|
Assos Assos
|
uses <strong>Advanced Help</strong> to provide help.</p>
|
75 |
d51f9c7d
|
Assos Assos
|
|