Entwicklung von Hilfetexten: Unterschied zwischen den Versionen
| Zeile 21: | Zeile 21: | ||
== Einbindung der Hilfetexte == | == Einbindung der Hilfetexte == | ||
Für die Einbindung der Textbausteine wird eine Sammlung von jQuery Scripts zur Verfügung gestellt. Diese | Für die Einbindung der Textbausteine wird eine Sammlung von jQuery Scripts zur Verfügung gestellt. Diese müssen in der Lage sein diese Aufgaben zu erfüllen: | ||
* Abrufen einer Seite aus diesem Wiki samt Extraktion des eigentlichen Hilfetextes aus dem DIV Tag mit der ID 'txt' | * Abrufen einer Seite aus diesem Wiki samt Extraktion des eigentlichen Hilfetextes aus dem DIV Tag mit der ID 'txt' | ||
* Konvertierung von Links mit Fallunterscheidung: Links zu externen Seiten - dazu zählen auch Link in der [[BISWiki:Start|BIS Wiki]] - müssen zum Öffnen der Seite in einem neuen Fenster führen. Links innerhalb dieses Wikis zu anderen Hilfeseiten sollen hingegen im gleichen Kontext geöffnet werden, so dass eine Verlinkungen von Themen innerhalb der Hilfeschnipsel möglich ist | |||
Version vom 19. August 2013, 11:12 Uhr
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 Wiki 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.
Kategorien
Einbindung der Hilfetexte
Für die Einbindung der Textbausteine wird eine Sammlung von jQuery Scripts zur Verfügung gestellt. Diese müssen in der Lage sein diese Aufgaben zu erfüllen:
- Abrufen einer Seite aus diesem Wiki samt Extraktion des eigentlichen Hilfetextes aus dem DIV Tag mit der ID 'txt'
- Konvertierung von Links mit Fallunterscheidung: Links zu externen Seiten - dazu zählen auch Link in der BIS Wiki - müssen zum Öffnen der Seite in einem neuen Fenster führen. Links innerhalb dieses Wikis zu anderen Hilfeseiten sollen hingegen im gleichen Kontext geöffnet werden, so dass eine Verlinkungen von Themen innerhalb der Hilfeschnipsel möglich ist