myJACK Help Home

Auf dieser Seite wird beschrieben, wie Hilfeseiten erstellt werden, und wie diese Hilfeseiten dann in myJACK angezeigt werden können.

Bitte beachten, dass für diese Funktion nur Artikel im Bereich MYJH berücksichtigt werden.

 

Erstellen einer Hilfeseite

In dem Hilfebereich befinden sich zwei Unterpunkte, unter denen neue Seiten angelegt werden können: Areas und Topics.

Areas ist für die Hautpseiten gedacht, die einen Menüpunkt abdecken, wie z.B. “Verwaltung - Listen - Terminliste”.

Der Unterpunkt Topics ist für sonstige Themen vorgesehen.

Die beiden Punkte Areas und Topics dürfen nicht gelöscht werden. Es dürfen keine Seiten parallel zu den beiden angelegt werden, denn diese Seiten werden ignoriert. Neue Hilfeseiten müssen demnach entweder unter Areas oder Topics angelegt werden.

Unterhalb der beiden Hauptpunkt können beliebige Seiten mit beliebigen Unterseiten angelegt werden.

Aufbau einer Hilfeseite

Der Aufbau einer Hilfeseite muss einem bestimmten Schema entsprechen, damit die Anzeige in myJACK entsprechend sauber aussieht.

Der Artikel besteht also aus drei Bestandteilen:

  • Titel: wird immer angezeigt

  • erster Absatz: wird immer als Beschreibung angezeigt

  • der Rest wird nur dann angezeigt, wenn der Nutzer auf die Beschreibung klickt.

 

Verwandte Artikel

Verwandte Artikel sind Seiten, die zwar nicht direkt einem Menüpunkt in myJACK zugeordnet sind, aber mit ihm zusammenhängen.

Verwandte Artikel sind:

  • Alle Artikel, die im Hilfebereich unter dem Artikel mit der Zuordnung zum Menüpunkt angelegt wurden.

  • Alle Artikel, die im Hilfebereich über dem Artikel mit der Zuordnung zum Menüpunkt vorhanden sind.

  • Alle Artikel, die über ein Label mit dem Artikel mit der Zuordnung zum Menüpunkt verknüpft ist.

  • Alle Artikel, die als Secondary Keyword für die aktuell Seite gelistet sind.

 

Zuordnung einer Hilfeseite zu einem myJACK Menüpunkt

Die Zuordnung einer Hilfeseite zu einem myJACK Menüpunkt wird über ein sog. “Keyword” vorgenommen. Das Keyword muss durch die Entwicklung im Source Code hinterlegt werden.

Wenn man sich in myJACK als Admin anmeldet, sieht man im Bereich <Administation> einen neuen Bereich <Hilfe-Verknüpfungen>. Diese Liste basiert auf dem neuen Listenframework.

Die Zuordnung erfolgt konkret über eine Artikel-ID, die bei einem Keyword hinerlegt werden muss. mit <Artikel-ID> ist dabei die Nummer des entsprechenden Confluence Artikels gemeint, der bei dem Menüpunkt angezeigt werden soll.

Wo sehe ich diese ID?

Wenn man einen Hilfe Artikel aufruft, wird die URL im Browser angezeigt.

Mit einem Doppelklick auf einen Eintrag wird ein kleines Fenster angezeigt, in dem man diese ID einfügen kann.

 

Keywordanzeige

Die für eine Maske aktiven Keywords können mithilfe von Ctrl Alt Shift D (⌥⇧⌘D macOS) im Hilfebereich angezeigt werden lassen.

Dabei gibt es ein Primary Keyword und mehrere Secondary Keywords.

Primary Keyword: dies ist das Keyword der aktuell geöffneten Maske. Dieses Keyword wird verwendet, um Hilfeseiten zur Funktion an sich anzuzeigen, also z.B. zur Terminliste.

Secondary Keyword: es kann bei einer Seite mehrere Secondary Keywords geben. Diese beziehen sich auf Bestandteile der Maske, wie z.B. das Multiselection-Feld im neuen Listenframework. Für dieses Feld wird ein eigenes Keyword definiert, das dann bei jeder Seite als Secondary Keyword auftaucht, auf dem diese Komponente verwendet wird.
Bei der Anzeige der Hilfeartikel werden auch die Artikel für Secondary Keywords mit angezeigt.

 

Anzeige in myJACK

Wenn man in myJACK einen Menüpunkt aufruft, für den Hilfeartikel zur Verfügung steht, so wird die Hilfe direkt angezeigt.

In der Hilfe unten gibt es eine Schaltfläche, mit der die Anzeige direkt abbestellt werden kann. Tut man das nicht, so wird die Seite immer beim Aufruf des Menüpunkts angezeigt, bis entweder zehn Tage vergangen sind, oder man den Menüpunkt 10 mal aufgerufen hat. Dann wird die Hilfe nicht mehr automatisch angezeigt, sondern kann mit einem Klick auf “Hilfe” manuell aufgerufen werden.

