Bedienerhilfe editieren

Mit dem Hilfeeditor können Sie Hilfetexte verfassen und formatieren, Bilder, Tabellen und Aufzählungen einfügen und Handbücher verlinken. Diese Schnellhilfe erläutert die Symbolleiste, im Speziellen die Tabellenfunktionen und die Funktion des Kontextmenüs, welches über einen Rechtsklick auf den Editor erscheint. Für weitere Informationen und Erläuterungen können Sie im Handbuch Bedienerhilfesystem nachschlagen.


Die Symbolleiste

  • Durch Klick auf wird der Fettschriftmodus ein- bzw. ausgeschaltet. Wenn ein Bereich markiert war, wird der Bereich in Fettschrift angezeigt
  • Durch Klick auf wird der Kursivschriftmodus ein- bzw. ausgeschaltet. Wenn ein Bereich markiert war, wird der Bereich in Kursivschrift angezeigt
  • Durch Klick auf wird der Unterstrichen- Modus ein- bzw. ausgeschaltet. Wenn ein Bereich markiert war, wird der Bereich unterstrichen
  • Durch Klick auf wird die Verwendung einer äquidistanten Schrift ein- bzw. ausgeschaltet. Wenn ein Bereich markiert war, wird der Bereich in gleich breiten Buchstaben dargestellt
  • Durch Klick auf wird ein Farbauswahl-Dialog angezeigt, mit dem die aktuelle Schriftfarbe gesetzt werden kann. Wenn ein Bereich markiert war, wird dieser in der gewählten Farbe dargestellt
  • Durch Klick auf wird eine nummerierte Liste begonnen und das erste Listenelement angelegt. Das Eingabeverhalten entspricht dem bekannter Textverarbeitungsprogramme: Mit RETURN wird das aktuelle Listenelement beendet und ein neues Listenelement angefangen. Mit SHIFT+RETURN wird eine neue Zeile innerhalb des aktuellen Listenelements (explizit) begonnen. Ein Listenelement wird gelöscht, indem der gesamte Textinhalt des Abschnitts gelöscht und die Taste Backspace gedrückt wird
  • Durch Klick auf wird eine nicht nummerierte Liste begonnen und das erste Listenelement angelegt. Das Eingabeverhalten ist analog zu nummerierten Listen
  • Durch Klick auf oder wird das aktuelle Textelement (Paragraph, Listenelement, Tabellenzelle etc.) nach rechts eingerückt, bzw. die Einrückung reduziert
  • Bei Klick auf wird ein Datei-Auswahl-Dialog angezeigt. Es können Bilddateien im GIF- JPEG oder PNG-Format ausgewählt werden. Diese Bilder werden nach Auswahl zentral archiviert und an der aktuellen Position des Eingabecursors eingefügt
  • Mit können bestimmte Bilder, welche in mehreren Hilfetexten verwendet werden (Aktivierte und Inaktivierte Checkboxen, Radiobuttons etc.), aus einem speziellen Verzeichnis des Bedienerhilfearchivs und mittels Auswahldialog in den Hilfetext eingefügt werden. Im Unterschied zu „Bild einfügen“ findet dabei kein Upload ins Archiv statt. Es können nur Bilder aus dem Verzeichnis „pictures“ des Hilfetextarchivs ausgewählt werden. Soll ein Bild zu einem wieder verwendbaren Bild gemacht werden -> Hilfetextframeworkadministrator kontaktieren
  • Bei Klick auf wird ein kleiner Dialog angezeigt, mit dessen Hilfe die Anzahl der Spalten und Zeilen angegeben werden. Nach Klick auf „O.K.“ wird die Tabelle an der aktuellen Position des Cursors eingefügt. Dabei ist der Tabellenrahmen aktiviert. Bitte beachten Sie das Kapitel „Arbeiten mit Tabellen“
  • Bei Klick auf werden die expliziten Zeilenenden (meist durch SHIFT + RETURN eingegeben) durch das bekannte Endesymbol angezeigt. Dieses Symbol dient nur als Orientierungshilfe und wird nicht mit abgespeichert
  • Das Feature darf nur von Benutzern verwendet werden, die HTML-Quelltext verstehen, programmieren können und sich den Konsequenzen ihres Tuns bewusst sind. Bei Klick auf diesen Button wird der Quelltext angezeigt. Dieser kann (vorsichtig) direkt modifiziert werden. Dabei sind die oben beschriebenen Einschränkungen bei der Manipulation von Objekten der Bedienerhilfetexte nicht aktiv. Nach erneutem Klick auf den Button kehrt der Editor in den WYSIWYG-Modus zurück. Im HTML-Quelltext-Modus darf der Hilfetext nicht abgespeichert werden
  • Ist der Haken der Checkbox gesetzt, so wird der Inhalt der Zwischenablage als reiner Plaintext bei einer Paste-Aktion eingefügt. D.h. eventuell enthaltene Metainformationen (Formatierung, Struktur, Tabelle, Liste etc.) werden ignoriert. Ist der Haken nicht gesetzt, wird, soweit möglich und mit HTML kompatibel, Formatierung und Strukturierung des Textes der Zwischenablage beachtet. Diese Funktion ist vor allem im Hinblick auf Einfügen kopierter Texte aus externen Anwendungen (Word, Notes, Eclipse, …) sinnvoll

