directory <code>translations/help/<em>language</em></code> in the
module directory. Then, copy the .ini file and all the .html files
from the help directory into this. If you need to alter an image to
use it in a translation, you also put the altered image there.</p>
<p>To translate a help-file indexed by <strong>Advanced help</strong>,
first create a directory
<code>translations/help/<em>language</em></code> in the project's
root directory. The <em>language</em> is the language code that
appears on the <em>Languages</em> page in the administrative UI.</p>
<p>The .ini file only needs to keep the titles, and if there is
<p>Then, copy the <code>.ini</code> file and all
the <code>.html</code> files from the help directory into this. If
you need to alter an image to use it in a translation, you may also
put the altered image there.</p>
<p>In the topics section, the <code>.ini</code> file only needs to
keep the topic names (unaltered) and titles (translated). If there is
a <code>name</code> or <code>index name</code> setting in the
'advanced help settings' portion, that should be retained. Any
retained settings should be translated. The rest of the data in the
.ini file may be discarded or ignored.</p>
<code>.ini</code> file may be discarded or ignored.</p>
<p>Each <code>.html</code> file should then be translated in place.</p>
<p>When translating a <code>.html</code> file, you will find that
the <code>&path&</code> keyword (used for images and links)
will lead to the original directory. If you must translate items that
are linked, such as images containing text,
use <code>&trans_path&</code> instead, which will lead to the
translated directory. This will allow you to pick and choose which
linked items, if any, will be translated.</p>
<p>If a topic is not tranlated, the default (untranslated) version
will be shown instead.</p>
<h2>Translating Advanced help's help files</h2>
<p>Each file should then be translated in place.</p>
<p>If you want to help with the translation of
<strong>Advanced help</strong> help texts for a particular language, look for an issue named named “Translation to XXX” (where
“XXX” is the language you want to translate the help texts to) in the <ahref="https://www.drupal.org/project/issues/advanced_help">issue queue for Advanced help</a>.
If such an issue does not exist, please can create it.
Choose <em>Category</em> “Task”,
<em>Status</em> “Needs review” and
<em>Component</em> “Documentation”.
Upload translated files as an attachment (change the file type from <code>.html</code> to <code>.txt</code> to be allowed to upload). </p>
<p>When translating a .html file, you will find that
the <code>&path&</code> keyword will lead to the original
directory. If you must translate items that are linked, such as images
containing text, use <code>&trans_path&</code> instead, which
will lead to the translated directory. This will allow you to pick and
choose which linked items, if any, will be translated.</p>
<p>Uploaded translations will be included in the next version if
reviewed and approved by other users (i.e. gets to status “RTBC”).</p>
<p>The latter is to refer to a translated version of the image if it differs from the original.</p>
<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>
<p>To reference any normal path in the site, use:</p>
<pre>
...
...
@@ -102,8 +102,8 @@ wish to embed within the help text, use:</p>
<p><strong>NOTE: </strong> In previous versions <strong>Advanced
help</strong> did not require the &'s to be wrapped around
<code>topic:</code>, <code>path</code>, and <code>base_url</code>.
This is currently still supported, but may be removed in a future
<code>topic</code>, <code>path</code>, and <code>base_url</code>.
This is currently still supported, but will be removed in a future
version. By adding the &'s these tokens are now not limited
to <code>href=""</code> and <code>src=""</code> parameters.</p>
...
...
@@ -130,9 +130,9 @@ Deny from all
</Files>
</pre>
<p>It as the responsibility of the project author to make sure this
type of protection is in place if the project's author has help files
that merits protection from direct access.</p>
<p>It as the responsibility of the site manager to make sure this type
of protection is in place if the site has help files that merits
protection from direct access.</p>
<p>See also this tracker in the project's issue queue:
<ahref="https://www.drupal.org/node/1980936">#1980936 Typing complete path to .html help files in module bypasses user permissions</a>.</p>
...
...
@@ -142,8 +142,8 @@ that merits protection from direct access.</p>
<p>To enable advanced help search, navigate to
<em>Administration → Configuration → Search and metadata → Search settings</em>.
Scroll down to <em>Active search modules</em> and tick the box to the
left of “Advanced help”. The search form will appear on the uop of
the advanced help admin page.</p>
left of “Advanced help”. The search form will appear on the top of
the advanced help index pages.</p>
<p>If the core <strong>Search</strong> module is enabled, the contents
of the advanced help framework will be indexed on cron. If you enable
<ahref="http://en.wikipedia.org/wiki/Image:Lerdorf.jpg"class="image"title="Rasmus Lerdorf, who wrote the original Common Gateway Interface binaries"><imgalt="Rasmus Lerdorf, who wrote the original Common Gateway Interface binaries"src="path:180px-Lerdorf.jpg"width="180"height="270"border="0"/></a>
<ahref="http://en.wikipedia.org/wiki/Image:Lerdorf.jpg"class="image"title="Rasmus Lerdorf, who wrote the original Common Gateway Interface binaries"><imgalt="Rasmus Lerdorf, who wrote the original Common Gateway Interface binaries"src="&path&180px-Lerdorf.jpg"width="180"height="270"border="0"/></a>
<div><ahref="http://en.wikipedia.org/wiki/Rasmus_Lerdorf"title="Rasmus Lerdorf">Rasmus Lerdorf</a>, who wrote the original <ahref="http://en.wikipedia.org/wiki/Common_Gateway_Interface"title="Common Gateway Interface">Common Gateway Interface</a> binaries.</div>
</div>
<p>PHP, standing for Personal Home Page, began as a set of <ahref="http://en.wikipedia.org/wiki/Common_Gateway_Interface"title="Common Gateway Interface">Common Gateway Interface</a><ahref="http://en.wikipedia.org/wiki/Binary_file"title="Binary file">binaries</a> written in the <ahref="http://en.wikipedia.org/wiki/C_programming_language"class="mw-redirect"title="C programming language">C programming language</a> in 1994 by the <ahref="http://en.wikipedia.org/wiki/Danish_people"title="Danish people">Danish</a>/<ahref="http://en.wikipedia.org/wiki/Greenland"title="Greenland">Greenlandic</a> programmer <ahref="http://en.wikipedia.org/wiki/Rasmus_Lerdorf"title="Rasmus Lerdorf">Rasmus Lerdorf</a>. Lerdorf initially created these Personal Home Page Tools to replace a small set of <ahref="http://en.wikipedia.org/wiki/Perl"title="Perl">Perl</a> scripts he had been using to maintain his <ahref="http://en.wikipedia.org/wiki/Personal_homepage"class="mw-redirect"title="Personal homepage">personal homepage</a>. The tools were originally created to perform tasks such as displaying his <ahref="http://en.wikipedia.org/wiki/R%C3%A9sum%C3%A9"title="Résumé">résumé</a> and recording how much <ahref="http://en.wikipedia.org/wiki/Web_traffic"title="Web traffic">traffic</a> his page was receiving. He combined these binaries with his Form Interpreter to create PHP/FI, which had more functionality. It included a larger <ahref="http://en.wikipedia.org/wiki/C_%28programming_language%29"title="C (programming language)">C implementation</a> which could communicate with <ahref="http://en.wikipedia.org/wiki/Database"title="Database">databases</a> and helped build simple, dynamic <ahref="http://en.wikipedia.org/wiki/Web_application"title="Web application">web applications</a>. He released PHP publicly on <ahref="http://en.wikipedia.org/wiki/June_8"title="June 8">June 8</a>, <ahref="http://en.wikipedia.org/wiki/1995"title="1995">1995</a> to speed up the finding of <ahref="http://en.wikipedia.org/wiki/Software_bug"title="Software bug">bugs</a> and improving the code. This release was named PHP version 2, and already had basic functionality that PHP has today. This includes Perl-like variables, form handling, and the ability to embed HTML. The syntax was similar to Perl but was more limited, simpler, and less consistent.</p>
<divclass="help-box help-right">
<ahref="http://en.wikipedia.org/wiki/Image:Andi_Gutmans_1.jpg"class="image"title="Andi Gutmans, who, along with Zeev Suraski, rewrote the parser that formed PHP 3"><imgalt="Andi Gutmans, who, along with Zeev Suraski, rewrote the parser that formed PHP 3"src="path:180px-Andi_Gutmans_1.jpg"width="180"height="244"border="0"class="thumbimage"/></a>
<ahref="http://en.wikipedia.org/wiki/Image:Andi_Gutmans_1.jpg"class="image"title="Andi Gutmans, who, along with Zeev Suraski, rewrote the parser that formed PHP 3"><imgalt="Andi Gutmans, who, along with Zeev Suraski, rewrote the parser that formed PHP 3"src="&path&180px-Andi_Gutmans_1.jpg"width="180"height="244"border="0"class="thumbimage"/></a>
<divclass="help-leftalign"><ahref="http://en.wikipedia.org/wiki/Andi_Gutmans"title="Andi Gutmans">Andi Gutmans</a>, who, along with <ahref="http://en.wikipedia.org/wiki/Zeev_Suraski"title="Zeev Suraski">Zeev Suraski</a>, rewrote the <ahref="http://en.wikipedia.org/wiki/Parsing#Parser"title="Parser">parser</a> that formed PHP 3.</div>
The <strong>Advanced help</strong> framework was designed to replace the original Drupal help system, which has several flaws that make it hard to create new help, hard to maintain existing help, and particularly hard to access help.
The primary goal, then, is to increase the accessibility of help, meaning the ability of both the user and the help text author to access the needed tools to use, create, maintain and translate the help.
This system is completely separate from Drupal's <code>hook_help()</code>. In Drupal 6 and 7, it actually co-exists with it; in the future, it is hoped that it will completely replace it allowing <code>hook_help()</code> to be deprecated and removed.
Messages added to the top of a page are not really “help”. Often these messages are an introduction to a form or a short blurb telling a user what to do with a particular page. The problem is, these messages are always there, they are easily ignored, and they come before the actual page. In general, when users are learning, they want to see the page first, then ask questions. The reverse order is much less conducive to actually teaching a user how to use something. By allowing help to be available on request, the system conforms more naturally to how most people work.
<h2>Advanced help er organisert etter emner</h2>
With the <code>hook_help()</code> method, help text is organized by URL path. This is fine if you have help text describing how to use a particular page or what a particular page does, but ultimately is limiting because manuals and documentation are usually grouped by topic, and those topics are determined by the material itself.
<strong>Advanced help</strong> allows the documentation author to organize topics as he or she sees fit; the only restriction, really, is that each individual chunk of text needs to stand on its own as a discrete topic.