In der Administration gibt jedoch die Möglichkeit, die Abschaltung der automatischen Anzeige wieder zu starten. Mit einem Doppelklick auf ein Keyword hat man in der Bearbeitungsmaske die Möglichkeit, die Benachrichtigung für eine bestimmte Version einzustellen. Dadurch wird bei allen Kunden die Automatik wieder angestellt. Siehe Versionseinschränkung

Dies kann man verwenden, wenn man an der Haupthilfeseite etwas wesentliches geändert hat, oder neue Artikel hinzugefügt hat, z.B. für neue Funktionen. Die neu hinzugefügten Seiten werden dann mit dem Vermerk “Neu” versehen.

Sonderfunktionen

Versionseinschränkungen

Artikel können in ihrer Verfügbarkeit auf Versionen eingeschränkt werden. Dazu kann hinter dem Titel der Seite in eckigen Klammern eine Versionsspanne angegeben werden, z.B. Titel [23.6..23.8]. Die Versionsspanne kann eine Mindestversion und eine Maximalversion angeben. Der Artikel wird dann nur angezeigt, wenn die aktuelle Version von myJACK innerhalb der angegeben Versionsspanne liegt.

Syntax

Eine Versionsspanne folgt eine festen Syntax:

  1. [ das Startzeichen

  2. keine bis beliebig viele Leerzeichen

  3. xx.y die optionale, inklusive Mindestversion

  4. keine bis beliebig viele Leerzeichen

  5. .. das Spannen-Trennzeichen

  6. keine bis beliebig viele Leerzeichen

  7. xx.y die optionale, inklusive Maximalversion

  8. keine bis beliebig viele Leerzeichen

  9. ] das Endzeichen

Bezeichnet eine Versionsspanne genau eine Version, so kann eine vereinfachte Syntax verwendet werden:

  1. [ das Startzeichen

  2. keine bis beliebig viele Leerzeichen

  3. xx.y die Version

  4. keine bis beliebig viele Leerzeichen

  5. ] das Endzeichen

Beispiele

[23.6 .. 23.9] ist eine Spanne von der 23.6 inklusive bis zur 23.9 inklusive. 23.5 und niedriger sowie 23.10 und höher sind somit nicht in der Spanne enthalten.

[23.6 ..] ist eine Spanne ab der 23.6 inklusive. 23.5 und niedriger sind somit nicht in der Spanne enthalten. Nach oben gibt es keine Einschränkung.

[.. 23.9] ist eine Spanne bis zur 23.9. 23.10 und höher sind somit nicht in der Spanne enthalten. Nach unten gibt es keine Einschränkung.

[23.6 .. 23.6] oder [23.6] ist eine Spanne, die nur die 23.6 enthält.

Badges

Anhand der Versionsspanne werden Artikel mit Badges ausgestattet. Hierbei erhalten Artikel, dessen Mindestversion der aktuellen Version entspricht, eine NEU Badge und Artikel, dessen Maximalversion der aktuellen Version entspricht, eine VERALTET Badge.

In allen dazwischen liegenden Versionen wird kein Badge angezeigt.

Labels verwenden

Man kann Seiten untereinander mit Labels verknüpfen und damit dafür sorgen, dass die verknüpften Hilfeartikel mit angezeigt werden.

Beispiel:

Die Seite “Test Topic” ist mit dem Label “lala” versehen.

Dieser Label ist auch im Hilfeartikel “Top-Kunden” hinterlegt.

 

Wenn nun der Hilfeartikel “Top-Kunden” angezeigt wird, erscheint auch der Artikel “Test Topic” in der Liste der Artikel.

Mit einem Klick auf “Add label” können weitere Label hinzugefügt werden

 

Hilfe manuell ausblenden (Nutzer) und wieder einblenden (Bewotec)

Wenn ein Hilfeartikel für eine Funktion angezeigt wird, hat der Nutzer die Möglichkeit die Anzeige der Hilfe abzustellen.

Ansonsten wird die Hilfe für 10 Tagen / nach 10 Aufrufen der Seite angezeigt.

Der Kunde kann den Hilfeartikel natürlich jederzeit wieder aufrufen, wenn er das Hilfepanel öffnet.

Bewotec kann einstellen, dass sich der Hilfeartikel so verhält, wie beim ersten Aufruf, in dem man eine Versionbeschränkung eingibt.

Wenn also in einer bestimmten Version maßgebliche Änderungen umgesetzt wurden, kann man aktivieren, dass die Seite beim nächsten Aufruf angezeigt wird.

Siehe Versionseinschränkung