1 |
00c2605a
|
Assos Assos
|
<h2 id="project-description">Synopsis</h2>
|
2 |
|
|
|
3 |
|
|
<p>The <strong>Advanced help</strong> module provides a framework that allows
|
4 |
|
|
module and theme developers integrate help texts in a Drupal site.</p>
|
5 |
|
|
|
6 |
|
|
<p>These help texts are stored in ordinary <code>.html</code>-files
|
7 |
|
|
that lives in the file system (as opposed to the database). These
|
8 |
|
|
files are distributed from the project Drupal.org repo in the same
|
9 |
|
|
package as the module or theme, and placed in a subdirectory named
|
10 |
|
|
<code>help</code> in the project or theme directory. This means that
|
11 |
|
|
the help texts can be easiely kept in sync with the project they
|
12 |
|
|
provide help texts for, but also that read access to these files
|
13 |
|
|
are not managed by any content access restrictions imposed by Drupal.</p>
|
14 |
|
|
|
15 |
6e9292aa
|
Assos Assos
|
<p>The help texts can be marked up with standard HTML. They will be
|
16 |
|
|
rendered using your site's theme.</p>
|
17 |
00c2605a
|
Assos Assos
|
|
18 |
6e9292aa
|
Assos Assos
|
<p>If the module or theme author does not make use of the
|
19 |
|
|
<em>Advanced help</em> HTML-framework, but if there is a
|
20 |
00c2605a
|
Assos Assos
|
<code>README.md</code> or <code>README.txt</code> in the package,
|
21 |
|
|
the content of that file will be shown instead.</p>
|
22 |
|
|
|
23 |
6e9292aa
|
Assos Assos
|
<p>The help texts may appear in a popup or not as the project prefers.
|
24 |
00c2605a
|
Assos Assos
|
By taking away access to view the popups, a site can hide popups from
|
25 |
|
|
users.</p>
|
26 |
|
|
|
27 |
|
|
<p>The help texts can be placed in a hierarchy, allowing for top down
|
28 |
|
|
navigation of help.</p>
|
29 |
|
|
|
30 |
6e9292aa
|
Assos Assos
|
<p>The help texts may be made searchable. If advanced help search is
|
31 |
00c2605a
|
Assos Assos
|
enabled, all help texts are fully indexed. This means that the entire
|
32 |
|
|
contents of the advanced help set of pages can be searched for
|
33 |
|
|
keywords.</p>
|
34 |
|
|
|
35 |
|
|
<h2 id="use">Using the module</h2>
|
36 |
|
|
|
37 |
6e9292aa
|
Assos Assos
|
<p>When you enable the module, a new tab with the legend “Advanced
|
38 |
|
|
help” will show up under “Help”:
|
39 |
|
|
|
40 |
|
|
<div class="ta-center">
|
41 |
|
|
<img class="help-img-center" alt="ahelp_tab.png" src="&path&ahelp_tab.png" width="661" height="225" border="1" />
|
42 |
|
|
</div>
|
43 |
|
|
|
44 |
00c2605a
|
Assos Assos
|
<p>By itself, this module doesn't do much. The <strong>Advanced
|
45 |
|
|
help</strong> assists other modules and themes in showing help texts.
|
46 |
|
|
Nothing will show up until you enable at least one other module that
|
47 |
|
|
makes use of the advanced help framework or comes with a file
|
48 |
|
|
named <code>README.md</code> or <code>README.txt</code>. However, it
|
49 |
|
|
comes with a small companion demo module named
|
50 |
|
|
<strong>Advanced help example</strong> to demonstrate how it works.
|
51 |
|
|
For more extensive example of use of the advanced help features, see
|
52 |
|
|
the <strong>Views</strong> project.</p>
|
53 |
|
|
|
54 |
6e9292aa
|
Assos Assos
|
|
55 |
00c2605a
|
Assos Assos
|
|
56 |
|
|
|
57 |
|
|
|
58 |
|
|
|
59 |
|
|
|
60 |
|
|
|
61 |
|
|
|
62 |
|
|
|
63 |
|
|
|
64 |
|
|
|
65 |
|
|
|
66 |
6e9292aa
|
Assos Assos
|
|
67 |
00c2605a
|
Assos Assos
|
|
68 |
|
|
<h2 id="support-status">Support status</h2>
|
69 |
|
|
|
70 |
|
|
<p>Reported bugs for the Drupal 7 branch will be fixed in a timely
|
71 |
|
|
manner. Bugs in the issue queue for the Drupal 6 branch will only be
|
72 |
|
|
fixed if accompanied with a patch, after the patch has been reviewed
|
73 |
|
|
and tested by the community. No Drupal 8 version is currently under
|
74 |
|
|
development. Post a message in
|
75 |
|
|
the <a href="https://www.drupal.org/node/1928218">issue queue</a> if
|
76 |
|
|
you're interested in managing a port of the project to to Drupal
|
77 |
|
|
8. Older versions are no longer supported.</p>
|
78 |
|
|
|
79 |
|
|
<p>Community support in the form of patches are very welcome for both
|
80 |
|
|
Drupal 6 and Drupal 7 versions, and will be given priority. For QA,
|
81 |
|
|
the project needs community support in the form of reviews of patches,
|
82 |
|
|
development versions and releases.</p>
|
83 |
|
|
|
84 |
|
|
<p>The primary goal of the module is to remain <strong>light-weight
|
85 |
|
|
and simple</strong>. This means that not all feature requests will be
|
86 |
|
|
implemented, even if they are a good idea. Feature requests
|
87 |
|
|
accompanied by patches are more likely to make it into a release.</p>
|
88 |
|
|
|
89 |
|
|
<p>The maintainer hopes that the community is willing to help out by
|
90 |
|
|
answering & closing support requests.</p>
|
91 |
|
|
|
92 |
|
|
|
93 |
|
|
|
94 |
|
|
|
95 |
|
|
|
96 |
|
|
|
97 |
|
|
|
98 |
|
|
<h2 id="project-maintainers">Credits</h2>
|
99 |
|
|
|
100 |
|
|
<ul>
|
101 |
|
|
<li><a href="https://www.drupal.org/u/merlinofchaos"">merlinofchaos</a> (52 commits, original creator)</li>
|
102 |
|
|
<li><a href="https://www.drupal.org/u/redndahead">redndahead</a> (8 commits)</li>
|
103 |
|
|
<li><a href="https://www.drupal.org/u/dmitrig01">dmitrig01</a> (3 commits)</li>
|
104 |
|
|
<li><a href="https://www.drupal.org/u/amitgoyal">amitgoyal </a> (5 commits)</li>
|
105 |
6e9292aa
|
Assos Assos
|
<li><a href="https://www.drupal.org/u/gisle">gisle</a> (current maintainer, D7)</li>
|
106 |
|
|
<li><a href="https://www.drupal.org/u/gnuget">gnuget</a> (current maintainer, D8)</li>
|
107 |
00c2605a
|
Assos Assos
|
</ul> |