OBS/Adminhilfe/OBS-Hilfetexte erstellen: Unterschied zwischen den Versionen

Um die Hilfe einheitlich zu gestalten sollten sich alle, die an der Hilfe Änderungen vornehmen, an die folgenden Richtlinien halten. Als eine Art Beispiel kann dieser Text selbst dienen, da er im Hilfetextstil geschrieben ist.
1. Allgemeines zur Hilfe
Das Hilfefenster ist in 4 Bereiche unterteilt: Baum, Hilfetext, Historie und Benutzerhilfe. (Bild 1)
Bild 1
Die Hilfe kann nur von Administratoren und eingetragenen Benutzern geändert bzw. bearbeitet werden. Um einen Nicht-Administrator das Editieren der Hilfe zu gestatten muss in der OBS.ini ein entsprechender Eintrag gemacht werden. Der normale Benutzer kann nur eigene Merksätze/Notizen in das Fenster unter dem sichtbaren Hilfetext eintragen (Benutzerhilfe). Auch haben wir im Hilfefenster eine Reihe von Buttons (Bild 2) mehr als andere Nutzer.
Bild 2
Eine kurze Erklärung zu jedem Einzelnen finden Sie unter Punkt 2. Tasten und Schaltflächen der Hilfe.
Alle Hilfetexte, die geschrieben wurden, werden im OBS-Ordner unter \data\HILFE\ im .rtf-Format gespeichert. Die Texte der Benutzerhilfe werden in einem Unterordner User separat gespeichert und zwar mit dem gleichen Namen, die auch der Hilfetext hat (unter F5 im Feld Form bzw. im Texteditfenster (Bild 3)
oben links zu sehen). So kann man auch leicht ohne die Hilfe aufrufen zu müssen bzw. überhaupt OBS zu starten, sehen zu welchen Texten die Benutzer eigene Notizen gemacht haben.
Bild 3
In Bild 3 sehen Sie den Hilfestarttext im Editmodus. Oben Links sehen Sie unter welchem Namen die Datei im Ordner gespeichert ist. Darunter können Sie Schriftart und Größe auswählen. Ab der Mitte etwa zum rechten Rand hin sehen Sie weitere, auch einige aus Word bekannte, Buttons zur Textverarbeitung.
Der Aufbau der Hilfe bzw. die Positionen der Zweige (Baumstruktur) und die Zuordnung der Hilfetexte wird in der Datenbank in der Tabelle xhilfe gespeichert.

2. Tasten und Schaltflächen der Hilfe
In diesem Abschnitt erhalten Sie eine kurze Erläuterung der Tasten und Schaltflächen, die Sie als Administrator in der Hilfe zur Verfügung haben. Unter 2.1 finden Sie die Buttons für das normale Hilfefenster. Diese dienen in erster Linie zum Bearbeiten des Baumes. Unter 2.2 erhalten Sie Informationen zu den Tasten und Schaltflächen, die Ihnen beim Editieren von Texten zur Verfügung stehen.
2.1 Tasten und Schaltflächen des normalen Hilfefensters

Taste/Button	Funktion
F2 Speich.	Schließt die Hilfe
F3 Druck	Ermöglicht ausdrucken des Hilfetextes bzw. der .rtf-Datei
F4 Sort	sortieren
F5 Edit	Öffnet ein kleines Editfenster, mehr dazu unter 4. Bearbeiten des Baumes
F6 Text	Öffnet das Hilfetextbearbeitungsfenster
F7 Suche	Volltextsuche
F9 Move	Hierüber können Sie die Position des Zweigs ändern; mehr unter 4. Bearbeiten des Baumes
Ret Ändern	Wählt den Hilfetext des Kindes (Child im Programmcode) aus, auf man gerade steht
Einfg Einf.	Fügt einen neuen Zweig ein
Entf Lösch.	löscht den Zweig; Sicherheitsabfrage, ob auch die .rtf (falls hinterlegt) mit gelöscht werden soll
ESC Ende	schließt die Hilfe

