Indledning
Help2Form giver brugeren mulighed for af få hjælp til en HTML-form, ala "What's this ?".
Når brugeren klikker på hjælp knappen [?], vises markøren som et spørgsmåltegn (?).
Brugeren kan herefter vælge et felt som der ønskes hjælp til.
Hvis der findes hjælp til det valgte felt vises hjælpe teksten i et seperat vindue.
Help2form er et rent client-side script og kan benyttes uden brug af serverside-teknologier (Men kan dog implimenteres). Scriptet supporteres i Mozilla, Netscape6+ og MSIE5+ (delvist Opera7). Det kræver selvfølgelig at brugeren har javascript slået til.
Eksempel
Help2Form kan vise informationer om et element på siden, hente en hjælpe tekst fra et array eller hente hjælpe teksten fra en seperat HTML-side.
Her er et eksempel der viser lidt af hvert hvad det kan.
Her er et eksempel på en kontaktform som help2form var tiltænkt.
Kompatibel
| Browser | IE 5 (win) | IE 6 (win) | IE 5 (mac) | Netscape 4 | Mozilla 1.0 | Opera 6 | Opera 7 | ||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Oversigt over help2form support. | |||||||||||
| help2form | Ja | Ja | Nej | Nej | Ja | Nej | Næsten (1) | ||||
(1) Opera supportere ikke dynamisk inkludering af javascript filer (remote scripting), men jeg har lavet så det kan omgåes i denne browser.
Opsætning
For at opsætte din help2form skal du linke til javascript-filen mhahelp2form.js.
<script src="mhahelp2form.js" type="text/javascript"></script>
På siden med formen skal du have en hjælp knap med ID'et btnHelpPopup, der får browseren til at gå i hjælpe måde.
<input type="button" value=" ? " id="btnHelpPopup" accesskey="h" title="Help" />
Til sidst skal du oprette alle de hjælpe filer som skal bruges til formen. De skal ligge i en hoved mappe, som er ens med ID'et på formen. Hvis din form f.eks. har ID'et kontaktform, skal du oprette en mappe med navnet kontaktform.
Hjælpe filerne skal navngives efter navnet på det form felt de er tilknyttet til. Hvis dit felt har navnet fornavn, skal filen kaldes fornavn.html.
Hjælpe filerne skal overholde nedenstående bestemte format. Formattet gør at, hvis brugeren klikker på et felt, hvor der ikke findes en hjælpe HTML-fil, så kommer der ingen 404 Fejl.
<!--
/*-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
<title>Fornavn</title>
</head>
<body>
<h1>Fornavn</h1>
<p>Her er hjælpe teksten til feltet 'fornavn'.</p>
<p>Og noget mere hjælpe tekst.</p>
<code style="display:none;"><!--*/ //-->
if (helpDocReady) helpDocReady();
<!--
/*-->
</code>
</body>
</html><!--*/ //-->
Dokumentation
Ideen med det bestemte format af hjælpe tekster, som gør at javascript først undersøger om filen findes, har jeg fået fra Tantek.
Hvis der er ønske om det, kan jeg godt dokumentere denne kode noget mere i dybten.