Entwicklung von Hilfetexten

Die Aufgabe dieses Wikis ist es den BIS Anwendungen Textschnipsel zur Verfügung zu stellen, die per Javascript Einbindung direkt in den Oberflächen angezeigt werden können. Gleichzeitig sind die Wiki Seiten die Rückfalloption für NutzerInnen, die kein Javascript in ihren Webbrowsern nutzen können oder wollen.

Aufbau der Hilfeseiten im Wiki

Ziel dieses Wikis ist es Hilfetexte abzubilden, die an verschiedenen Stellen in den BIS Anwendungen benötigt werden. Es geht dabei um stark kontextabhängige Texte, also Texte die sich auf ganz konkrete Fragen, Funktionen bzw. Anwendungsseiten beziehen.

Eine Seite pro Hilfetext

Auch wenn die Hilfetexte ohne Javascript zugänglich sein müssen ist es das Hauptziel dieses Hilfesystems den NutzerInnen direkt in ihrem Kontext die entsprechenden Texte anzeige zu können. Die technischen Details dazu werden weiter unten beschrieben, eine grundsätzliche Entscheidung besteht aber darin, dass eine 1-zu-1 Beziehnung zwischen Hilfetextschnipsle und Wiki Seite besteht. Oder anders gesagt:

Jeder Hilfetext wird in eine separate Wiki Seite gepackt.

Nutzung eines Templates für die Seiteninhalte

Die Hilfetextschnipsel müssen einheitlich im HTML Code makiert sein, auch soll die Nutzung von Kategorien homogen erfolgen und zusätzliche Information zum Verwendungszweck strukturiert abgebildert werden. Es wird daher mit Templates bzw. Vorlagen gearbeitet.

Es reicht dabei ein einziges Templates aus, das h-Template. Seine Nutzung wird in der Spielwiese demonstriert.