Arbeiten mit Tabellen

  • Um mit einer Tabelle arbeiten zu können, muss diese selektiert sein. Dazu klickt man oder bewegt den Cursor auf eine Zelle der Tabelle und drückt die rechte Maustaste. Es erscheint ein Kontextmenü, mit dem Eigenschaften der Tabelle modifiziert werden können. Dabei ist relevant, in welcher Tabellenzelle sich der Eingabecursor befindet. Relativ zu dieser Zelle können Zeilen oberhalb oder unterhalb und Spalten rechts oder links eingegeben werden

  • Außerdem kann der Rahmen der Tabelle ein- und ausgeblendet werden. Es wird empfohlen den Tabellenrahmen in der Editierphase als Orientierungsunterstützung zu verwenden und ihn vor Abspeichern des Hilfetextes auszublenden
  • Es sind keine Tastatureingaben erlaubt, die die Struktur der Tabelle (Zellen / Spalten) beeinflussen. Wird in einer Tabellenzeile gelöscht, so führt dies nicht zur Löschung der Zelle oder Zeile. Einzelne Zellen können nicht gelöscht werden, nur komplette Spalten oder Zeilen. Eine vom Benutzer angelegte Tabelle kann gelöscht werden, indem sie vollständig markiert wird und Backspace (oder Del) gedrückt wird. Oder indem alle Zeilen oder Spalten entfernt werden (trivial)

Hinweis

Weitere Informationen der einzelnen Kontextmenüpunkte entnehmen Sie bitte dem Handbuch "Bedienerhilfesystem"

Aufbau einer Hilfedatei


    • Jede Hilfedatei besteht immer aus einer Überschrift (dem Titel), und einem Beschreibungstext (dem eigentlichen Inhalt, der normalerweise aus 1-5 Sätzen besteht – je nach Hilfetyp -):
    • Der Erfasser ist frei, das Dokument insoweit zu erweitern, dass
      - Weitere Themen („Zusatzinformationen“) ,
      - Weitere Anleitungen („step by step“),
      - Farblich hervorgehobene Hinweise und
      - Handbücherlinks verfügbar sind.
    • Zusätzlich können weitere Elemente auftauchen:

      - „ Outline “-Markierung: der Bereich, der für die Darstellung im Hilfegadget optimiert ist (i.d.R. die Überschrift und die Beschreibung). Weitere Kapitel außerhalb dieser Markierung werden nicht angezeigt


      - Inhaltsverzeichnis-Markierung: Ein Platzhalter, an dem clientseitig ein Inhaltsverzeichnis bei Anzeige hineingeneriert wird. Dies betrifft allerdings nur Programmhilfen und Panelhilfen. Diese kann bei Bedarf gelöscht werden, indem sie markiert und ENTF gedrückt wird:

Hinweis

