Project

General

Profile

Revision 6e9292aa

Added by Assos Assos over 9 years ago

Weekly update of contrib modules

View differences:

drupal7/sites/all/modules/advanced_help/help/using-advanced-help.html
1 1 
<p>The <strong>Advanced help</strong> module provides a framework that
2 2 
allows module and theme developers integrate help texts in a Drupal
3 
site.  Although the advanced help does not provide general help by
4 
itself, it provides a powerful and easy framework that modules and
5 
themes may use to provide their own help.</p>
3 
site.  Although the <strong>Advanced help</strong> does not provide
4 
general help by itself, it provides a powerful and easy framework that
5 
modules and themes may use to provide their own help.</p>
6 6 

  		




  7
  7
  
    
<p>Modules and themes utilizing <strong>Advanced help</strong> should


  		




  8
  8
  
    
create a subdirectory named <code>help</code> inside their own main


  		




  ......




  33
  33
  
    
parent = usage


  		




  34
  34
  
    
</pre>


  		




  35
  35
  
    

  		




  36
  
  
    
<p>This file defines five help topics (inside the square brackets, and


  		




  
  36
  
    
<p>This file defines five help topics (inside the square brackets), and


  		




  37
  37
  
    
some settings for them.


  		




  38
  38
  
    
See: <a href="&topic:advanced_help/ini-file&">Advanced help .ini file format</a> for


  		




  39
  39
  
    
a list of defined settings.</p>


  		




  ......




  86
  86
  
    
<p>This format will ensure the popup status remains consistent when


  		




  87
  87
  
    
switching between links.</p>


  		




  88
  88
  
    

  		




  89
  
  
    
<p>To reference items within the help directory, such as images you


  		




  90
  
  
    
wish to embed  within the help text, use:</p>


  		




  
  89
  
    
<p>To reference items within the help directory, such as images you wish to embed  within the help text, use:</p>


  		




  
  90
  
    

  		




  91
  91
  
    
<pre>


  		




  92
  92
  
    
&lt;img src="&amp;path&amp;example.png"/&gt;


  		




  93
  93
  
    
&lt;img src="&amp;trans_path&amp;example.png"/&gt;


  		




  94
  94
  
    
</pre>


  		




  95
  95
  
    

  		




  96
  
  
    
<p>The latter is to refer to a translated version of the image if it differs from the original.</p>


  		




  
  96
  
    
<p>The <code>trans_path</code> keyword refers to a translated version of the image in the translation directory and may be used it differs from the original.</p>


  		




  97
  97
  
    

  		




  98
  98
  
    
<p>To reference any normal path in the site, use:</p>


  		




  99
  99
  
    
<pre>


  		




  ......




  102
  102
  
    

  		




  103
  103
  
    
<p><strong>NOTE: </strong> In previous versions <strong>Advanced


  		




  104
  104
  
    
help</strong> did not require the &amp;'s to be wrapped around


  		




  105
  
  
    
<code>topic:</code>, <code>path</code>, and <code>base_url</code>.


  		




  106
  
  
    
This is currently still supported, but may be removed in a future


  		




  
  105
  
    
<code>topic</code>, <code>path</code>, and <code>base_url</code>.


  		




  
  106
  
    
This is currently still supported, but will be removed in a future


  		




  107
  107
  
    
version.  By adding the &amp;'s these tokens are now not limited


  		




  108
  108
  
    
to <code>href=""</code> and <code>src=""</code> parameters.</p>


  		




  109
  109
  
    

  		




  ......




  130
  130
  
    
&lt;/Files&gt;


  		




  131
  131
  
    
</pre>


  		




  132
  132
  
    

  		




  133
  
  
    
<p>It as the responsibility of the project author to make sure this


  		




  134
  
  
    
type of protection is in place if the project's author has help files


  		




  135
  
  
    
that merits protection from direct access.</p>


  		




  
  133
  
    
<p>It as the responsibility of the site manager to make sure this type


  		




  
  134
  
    
of protection is in place if the site has help files that merits


  		




  
  135
  
    
protection from direct access.</p>


  		




  136
  136
  
    

  		




  137
  137
  
    
<p>See also this tracker in the project's issue queue:  


  		




  138
  138
  
    
<a href="https://www.drupal.org/node/1980936">#1980936 Typing complete path to .html help files in module bypasses user permissions</a>.</p>


  		




  139
  139
  
    

  		




  140
  140
  
    
<h2 id="search">Search</h2>


  		




  141
  141
  
    

  		




  
  142
  
    
<p>To enable advanced help search, navigate to


  		




  
  143
  
    
<em>Administration → Configuration → Search and metadata → Search settings</em>.


  		




  
  144
  
    
Scroll down to <em>Active search modules</em> and tick the box to the


  		




  
  145
  
    
left of “Advanced help”.  The search form will appear on the top of


  		




  
  146
  
    
the advanced help index pages.</p>


  		




  
  147
  
    

  		




  142
  148
  
    
<p>If the core <strong>Search</strong> module is enabled, the contents


  		




  143
  149
  
    
of the advanced help framework will be indexed on cron. If you enable


  		




  144
  150
  
    
new modules or themes and wish to immediately index their help text,


  		




  145
  
  
    
navigate to <em>Administration → Reports → Status report</em> and click the link


  		




  146
  
  
    
“run cron manually”.</p>


  		




  
  151
  
    
navigate to <em>Administration → Reports → Status report</em> and


  		




  
  152
  
    
click the link “run cron manually”.</p>


  		












Also available in:  Unified diff