Projet

Général

Profil

Paste
Télécharger (4,31 ko) Statistiques
| Branche: | Révision:

root / drupal7 / sites / all / modules / advanced_help / help / readme.html @ 00c2605a

1
<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
<p>The help texts can be marked up with standard HTML, but are
16
rendered within your site's Drupal theming structure.</p>
17

    
18
<p>If the module or theme author does not make use of the full
19
<em>Advanced help</em> framework, but if there is a
20
<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
<p>The help texts may appear in a popup or not as the module prefers.
24
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
<p>The hierarchy is tied into Drupal's search system. If this is
31
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
<p>By itself, this module doesn't do much.  The <strong>Advanced
38
help</strong> assists other modules and themes in showing help texts.
39
Nothing will show up until you enable at least one other module that
40
makes use of the advanced help framework or comes with a file
41
named <code>README.md</code> or <code>README.txt</code>.  However, it
42
comes with a small companion demo module named
43
<strong>Advanced help example</strong> to demonstrate how it works.
44
For more extensive example of use of the advanced help features, see
45
the <strong>Views</strong> project.</p>
46

    
47
<h2 id="project-recommended">Recommended modules</h2>
48

    
49
<ul>
50
<!--
51
<li><a href="https://www.drupal.org/project/markdown">Markdown filter</a>:<br>
52
When this module is enabled, display of any <code>README.md</code> the
53
module shows will be rendered with markdown.</li>
54
-->
55
<li><a href="https://www.drupal.org/project/attributions">Attributions</a>:<br>
56
When this module is enabled, attributions of third party content used
57
by the project (i.e. some text from Wikipedia) will be available in an
58
attribution block and on an atribution page.</li>
59
</ul>
60

    
61
<h2 id="support-status">Support status</h2>
62

    
63
<p>Reported bugs for the Drupal 7 branch will be fixed in a timely
64
manner.  Bugs in the issue queue for the Drupal 6 branch will only be
65
fixed if accompanied with a patch, after the patch has been reviewed
66
and tested by the community.  No Drupal 8 version is currently under
67
development.  Post a message in
68
the <a href="https://www.drupal.org/node/1928218">issue queue</a> if
69
you're interested in managing a port of the project to to Drupal
70
8. Older versions are no longer supported.</p>
71

    
72
<p>Community support in the form of patches are very welcome for both
73
Drupal 6 and Drupal 7 versions, and will be given priority. For QA,
74
the project needs community support in the form of reviews of patches,
75
development versions and releases.</p>
76

    
77
<p>The primary goal of the module is to remain <strong>light-weight
78
and simple</strong>.  This means that not all feature requests will be
79
implemented, even if they are a good idea.  Feature requests
80
accompanied by patches are more likely to make it into a release.</p>
81

    
82
<p>The maintainer hopes that the community is willing to help out by
83
answering &amp; closing support requests.</p>
84

    
85
<!--
86
<h2 id="project-problems">Known problems</h2>
87
-->
88

    
89

    
90

    
91
<h2 id="project-maintainers">Credits</h2>
92

    
93
<ul>
94
<li><a href="https://www.drupal.org/u/merlinofchaos"">merlinofchaos</a> (52 commits, original creator)</li>
95
<li><a href="https://www.drupal.org/u/redndahead">redndahead</a> (8 commits)</li>
96
<li><a href="https://www.drupal.org/u/dmitrig01">dmitrig01</a> (3 commits)</li>
97
<li><a href="https://www.drupal.org/u/amitgoyal">amitgoyal </a> (5 commits)</li>
98
<li><a href="https://www.drupal.org/u/gisle">gisle</a> (current maintainer)</li>
99
</ul>