Die Reihenfolge der Abschnitte ist entscheidend für die Erstellung eines Inhaltsverzeichnisses – sollten Abschnitte untereinander gemischt werden, kann kein ordentliches Inhaltsverzeichnis erstellt werden. Daher nach Erfassung auch die Anzeige überprüfen!

    • Folgende Reihenfolge der Abschnitte sollte eingehalten werden:
      - Überschrift (1x)
      - Beschreibung (1x)
      - Thema (0-n x)
      - Anleitung (0-n x)
      - Handbücher-Verweise (0-n x)

Hinweis

Ein Hinweis kann überall eingesetzt werden, und ist für das Inhaltsverzeichnis nicht relevant.

    • Um ein Dokument zu erweitern, sollte per Rechtsklick auf den Editor eine Auswahl im Kontextmenu angeklickt werden. Dabei ist es wichtig, wo der Rechtsklick zum Aufruf des Kontextmenus platziert wird. Es wird empfohlen, in die letzte Zeile eines Abschnittes den Rechtsklick zu machen, damit die korrekte Position im Dokument ermittelt werden kann. Die Logik versucht, immer nach dem rechtsgeklickten Abschnitt den neuen Baustein einzufügen. Unter Umständen wird ein Abschnitt allerdings innerhalb eines anderen Abschnittes platziert – was für Hinweise völlig in Ordnung ist – kann aber mit STRG+Z (eventuell mehrmals) rückgängig gemacht werden
    • Weiterhin sollte erst nach der Beschreibung bzw. – wenn vorhanden – nach dem Inhaltsverzeichnis damit begonnen werden, über das Kontextmenu Einträge zu erzeugen

      Nach der Erstellung des Abschnittes ist der Cursor korrekt positioniert, und mit der Erfassung von Text kann begonnen werden

Hinweis

Um bei der Erfassung eines Textes, der zu einem Abschnitt wie z.B. „Thema“ gehört, einen Zeilenumbruch zu machen, empfiehlt sich Shift+Enter anstatt nur Enter zu drücken. Enter führt normalerweise einen neuen Abschnitt ein, und übernimmt die vorhergehende „Klasse“.

    • Thema einfügen
      Fügt eine Ergänzung ein, die ein spezielles Thema aufgreift. Besteht aus einer Überschrift (die man über den Popup eingibt) und dem (unformatierten) Textinhalt. Nach dem Einfügen kann mit dem Eintippen direkt begonnen werden.
    • Anleitung einfügen
      Fügt eine Ergänzung in der Form einer Step-by-Step- Anleitung ein. Erhält ebenso eine Überschrift (Popupmenu); nach der Eingabe können die Punkte definiert werden. Zum Einfügen eines neuen Punktes kann einfach Enter gedrückt werden. Zusätzlich wird ein Platzhalter für das Ergebnis eingefügt (der gelöscht oder ausgefüllt werden kann).
    • Hinweis einfügen
      Ein Hinweis besteht aus einer (maschinell erstellten) Überschrift „Hinweis“ und dem speziell formatierten Text. Nach dem Einfügen kann direkt der Eingabe begonnen werden.

Hinweis

Der Hinweis (den Block, den Sie gerade lesen) ist ein Inline-Block. D.h. er kann sich auch innerhalb eines Abschnittes wie z.B. Thema befinden. Möchte man mit der Eingabe normalen Textes, der z.B. zum Thema gehört, nach dem Einfügen eines Hinweises fortfahren, so darf der Hinweis nicht an das Ende gesetzt werden! Tipp: in die vorletzte Zeile einfügen, Hinweistext erfassen, dann Text drumherum korrigieren

    • Handbuch verlinken
      Nach Klick auf „Handbuch verlinken“ werden alle verfügbaren Handbücher ermittelt, und diejenigen, die bereits im Dokument angegeben sind. Der Erfasser hat dann in einem Popup die Möglichkeit, weitere Handbücher an- bzw. bisher angegebene Handbücher abzuwählen. Drückt er auf OK, dann werden automatisch Links in das Dokument hineingeneriert, und der Hilfebetrachter kann per Klick auf einen Link das Handbuch im Client öffnen.

Hinweis

Die Handbücher sollten an das Ende des Dokuments erstellt werden. [Außerdem muss für diese Funktion serverseitig der http-Server so konfiguriert sein, dass der Zugriff auf die Handbücher funktioniert]

Handbücher

  • Keine Stichwörter