2.2 Tasten und Schaltflächen des Textbearbeitungsfensters

Taste/Button	Funktion
	Rückgängig bzw. Widerrufen
	Einrücken
	Textposition: Linksbündig, Zentriert, Rechtsbündig, Blocksatz
	Textformat: Fett, Kursiv, Unterstrichen
	Erstellt einen Link zu einem anderen Hilfetext
	Bieten ähnliche Funktionen wie Zeichen in Word
	Hintergrundfarbe für eine ganze Zeile
F2 Speichern	Speichert den Text ab
Pg Up/Pg Dn	überspringt im Text mehrere Zeilen
ESC Ende	Schließt das Fenster ohne Speichern

3. Bearbeiten des Baumes
3.1 Neue Zweige hinzufügen
Jeder Zweig des Baumes ist auf einer Ebene positioniert. Die erste und immer sichtbare Ebene ist Ebene 0. Möchte man einem Zweig auf Ebene 0 einen weiteren Unterpunkt, also einen Zweig oder Child/Kind auf Ebene 1 hinzufügen, drücken Sie Einfg. Daraufhin öffnet sich das Fenster Hilfe-Eintrag (Bild 4). Um eine Neue Root-Ebene bzw. Wurzel (Ebene 0) zu erstellen haben Sie in diesem Fenster die Möglichkeit mit F3 den Vorgänger entsprechend zu leeren. Die Ebene wird dann von x auf 0 gesetzt und die Order angepasst.
Bild 4
Hier können Sie einen Titel, später der sichtbare Name des Zweiges und eine Form hinterlegen. Ein Titel ist dabei Pflicht. Das Feld Form ist die Angabe des Hilfetextes (Name des Formulars in Großbuchstaben, z. B. RECHNUNG), welcher sich öffnen soll, wenn dieser Zweig ausgewählt wird. Existiert ein Hilfetext zu einer Form noch nicht, können Sie, wenn Sie das entsprechende Fenster geöffnet haben, F1 drücken. Daraufhin wird sich die Hilfe mit dem Starteintrag öffnen und in der untersten Leiste der Name der Form angezeigt (Beispiel Bild 5).
Bild 5
Gehen Sie danach an die Stelle, an die der Hilfeeintrag später zu finden sein soll und drücken Einfg. Daraufhin wird sich das gleiche Fenster wie in Bild 4 öffnen. Der Unterschied besteht hier jetzt darin, dass der Name der Form mit übernommen wurde (Bild 6). So sehen Sie hier FRMANGEBOT in Form schon vorgetragen. Zusätzlich haben Sie auch immer den unteren Teil der Eingabemaske, der Ihnen Informationen zum Vorgänger (hier Liste) mit der UID (x_uid in Tabelle xhilfe). Unter dem Vorgänger finden Sie links das Feld Order. Dies zeigt Ihnen an welcher Position auf der Ebene sich der Zweig befindet. In der Mitte steht die UID für den Zweig, den Sie jetzt anlegen. Rechts steht die Ebene, auf der sich der Zweig dann befinden wird.
Bild 6
Den Vorgänger können Sie über dieses Fenster nicht ändern (auch wenn es so aussieht). Nutzen Sie zum Verschieben des Zweiges die Move-Funktion (Abschnitt 3.2 Verschieben von Zweigen). 3.2 Verschieben von Zweigen
Wenn Sie einen Zweig an eine andere Position im Hilfebaum schieben möchten, wählen Sie F9. Daraufhin öffnet sich eine Selectliste in der Sie die Wahl zwischen folgenden Optionen wählen:
oben: Verschiebt den Zweig eine Position in der Ebene nach oben.
unten: Verschiebt den Zweig eine Position in der Eben nach unten.
verschieben: Verschiebt den Zweig auf eine andere Position ggf. auch andere Ebene. Vor dem Verschieben werden Sie zu Sicherheit noch einmal gefragt, ob Sie die Ebene wirklich mit allen Kindern verschieben möchten. Antworten Sie mit Ja, wenn Sie die Ebene verschieben möchten. Danach öffnet sich das Hilfefenster ein weiteres Mal und Sie können die Position im Baum mit Tastatur oder Maus auswählen. Gehen Sie dazu auch den Zweig, an den die zu verschiebende Struktur angehängt werden soll und drücken F2.
Wurzel: Macht aus der ausgewählten Ebene eine Root-Ebene oder Wurzel. Das heißt die Ebene wird auf Ebene 0 gesetzt
4. Erstellen und bearbeiten von Hilfetexten
Um einen Hilfetext erstellen bzw. bearbeiten zu können müssen Sie sich auf dem Zweig eine Form hinterlegt sein. Wenn dies der Fall ist, wird Ihnen bei der Auswahl des Zweigs der Text angezeigt oder das Fenster wird weiß. Drücken Sie dann F6, um in das Bearbeitungsfenster zu gelangen.
Die Überschrift sollte nach Möglichkeit genauso lauten, wie der Titel des Zweigs. Bei Erklärungen von Buttons z. B. kann dies auch abweichen. Taucht als Titel im Zweig z. B. F7 Prio. auf, so können Sie als Textüberschrift auch F7 Priorität ausschreiben.
4.1 Textformat
Die Hilfe wird in der Schriftart Arial geschrieben. Die Schriftgröße ist 12. Einzig die Textüberschrift ist größer und wird in der Größe 20 gehalten. Der Text beginnt in der dritten Zeile unter der Überschrift. Wird innerhalb des Textes eine Unterteilung mit Überschriften geplant, sind zwei Zeilen Abstand zum vorhergehenden Text zu halten und eine Zeile zum Folgenden. Die Überschrift ist dann zu Unterschreichen. Falls Sie weitere Unterpunkte planen, z. B. 1.1. wird ebenfalls zwei Zeilen Abstand zum vorangegangenen Text gehalten und eine zum Folgenden. Die Texte sind zudem rechtsbündig

 Beispiel:

 1. Beispiel
