1 |
6e9292aa
|
Assos Assos
|
<p>Modulen <strong>Avansert hjelp</strong> tilbyr et rammeverk som gjør
|
2 |
|
|
det mulig for modul- og theme-utviklere å integrere hjelpetekster i et
|
3 |
|
|
Drupal-nettsted. Selv om <strong>Avansert hjelp</strong> ikke selv
|
4 |
|
|
inneholder generell hjelp tilbyr den et kraftig og enkelt rammeverk som
|
5 |
|
|
prosjekter kan benytte for å tilby egen hjelp.</p>
|
6 |
|
|
|
7 |
|
|
<p>Prosjekter som benytter <strong>Avansert hjelp</strong> må
|
8 |
|
|
ha en underkatalog med navnet <code>help</code> i sin rotkatalog
|
9 |
|
|
I denne katalogen opprettes filen
|
10 |
|
|
<em>MODULNAVN</em>.help.ini (evt. <em>THEMENAVN</em>.help.ini).
|
11 |
|
|
Formatet på denne fila framgår av følgende eksempel:</p>
|
12 |
|
|
|
13 |
|
|
<pre>
|
14 |
|
|
[about-php]
|
15 |
|
|
title = About PHP
|
16 |
|
|
file = about-php
|
17 |
|
|
weight = -10
|
18 |
|
|
|
19 |
|
|
[history]
|
20 |
|
|
title = History of PHP
|
21 |
|
|
parent = about-php
|
22 |
|
|
|
23 |
|
|
[usage]
|
24 |
|
|
title = Usage of PHP
|
25 |
|
|
weight = 1
|
26 |
|
|
|
27 |
|
|
[security]
|
28 |
|
|
title = Security of PHP
|
29 |
|
|
weight = 2
|
30 |
|
|
|
31 |
|
|
[syntax]
|
32 |
|
|
title = PHP syntax
|
33 |
|
|
parent = usage
|
34 |
|
|
</pre>
|
35 |
|
|
|
36 |
|
|
<p>Lag alltid den engelske versjonen av disse temaene først. Ønsker
|
37 |
|
|
du å ha temaene oversatt til et annet språk følger du anvisningene i
|
38 |
|
|
<a href="&topic:advanced_help/translation&">Oversettelse av
|
39 |
|
|
Avansert hjelp</a>.</p>
|
40 |
|
|
|
41 |
|
|
<p>Denne fila definerer fem hjelpe-emner (i firkant-parenteser), og
|
42 |
|
|
noen innstillinger for dem.
|
43 |
|
|
Se: <a href="&topic:advanced_help/ini-file&">Avansert hjelp .ini-filformat</a> for
|
44 |
|
|
en liste over definerte innstillinger.</p>
|
45 |
|
|
|
46 |
|
|
<p>Alle emner er beskrevet av det prosjektet som tilbyr
|
47 |
|
|
emnet, og av emne-id. For å produsere en themet lenke til et
|
48 |
|
|
sprettopp-vindu om et emne, bruk et format etter mønster fra følgende
|
49 |
|
|
eksempel:</p>
|
50 |
|
|
|
51 |
|
|
|
52 |
|
|
|
53 |
|
|
|
54 |
|
|
|
55 |
|
|
|
56 |
|
|
|
57 |
|
|
|
58 |
|
|
|
59 |
|
|
<pre>
|
60 |
|
|
$output = theme('advanced_help_topic', array(
|
61 |
|
|
'module' => 'help_example',
|
62 |
|
|
'topic' => 'about-php',
|
63 |
|
|
));
|
64 |
|
|
$output .= ' ' . t('Click the help icon.');
|
65 |
|
|
</pre>
|
66 |
|
|
|
67 |
|
|
<p>Ikke oversett strengen inne i <code>t()</code>. Bruk alltid engelsk, og benytt Drupals lokaliserings-modul til å oversette.</p>
|
68 |
|
|
|
69 |
|
|
<p>Forutsatt at strengene er korrekt oversatt (ved hjelp av Drupals lokaliserings-modul) genererer dette følgende markeringer:</p>
|
70 |
|
|
|
71 |
|
|
<pre>
|
72 |
|
|
<a class="advanced-help-link" title="Om PHP"
|
73 |
|
|
onclick="var w=window.open(this.href, 'advanced_help_window',
|
74 |
|
|
'width=500,height=500,scrollbars,resizable');
|
75 |
|
|
w.focus(); return false;"
|
76 |
|
|
href="/help/help_example/about-php?popup=1">
|
77 |
|
|
<span>Hjelp</span>
|
78 |
|
|
</a>
|
79 |
|
|
Klikk på hjelpe-ikonet.
|
80 |
|
|
</div>
|
81 |
|
|
</pre>
|
82 |
|
|
|
83 |
|
|
<p>Dette produserer et klikkbart hjelpe-ikon lik det som vises under:</p>
|
84 |
|
|
|
85 |
|
|
<div class="ta-center">
|
86 |
|
|
<img class="help-img-center" alt="klikkbart ikon" src="&trans_path&click_icon.png" width="180" height="90" border="0" />
|
87 |
|
|
</div>
|
88 |
|
|
|
89 |
|
|
<p>Inne i en hjelpe-fil kan du lenke til andre hjelpe-emner ved å
|
90 |
|
|
bruke dette formatet:</p>
|
91 |
|
|
<pre>
|
92 |
|
|
<a href="&topic:module/topic&">topic</a>
|
93 |
|
|
</pre>
|
94 |
|
|
<p>Ved å bruke dette formatet i stedet for standard-lenker vil sprettopp-status være konsistent når man trykker på lenker.</p>
|
95 |
|
|
|
96 |
|
|
<p>For å referere til andre elementer som befinner seg i
|
97 |
|
|
hjelpe-katalogen, som bilder som du ønsker å bake inn i teksten,
|
98 |
|
|
bruk:</p>
|
99 |
|
|
<pre>
|
100 |
|
|
<img src="&path&example.png"/>
|
101 |
|
|
<img src="&trans_path&example.png"/>
|
102 |
|
|
</pre>
|
103 |
|
|
|
104 |
|
|
<p>Nøkkelordet <code>trans_path</code> vil peke på en oversatt versjon
|
105 |
|
|
av bildet i oversettelse-katalogen og kan benyttes dersom du ønsker å
|
106 |
|
|
vise et bilde med oversatt tekst i stedet for originalen.</p>
|
107 |
|
|
|
108 |
|
|
<p>For å peke på en normal sti på nettstedet, bruk:</p>
|
109 |
|
|
<pre>
|
110 |
|
|
<a href="&base_url&admin/settings/site-configuration">anchor text</a>
|
111 |
|
|
</pre>
|
112 |
|
|
|
113 |
|
|
<p><strong>NB: </strong> I tidligere versjoner av <strong>Advanced
|
114 |
|
|
help</strong> var det ikke nødvendig å benytte &-tegn rundt
|
115 |
|
|
<code>topic:</code>, <code>path</code>, og <code>base_url</code>.
|
116 |
|
|
Dette fungerer fortsatt, men kan bli fjernet i en senere versjon.
|
117 |
|
|
Ved å bruke &-tegn for å markere disse nøkkelordene kan de
|
118 |
|
|
brukes overalt, og ikke bare som parametere til
|
119 |
|
|
<code>href=""</code> og <code>src=""</code>.</p>
|
120 |
|
|
|
121 |
|
|
<h2 id="access-control">Adgangskontroll</h2>
|
122 |
|
|
|
123 |
|
|
<p>Når denne modulen er installert vil brukere med tillatelsen
|
124 |
|
|
<code>view advanced help index</code>
|
125 |
|
|
se indeks-siden for <strong>Avansert hjelp</strong> ved å gå til
|
126 |
|
|
<em>Administrasjon → Advanced Help</em>
|
127 |
|
|
(sti: <code>admin/advanced_help</code>). Øvrige tillatelser
|
128 |
|
|
<code>view advanced help topic</code> og
|
129 |
|
|
<code>view advanced help popup</code>
|
130 |
|
|
gir brukere adgang til de aktuelle hjelpe-sidene og sprettopp-vinduer.</p>
|
131 |
|
|
|
132 |
|
|
<p>Hjelpeteksten er lagret som vanlige <code>.html</code>-filer og
|
133 |
|
|
kan, med mindre de beskyttes, bli sett av alle som kjenner deres URL.
|
134 |
|
|
Dersom du ønsker å beskytte dem kan du beskytte dem mot innsyn ved å
|
135 |
|
|
plassere følgende fire linjer i en fil med navn
|
136 |
|
|
<code>.htaccess</code> i katalogen <code>help</code> i prosjektkatalogen:</p>
|
137 |
|
|
|
138 |
|
|
<pre>
|
139 |
|
|
<Files *\.html>
|
140 |
|
|
Order Allow,Deny
|
141 |
|
|
Deny from all
|
142 |
|
|
</Files>
|
143 |
|
|
</pre>
|
144 |
|
|
|
145 |
|
|
<p>Det er nettstedsansvarlig som har ansvaret for at denne typen
|
146 |
|
|
beskyttelse er på plass dersom nettstedet har hjelpe-filer som må
|
147 |
|
|
beskyttes fra direkte innsyn.</p>
|
148 |
|
|
|
149 |
|
|
<p>Se også denne tråden i prosjektets sporings-kø:
|
150 |
|
|
<a href="https://www.drupal.org/node/1980936">#1980936 Typing complete path to .html help files in module bypasses user permissions</a>.</p>
|
151 |
|
|
|
152 |
|
|
<h2 id="search">Søk</h2>
|
153 |
|
|
|
154 |
|
|
<p>For å skru på søk for <strong>Avansert hjelp</strong>, naviger til
|
155 |
|
|
<em>Administrasjon → Oppsett → Søk og metadata → Søkeinnstillinger</em>.
|
156 |
|
|
Rull ned til feltet <em>Aktive søkemoduler</em> og kryss av feltet til venstre for
|
157 |
|
|
“Advanced help”. Søkefeltet vil deretter dukke opp på toppen av indekssidene for
|
158 |
|
|
<strong>Avansert hjelp</strong>.</p>
|
159 |
|
|
|
160 |
|
|
<p>Dersom modulen <strong>Search</strong> i core er skrudd på, vil alt
|
161 |
|
|
innhold på hjelpesidene bli indeksert av cron. Dersom du installerer
|
162 |
|
|
og skrur på nye prosjekter og ønsker å indeksere deres
|
163 |
|
|
hjelpetekster umiddelbart kan du navigere til <em>Administrasjon →
|
164 |
|
|
Rapporter → Status</em> og klikke på lenken for å “kjøre cron
|
165 |
|
|
manuelt.”.</p> |