Commit ba489443 authored by gisle's avatar gisle
Browse files

Issue #1846218 by gisle: Provided an example of a translation directory

parent 088a67a3
<p>To translate advanced help, first create a
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>&amp;path&amp;</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>&amp;trans_path&amp;</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 <a href="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>&amp;path&amp;</code> keyword will lead to the original
directory. If you must translate items that are linked, such as images
containing text, use <code>&amp;trans_path&amp;</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 <strong>Advanced help</strong> module provides a framework that
allows module and theme developers integrate help texts in a Drupal
site. Although the advanced help does not provide general help by
itself, it provides a powerful and easy framework that modules and
themes may use to provide their own help.</p>
site. Although the <strong>Advanced help</strong> does not provide
general help by itself, it provides a powerful and easy framework that
modules and themes may use to provide their own help.</p>
<p>Modules and themes utilizing <strong>Advanced help</strong> should
create a subdirectory named <code>help</code> inside their own main
......@@ -33,7 +33,7 @@ title = PHP syntax
parent = usage
</pre>
<p>This file defines five help topics (inside the square brackets, and
<p>This file defines five help topics (inside the square brackets), and
some settings for them.
See: <a href="&topic:advanced_help/ini-file&">Advanced help .ini file format</a> for
a list of defined settings.</p>
......@@ -86,14 +86,14 @@ $output .= '&nbsp;' . t('Click the help icon!');
<p>This format will ensure the popup status remains consistent when
switching between links.</p>
<p>To reference items within the help directory, such as images you
wish to embed within the help text, use:</p>
<p>To reference items within the help directory, such as images you wish to embed within the help text, use:</p>
<pre>
&lt;img src="&amp;path&amp;example.png"/&gt;
&lt;img src="&amp;trans_path&amp;example.png"/&gt;
</pre>
<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 &amp;'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 &amp;'s these tokens are now not limited
to <code>href=""</code> and <code>src=""</code> parameters.</p>
......@@ -130,9 +130,9 @@ Deny from all
&lt;/Files&gt;
</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:
<a href="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
......
<div class="help-box help-left">
<a href="http://en.wikipedia.org/wiki/Image:Lerdorf.jpg" class="image" title="Rasmus Lerdorf, who wrote the original Common Gateway Interface binaries"><img alt="Rasmus Lerdorf, who wrote the original Common Gateway Interface binaries" src="path:180px-Lerdorf.jpg" width="180" height="270" border="0" /></a>
<a href="http://en.wikipedia.org/wiki/Image:Lerdorf.jpg" class="image" title="Rasmus Lerdorf, who wrote the original Common Gateway Interface binaries"><img alt="Rasmus Lerdorf, who wrote the original Common Gateway Interface binaries" src="&path&180px-Lerdorf.jpg" width="180" height="270" border="0" /></a>
<div><a href="http://en.wikipedia.org/wiki/Rasmus_Lerdorf" title="Rasmus Lerdorf">Rasmus Lerdorf</a>, who wrote the original <a href="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 <a href="http://en.wikipedia.org/wiki/Common_Gateway_Interface" title="Common Gateway Interface">Common Gateway Interface</a> <a href="http://en.wikipedia.org/wiki/Binary_file" title="Binary file">binaries</a> written in the <a href="http://en.wikipedia.org/wiki/C_programming_language" class="mw-redirect" title="C programming language">C programming language</a> in 1994 by the <a href="http://en.wikipedia.org/wiki/Danish_people" title="Danish people">Danish</a>/<a href="http://en.wikipedia.org/wiki/Greenland" title="Greenland">Greenlandic</a> programmer <a href="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 <a href="http://en.wikipedia.org/wiki/Perl" title="Perl">Perl</a> scripts he had been using to maintain his <a href="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 <a href="http://en.wikipedia.org/wiki/R%C3%A9sum%C3%A9" title="Résumé">résumé</a> and recording how much <a href="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 <a href="http://en.wikipedia.org/wiki/C_%28programming_language%29" title="C (programming language)">C implementation</a> which could communicate with <a href="http://en.wikipedia.org/wiki/Database" title="Database">databases</a> and helped build simple, dynamic <a href="http://en.wikipedia.org/wiki/Web_application" title="Web application">web applications</a>. He released PHP publicly on <a href="http://en.wikipedia.org/wiki/June_8" title="June 8">June 8</a>, <a href="http://en.wikipedia.org/wiki/1995" title="1995">1995</a> to speed up the finding of <a href="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>
<div class="help-box help-right">
<a href="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"><img alt="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>
<a href="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"><img alt="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>
<div class="help-leftalign"><a href="http://en.wikipedia.org/wiki/Andi_Gutmans" title="Andi Gutmans">Andi Gutmans</a>, who, along with <a href="http://en.wikipedia.org/wiki/Zeev_Suraski" title="Zeev Suraski">Zeev Suraski</a>, rewrote the <a href="http://en.wikipedia.org/wiki/Parsing#Parser" title="Parser">parser</a> that formed PHP&nbsp;3.</div>
</div>
......
[readme]
title = LESMEG
[using-advanced-help]
title = Bruk av Advanced help
[translation]
title = Oversettelse av Advanced help
[ini-file]
title = Advanced help .ini-filformat
[why-advanced-help]
title = Hvorfor Advanced help?
<p>xxx The advanced help configuration file is in simple .ini file format.
It has an optional section for global settings that might be inherited
for each help file, followed by sections for each help file.</p>
<p>Global settings may be put into a section named <code>[advanced help
settings]</code>. This means that this name is reserved and it cannot
be a help file in any module or theme. The following settings may be
set in this section, with the default value (if any) in brackets.</p>
<dl>
<dt><code>line break</code> (FALSE)</dt>
<dd>If set, the line break filter will be applied to all help files
defined by this module or theme, unless that help file specifically is
set otherwise. The line break converts line breaks
into <code>br</code> and <code>p</code> tags automatically.</dd>
<dt><code>navigation</code> (TRUE)</dt>
<dd>If set, this navigation will be displayed at the end of the topic:
<em>previous topic</em>, Up (parent), <em>next topic</em>.</dd>
<dt><code>css</code></dt>
<dd>Specify a css file that will be used for all help files (unless
overridden), including the .css extension. This .css file must reside
in the help directory along with the .html files, and will not be
affected by translation.</dd>
<dt><code>name</code></dt>
<dd>May be set to override the module or theme name as displayed in
both the module/theme index as well as the navigation and breadcrumb
trail. Usually, this is not set, but for some projects you may want to
use a more friendly name than appears in the project's .info file.</dd>
<dt><code>index name</code></dt>
<dd>This may be set to change the name of the module or theme in the
module/theme index. It overrides the <code>name</code> setting above,
as well as the project's name in its .info file.</dd>
<dt><code>hide</code> (FALSE)</dt>
<dd>This may be used to hide a module or theme in the module/theme
index. This is particularly useful for modules who insert their help
files into the hierarchy of another module or theme, as might be done
by modules that extend <strong>Views</strong> or derived themes that
extend base themes like <strong>Zen</strong>. By setting this to TRUE
the project will not appear as its own entry.</dd>
</dl>
<p>Each section after that will correspond to a single help file for a
single topic. It starts with the topic name in square brackets
(e.g. <code>[ini-file]</code>). The following settings may be set for
each file/topic, with the default value (if any) in brackets.</p>
<dl>
<dt><code>title</code></dt>
<dd>The title of the topic, presented to the user and used in
links. If you have special characters in your title, be sure to
enclose it in quotes. (This setting is currently not optional.)</dd>
<dt><code>file</code> (topic name)</dt>
<dd>The filename, without the .html extension, used for the file with
the help text for the topic. This is optional; if not specified, the
topic name wil be the file name.</dd>
<dt><code>weight</code> (0)</dt>
<dd>The weight, used for sorting topics on the administration
page. The default is 0 (zero) if unspecified. Items with the same weight
are sorted alphabetically.</dd>
<dt><code>parent</code></dt>
<dd>The topic ID to use in a hierarchy; children will be listed
beneath parents in the topic list, and will have the parent in their
breadcrumb trail. You may parent this topic to a topic in another
module or theme by using <code>module%topic</code>
or <code>theme%topic</code> as the identifier,
where <code>module</code> or <code>theme</code> is the project's short
name. For example if parent is set to, '<code>views%display</code>',
the topic will be regarded as a child of the
<code>display</code> topic in the <strong>Views</strong> module.</dd>
<dt><code>line break</code> (FALSE)</dt>
<dd>Set the line break filter for this topic. Set to FALSE to disable
the line break filter if this has been turned on in the global
settings.</dd>
<dt><code>css</code></dt>
<dd>Specify a css file that will be used for this file. This .css file
must reside in the help directory along with the .html files. This
will override any .css file added by the global settings.</dd>
<dt><code>popup width</code> (500)</dt>
<dd>The width in pixels of the popup window.</dd>
<dt><code>popup height</code> (500)</dt>
<dd>The height in pixels of the popup window.</dd>
</dl>
<p>For example, here is a version of the <code>advanced_help.help.ini</code> file:</p>
<pre>
[readme]
title = README
weight = -11
[using-advanced-help]
title = Using advanced help
weight = -10
[translation]
title = Translating advanced help
[ini-file]
title = Help .ini file format
line break = FALSE
[why-advanced-help]
title = Why advanced help?
line break = TRUE
</pre>
<h2>Om denne oversettelsen</h2>
<p>Dette er en (delvis) oversettelse til <em>norsk</em> (bokmål) av
hjelpeteksene for <strong>Advanced help</strong>. Den er i første
rekke laget for å vise hvordan en oversettelse av hjelpetekstene ser ut.</p>
<h2 id="project-description">Synopsis</h2>
<p>Modulen <strong>Advanced help</strong> tilbyr et rammeverk som gjør
det mulig for modul- og theme-utviklere å integrere hjelpetekster i et
Drupal-nettsted.</p>
<p>These help texts are stored in ordinary <code>.html</code>-files
that lives in the file system (as opposed to the database). These
files are distributed from the project Drupal.org repo in the same
package as the module or theme, and placed in a subdirectory named
<code>help</code> in the project or theme directory. This means that
the help texts can be easiely kept in sync with the project they
provide help texts for, but also that read access to these files
are not managed by any content access restrictions imposed by Drupal.</p>
<p>The help texts can be marked up with standard HTML, but are
rendered within your site's Drupal theming structure.</p>
<p>If the module or theme author does not make use of the full
<em>Advanced help</em> framework, but if there is a
<code>README.md</code> or <code>README.txt</code> in the package,
the content of that file will be shown instead.</p>
<p>The help texts may appear in a popup or not as the module prefers.
By taking away access to view the popups, a site can hide popups from
users.</p>
<p>The help texts can be placed in a hierarchy, allowing for top down
navigation of help.</p>
<p>The hierarchy is tied into Drupal's search system. If advanced help
search is enabled, all help texts are fully indexed. This means that
the entire contents of the advanced help set of pages can be searched
for keywords.</p>
<h2 id="use">Bruk av modulen</h2>
<p>By itself, this module doesn't do much. The <strong>Advanced
help</strong> assists other modules and themes in showing help texts.
Nothing will show up until you enable at least one other module that
makes use of the advanced help framework or comes with a file
named <code>README.md</code> or <code>README.txt</code>. However, it
comes with a small companion demo module named
<strong>Advanced help example</strong> to demonstrate how it works.
For more extensive example of use of the advanced help features, see
the <strong>Views</strong> project.</p>
<h2 id="project-recommended">Anbefalte moduler</h2>
<ul>
<!--
<li><a href="https://www.drupal.org/project/markdown">Markdown filter</a>:<br>
When this module is enabled, display of any <code>README.md</code> the
module shows will be rendered with markdown.</li>
-->
<li><a href="https://www.drupal.org/project/attributions">Attributions</a>:<br>
When this module is enabled, attributions of third party content used
by the project (i.e. some text from Wikipedia) will be available in an
attribution block and on an atribution page.</li>
</ul>
<h2 id="support-status">Status for oppfølging</h2>
<p>Reported bugs for the Drupal 7 branch will be fixed in a timely
manner. Bugs in the issue queue for the Drupal 6 branch will only be
fixed if accompanied with a patch, after the patch has been reviewed
and tested by the community. No Drupal 8 version is currently under
development. Post a message in
the <a href="https://www.drupal.org/node/1928218">issue queue</a> if
you're interested in managing a port of the project to to Drupal
8. Older versions are no longer supported.</p>
<p>Community support in the form of patches are very welcome for both
Drupal 6 and Drupal 7 versions, and will be given priority. For QA,
the project needs community support in the form of reviews of patches,
development versions and releases.</p>
<p>The primary goal of the module is to remain <strong>light-weight
and simple</strong>. This means that not all feature requests will be
implemented, even if they are a good idea. Feature requests
accompanied by patches are more likely to make it into a release.</p>
<p>The maintainer hopes that the community is willing to help out by
answering &amp; closing support requests.</p>
<!--
<h2 id="project-problems">Kjente problemer</h2>
-->
<h2 id="project-maintainers">Kreditering</h2>
<ul>
<li><a href="https://www.drupal.org/u/merlinofchaos"">merlinofchaos</a> (52 commits, original creator)</li>
<li><a href="https://www.drupal.org/u/redndahead">redndahead</a> (8 commits)</li>
<li><a href="https://www.drupal.org/u/dmitrig01">dmitrig01</a> (3 commits)</li>
<li><a href="https://www.drupal.org/u/amitgoyal">amitgoyal </a> (5 commits)</li>
<li><a href="https://www.drupal.org/u/gisle">gisle</a> (current maintainer)</li>
</ul>
<p>For å oversette en hjelpe-fil indeksert av <strong>Advanced help</strong>
må du først opprette en katalog
<code>translations/help/<em>språk</em></code> i prosjektets rotkatalog der
<em>språk</em> er språkkoden som vises på siden <em>Språk</em> i det
administrative grensesnittet.</p>
<p>Deretter kopierer du <code>.ini</code>-fila og alle
<code>.html</code> filene fra den opprinnelige hjelpe-katalogen
katalogen til denne katalogen. Om du trenger å endre et bilde for å
bruke det i en oversettelse, kan du også plassere det endrede bildet
her.</p>
<p>I emne-delen av <code>.ini</code>-fila trenger du bare å beholde
emnenavnene (uendret) og titlene (oversatt). Hvis det finnes
en <code>name</code> eller <code>index name</code> innstilling i
'advanced help settings'-delen, bør disse beholdes. Alle innstillinger
som beholdes skal oversettes. Resten av dataene i
<code>.ini</code>-filen kan fjernes eller ignoreres. </p>
<p>Hver enkelt <code>.html</code>-fil skal deretter oversettes uten å
endre navn eller plassering.</p>
<p>Når du oversetter en <code>.html</code>-fil, vil du finne at
nøkkelordet <code>&amp;path&amp;</code> (brukes for bilder og linker)
vil føre til den opprinnelige katalogen. Hvis du må oversette
elementer som er lenket, for eksempel bilder som inneholder tekst,
bruke <code>&amp;trans_path&amp;</code> i stedet. Dette nøkkelordet
vil peke på den oversatte katalogen. Dette vil tillate deg å velge
hvilke lenkede elementer, om noen, som vil bli oversatt.</p>
<p> Hvis et emne ikke er oversatt, så vil den uoversatte versjonen
vil bli vist i stedet.</p>
<h2>Oversettelse av hjelpetekstene til Advanced help</h2>
<p>Dersom du ønsker å hjelpe til med å oversette
hjelpetekstene til <strong>Advanced help</strong> til et bestemt språk
kan du se etter en tråd i <a href="https://www.drupal.org/project/issues/advanced_help">sporingskøen for Advanced help</a>
med navnet “Translation to XXX” (der
“XXX” språket du ønsker å oversette hjelpetekstene til).
Dersom en slik tråd ikke eksisterer kan du opprette den.
Velg <em>Category</em> “Task”,
<em>Status</em> “Needs review” og
<em>Component</em> “Documentation”.
Last opp filer med oversatte hjelpetekster som
vedlegg (endre filtype fra <code>.html</code> til <code>.txt</code> for å få lov til å laste opp).</p>
<p>Oversettelser som lastes opp vil bli inkludert i neste versjon dersom de godkjennes av andre brukere (ved at de oppnår status “RTBC”).
<p>Modulen <strong>Advanced help</strong> tilbyr et rammeverk som gjør
det mulig for modul- og theme-utviklere å integrere hjelpetekster i et
Drupal-nettsted. Selv om <strong>Advanced help</strong> ikke selv
inneholder generell hjelp tilbyr den et kraftig og enkelt rammeverk som
prosjekter kan benytte for å tilby egen hjelp.</p>
<p>Prosjekter som benytter <strong>Advanced help</strong>
ha en underkatalog med navnet <code>help</code> i sin rotkatalog
I denne katalogen opprettes filen
<em>MODULNAVN</em>.help.ini (evt. <em>THEMENAVN</em>.help.ini).
Formatet på denne fila framgår av følgende eksempel:</p>
<pre>
[about-php]
title = About PHP
file = about-php
weight = -10
[history]
title = History of PHP
parent = about-php
[usage]
title = Usage of PHP
weight = 1
[security]
title = Security of PHP
weight = 2
[syntax]
title = PHP syntax
parent = usage
</pre>
<p>Lag alltid den engelske versjonen av disse temaene først. Ønsker
du å ha temaene oversatt til et annet språk følger du anvisningene i
<a href="&topic:advanced_help/translation&">Oversettelse av
Advanced help</a>.</p>
<p>Denne fila definerer fem hjelpe-emner (i firkant-parenteser), og
noen innstillinger for dem.
Se: <a href="&topic:advanced_help/ini-file&">Advanced help .ini-filformat</a> for
en liste over definerte innstillinger.</p>
<p>Alle emner er beskrevet av det prosjektet som tilbyr
emnet, og av emne-id. For å produsere en themet lenke til et
sprettopp-vindu om et emne, bruk et format etter mønster fra følgende
eksempel:</p>
<!-- D6
<pre>
$output = theme('advanced_help_topic', 'help_example', 'about-php');
$output .= '&nbsp;' . t('Click the help icon!');
</pre>
-->
<!-- D7 -->
<pre>
$output = theme('advanced_help_topic', array(
'module' => 'help_example',
'topic' => 'about-php',
));
$output .= '&nbsp;' . t('Click the help icon.');
</pre>
<p>Ikke oversett strengen inne i <code>t()</code>. Bruk alltid engelsk, og benytt Drupals lokaliserings-modul til å oversette.</p>
<p>Forutsatt at strengene er korrekt oversatt (ved hjelp av Drupals lokaliserings-modul) genererer dette følgende markeringer:</p>
<pre>
&lt;a class="advanced-help-link" title="Om PHP"
onclick="var w=window.open(this.href, 'advanced_help_window',
'width=500,height=500,scrollbars,resizable');
w.focus(); return false;"
href="/help/help_example/about-php?popup=1"&gt;
&lt;span&gt;Hjelp&lt;/span&gt;
&lt;/a&gt;
Klikk på hjelpe-ikonet.
&lt;/div&gt;
</pre>
<p>Dette produserer et klikkbart hjelpe-ikon lik det som vises under:</p>
<div class="ta-center">
<img class="help-img-center" alt="klikkbart ikon" src="&trans_path&click_icon.png" width="180" height="90" border="0" />
</div>
<p>Inne i en hjelpe-fil kan du lenke til andre hjelpe-emner ved å
bruke dette formatet:</p>
<pre>
&lt;a href="&amp;topic:module/topic&amp;"&gt;topic&lt;/a&gt;
</pre>
<p>Ved å bruke dette formatet i stedet for standard-lenker vil sprettopp-status være konsistent når man trykker på lenker.</p>
<p>For å referere til andre elementer som befinner seg i
hjelpe-katalogen, som bilder som du ønsker å bake inn i teksten,
bruk:</p>
<pre>
&lt;img src="&amp;path&amp;example.png"/&gt;
&lt;img src="&amp;trans_path&amp;example.png"/&gt;
</pre>
<p>Nøkkelordet <code>trans_path</code> vil peke på en oversatt versjon
av bildet i oversettelse-katalogen og kan benyttes dersom du ønsker å
vise et bilde med oversatt tekst i stedet for originalen.</p>
<p>For å peke på en normal sti på nettstedet, bruk:</p>
<pre>
&lt;a href="&amp;base_url&amp;admin/settings/site-configuration"&gt;anchor text&lt;/a&gt;
</pre>
<p><strong>NB: </strong> I tidligere versjoner av <strong>Advanced
help</strong> var det ikke nødvendig å benytte &amp;-tegn rundt
<code>topic:</code>, <code>path</code>, og <code>base_url</code>.
Dette fungerer fortsatt, men kan bli fjernet i en senere versjon.
Ved å bruke &amp;-tegn for å markere disse nøkkelordene kan de
brukes overalt, og ikke bare som parametere til
<code>href=""</code> og <code>src=""</code>.</p>
<h2 id="access-control">Adgangskontroll</h2>
<p>Når denne modulen er installert vil brukere med tillatelsen
<code>view advanced help index</code>
se indeks-siden for <strong>Advanced help</strong> ved å gå til
<em>Administrasjon &rarr; Advanced Help</em>
(sti: <code>admin/advanced_help</code>). Øvrige tillatelser
<code>view advanced help topic</code> og
<code>view advanced help popup</code>
gir brukere adgang til de aktuelle hjelpe-sidene og sprettopp-vinduer.</p>
<p>Hjelpeteksten er lagret som vanlige <code>.html</code>-filer og
kan, med mindre de beskyttes, bli sett av alle som kjenner deres URL.
Dersom du ønsker å beskytte dem kan du beskytte dem mot innsyn ved å
plassere følgende fire linjer i en fil med navn
<code>.htaccess</code> i katalogen <code>help</code> i prosjektkatalogen:</p>
<pre>
&lt;Files *\.html&gt;
Order Allow,Deny
Deny from all
&lt;/Files&gt;
</pre>
<p>Det er nettstedsansvarlig som har ansvaret for at denne typen
beskyttelse er på plass dersom nettstedet har hjelpe-filer som må
beskyttes fra direkte innsyn.</p>
<p>Se også denne tråden i prosjektets sporings-kø:
<a href="https://www.drupal.org/node/1980936">#1980936 Typing complete path to .html help files in module bypasses user permissions</a>.</p>
<h2 id="search">Søk</h2>
<p>For å skru på søk for <strong>Advanced help</strong>, naviger til
<em>Administrasjon → Oppsett → Søk og metadata → Søkeinnstillinger</em>.
Rull ned til feltet <em>Aktive søkemoduler</em> og kryss av feltet til venstre for
“Advanced help”. Søkefeltet vil deretter dukke opp på toppen av indekssidene for
<strong>Advanced help</strong>.</p>
<p>Dersom modulen <strong>Search</strong> i core er skrudd på, vil alt
innhold på hjelpesidene bli indeksert av cron. Dersom du installerer
og skrur på nye prosjekter og ønsker å indeksere deres
hjelpetekster umiddelbart kan du navigere til <em>Administrasjon →
Rapporter → Status</em> og klikke på lenken for å “kjøre cron
manuelt.”.</p>
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.