......

 1.1 Was ist zu Beachten?
......

 2. Ende Beispiel
...

Hinweis: Im Editfenster funktionieren die Wordtastenkombinationen ( z. B. Strg+Shift ⇧+F für Fettdruck) nicht.

Kopieren (Strg+C)
Ausschneiden (Strg+X)
Einfügen (Strg+V)

ist möglich.

4.2 Überschriften
Die Überschrift ist in Größe 20 zu schreiben und mittig/zentriert zu setzten. Zusätzlich wird die Überschrift durch eine Grauschattierung hervorgehoben. Von weiteren Hervorhebungen (Fettdruck etc.) ist abzusehen. Die Schattierung finden Sie unter dem Button Datei:ADMINHILFEERSTELLEN 14.jpg. Auf die folgende Frage wird mit Nein geantwortet. Danach in den Grundfarben den Grauton in der untersten Reihe dritte von rechts auswählen und mit OK bestätigen.
4.3 Platzhalter veranschaulichen
Wenn Sie z. B. die Möglichkeiten von neuen Platzhaltern durch Text veranschaulichen möchten (Aussehen im Brief o. ä.) diesen bitte in Kursivschrift und einem Absatz etwas vom Hilfetext abheben. In etwa so:
... „Hallo #VORNAME #NAME" würde dann in OBS wie folgt aussehen:
Hallo Max Mustermann
4.4 Editfenster und Selectlisten
Beim Erklären von Editfenstern und Selectlisten gehen Sie vor wie unter 3.2 (dort wurden die Möglichkeiten einer Selectliste näher erläutert). Zählen Sie dazu alle Felder bzw. Optionen in Fettdruck auf und geben zu jedem Punkt eine kurze Erläuterung (z. B. Was passiert, wenn das Feld VK1 = 0 in einer Artikelauswertung markiert ist?). Falls ein Feldname im Text erwähnt wird (wie im Satz zuvor), wird dies mit gekennzeichnet.
4.5 Auswahlfelder
Wenn Sie die verschiedenen Optionen von Auswahlfeldern nennen möchten, z. B. bei den Sortiermöglichkeiten von Auswertungen, werden diese einmal eingerückt untereinander aufgelistet. Dies könnte dann z. B. so aussehen:
...Folgende Auswahlmöglichkeiten stehen Ihnen dabei zur Verfügung:

Pers.-Nr.
Name
Vorname
PLZ
Ort

Geben Sie dabei den korrekten Wortlaut der Auswahlmöglichkeiten an.
4.6 Hinweise und Zusätzliches
Falls Sie noch etwas Wichtiges zu sagen haben, was zwar noch beim Bearbeiten zu beachten, aber nicht direkt mit dem Text zu Verbinden ist, können Sie dies durch: Hinweis: und Achtung! verdeutlichen.
Achtung! Bitte übertreiben Sie es nicht mit Hinweisen u. ä. in Ihren Texten. Versuchen Sie möglichst viel im Text zu erklären und Hinweise kurz zu halten. Auch reicht es hinter Achtung ein ! zu schreiben und nicht eine Zeile.
4.7 Links
Über den Button [Link] können Sie aus einem markierten Text einen Link zu einem anderen Hilfetext erstellen. Bedenken Sie dabei, dass Sie nur einen Zweig auswählen können, dem auch ein Textfile hinterlegt ist. Wenn Sie z. B. eine Liste erklären, die mehrere Drucklisten hat, und einen Link zu allen Drucken im Text haben möchten (z. B. Eine Erklärung der Drucke finden Sie hier.), wählen Sie den ersten Druck in der Liste aus.
Um einen Link zu erstellen, markieren Sie das entsprechende Wort oder den Satz. Drücken Sie danach den Button [Link]. Es öffnet sich ein weiteres Hilfefenster. In diesem Fenster gehen Sie nun über den Baum zu dem Hilfefile, zu dem der Link führen soll. Wenn Sie auf dem Zweig stehen, speichern Sie die Verlinkung mit F2. Danach werden Sie wieder in Ihrem Textbearbeitungsfenster landen und das Wort oder der Satz wird blau hervorgehoben sein.
5. Hervorhebungen, Tabellen, Zeichen und Bilder in Hilfetexten
5.1 Hervorhebungen
Wie Sie sicher schon im Verlauf des Textes gesehen haben, sollten Buttons und Schaltflächen wie F3 fett hervorgehoben werden.
Wenn Sie im Text ein Wort verdeutlichen möchten oder es betont werden soll, wird das Wort nicht fett gedruckt sondern nur unterstrichen.
5.2 Tabellen
Tabellen können Sie im Editfenster nicht erstellen und müssen deshalb aus Word oder einem andern Textverarbeitungsprogramm kopiert werden. Überlegen Sie darum vorher genau wie viele Spalten Sie benötigen. Die andere Möglichkeit wäre Sie füllen die erstellte Tabelle in Word aus und kopieren sie dann mit Inhalt.
5.3 Zeichen
Um einen Weg im Menü zu Beschreiben werden die Menüpunkte durch das Zeichen „→ "(zu finden in der Zeichentabelle unter Windows Start → Programme → Zubehör Systemprogramme → Zeichentabelle) getrennt.
Die Zeichen„ ←→↑↓ "werden für die Pfeiltasten (z. B. [←]) verwendet.
Return wird mit ↵ dargestellt und Tab mit ↔.
Hinweis: Die Zeichen können sie nicht über die Schriftartauswahl in OBS einfügen, weil die Formatierung beim Speichern verloren geht und beim nächsten Aufrufen des Textes irgendwelche Zeichen eingesetzt wurden. Deshalb müssen die Zeichen aus der Zeichentabelle kopiert werden. Zum Kopieren der Zeichen muss der Button [Kopieren] verwendet werden, da es mit der Tastenkombination Strg+C in dem Fenster nicht funktioniert. Einfügen können Sie die kopierten Zeichen in den OBS-Hilfetext aber ganz normal mit Strg+V.
Die wichtigsten Zeichen einmal in der Übersicht:

Zeichen	Zeichencode	Schriftart
→	0xD2	Wingdings 3
↵	0x38	Wingdings 3
←	0xD9	Wingdings 3
→	0xDA	Wingdings 3
↑	0xDB	Wingdings 3
↓	0xDC	Wingdings 3
↔	0x46	Wingdings 3

5.4 Bilder
Die Anzahl an Bildern in Hilfetexten sollte möglichst gering gehalten werden, da .rtf nicht das beste Format zum Speichern von Bilddateien ist. Wenn z. B. ein Listendruck veranschaulicht werden soll, ist es besser eine Tabelle ohne Ränder (vorher über Rahmen und Schattierungen ausblenden) mit entsprechender Spaltenzahl zu kopieren und das aussehen der Liste in etwa versuchen darzustellen. Zudem wird so der Speicherbedarf für eine Datei gering gehalten. Was z. B. bei einem Update durchaus wichtig sein kann. Wenn Sie mehrere Bilder in einem Text haben und gerne explizit auf eins hinweisen möchten, können Sie die Bilder auch Nummerieren oder Namen geben. Da im Editfenster keine Bildbeschriftung möglich ist schreiben Sie den Namen oder Bezeichnung in Arial, Fett und in Schriftgröße 8 unter das Bild.

@@ Zeile 169: / Zeile 169: @@
 <br />
 .4 Bilder<br />
-Die Anzahl an Bildern in Hilfetexten sollte möglichst gering gehalten werden, da .rtf nicht das beste Format zum Speichern von Bilddateien ist. Wenn z. B. ein Listendruck veranschaulicht werden soll, ist es besser eine Tabelle ohne Ränder (vorher über Rahmen und Schattierungen ausblenden) mit entsprechender Spalten zahl zu kopieren und das aussehen der Liste in etwa versuchen darzustellen. Zudem wird so der Speicherbedarf für eine Datei gering gehalten. Was z. B. bei einem Update durchaus wichtig sein kann. Wenn Sie mehrere Bilder in einem Text haben und gerne explizit auf eins hinweisen möchten, können Sie die Bilder auch Nummerieren oder Namen geben. Da im Editfenster keine Bildbeschriftung möglich ist schreiben Sie den Namen oder Bezeichnung in Arial, Fett und in Schriftgröße 8 unter das Bild.
+Die Anzahl an Bildern in Hilfetexten sollte möglichst gering gehalten werden, da .rtf nicht das beste Format zum Speichern von Bilddateien ist. Wenn z. B. ein Listendruck veranschaulicht werden soll, ist es besser eine Tabelle ohne Ränder (vorher über Rahmen und Schattierungen ausblenden) mit entsprechender Spaltenzahl zu kopieren und das aussehen der Liste in etwa versuchen darzustellen. Zudem wird so der Speicherbedarf für eine Datei gering gehalten. Was z. B. bei einem Update durchaus wichtig sein kann. Wenn Sie mehrere Bilder in einem Text haben und gerne explizit auf eins hinweisen möchten, können Sie die Bilder auch Nummerieren oder Namen geben. Da im Editfenster keine Bildbeschriftung möglich ist schreiben Sie den Namen oder Bezeichnung in Arial, Fett und in Schriftgröße 8 unter das Bild.
 </div>[[Category:html]]
 ----

OBS/Adminhilfe/OBS-Hilfetexte erstellen: Unterschied zwischen den Versionen

Version vom 5. September 2016, 14:02 Uhr

Navigationsmenü

Suche