Feldhilfe
In der Datenbank werden als HTML-Texte zu jedem Feld der Software Hilfetexte gespeichert. Diese können mithilfe der hier beschriebenen Funktion erfasst werden. Solche Hilfen sind durch ein Schlüsselwort und einen Sprachcode charakterisiert. Mit der entsprechenden Rubrik im Maskendictionary wird dem Maskenfeld das Schlüsselwort zugeordnet.
Die Hilfe wird anschließend mit einer speziellen Ausgabefunktion auf der Festplatte generiert und in einem Unterverzeichnis namens FLD abgelegt. Aber wenn die Maske, auf der sich das dokumentierte Feld befindet, einem Absatz Funktionshilfe zugeordnet ist, wird die Feldhilfe auch in die Funktionshilfe integriert.
Aus dem in den Absätzen der Funktionshilfe definierten Mascencode steht per Zoom eine Aktualisierungsfunktion für die Schlüsselwörter der betreffenden Maske direkt zur Verfügung.
Vorbedingungen
Siehe Dokumentation Umsetzung
Maskenverwaltung
Erfassungsmaske
Übersicht
Neben dem Sprachcode und dem Dokumentcode befindet sich in dieser Maske ein Block, in dem in einem HTML-Editor der Hilfetext erfasst werden kann. Die Verwendung dieses Editors ist in einem Anhangdokument beschrieben.
Schließen
Felder
In diesem Register befinden sich die folgenden Felder :
Eigenschaften
| Definiert die Sprache, in der ein Text erstellt wird. |
| Dieser Code identifiziert eindeutig die erstellten Datensätze. |
| Zugehörigkeitsmodul des Dokumentationsparagraphs. |
| Ist diese Option markiert, wird die Hilfe als generisch angesehen. D.h., dass sie in anderen Masken, als derjenigen für die sie ursprünglich erzeugt wurde, größer wieder verwendet werden kann Eine für die Auswahl vorgesehene Funktion ermöglicht die Auswahl der generischen Hilfen. |
|
|
| Diese Felder ermöglichen die Anzeige der Gruppe, die die betroffene Dokumentation erstellt hat. Sie ist nur in den Umgebungen verfügbar, in denen dieser Begriff implementiert wurde. Das betrifft die Umgebungen, in denen der Benutzerparameter GRPDEV vorhanden ist. Hinweis: Die Gruppe wird in rot angezeigt, wenn die Benutzergruppe sich von der Erstellergruppe in der Tabelle AOBJGRPDEV unterscheidet. |
Link
|
|
Hilfetext
| Dieses Feld ermöglicht die Erfassung des Feldhilfentextes, wie er beim Aufruf der Hilfe erscheint und wie er in der Funktionsdokumentation eingefügt wird, die sich auf die Maske, auf der die Hilfe verwendet wird, bezieht. |
Schließen
Berichte
Standardmäßig sind der Funktion folgende Reports zugeordnet :
ADOCFLD : Feldhilfen
Dies kann durch geeignete Parameter geändert werden.
Spezielle Buttons
Im über diese Schaltfläche geöffneten Fenster befinden sich die folgenden Felder: : Blocknummer 1
Blocknummer 2
Schließen in einen anderen Ordner .Fehlermeldungen |
Menüleiste
Option / Aktionen / Kopie Dokumentation
Kopie der Hilfe in einen anderen Ordner auf allgemeinere Weise als mit dem entsprechenden Button. Es können hier Bereiche für Batchkopien vorgegeben werden. Die möglichen Syntaxen zur Definition eines Ordners werden in einer Anhangdokumentation beschrieben.
Option / Aktionen / Priorität Übersetzung
Definition einer Priorisierung bei der Dokumentationsübersetzung.
Option / Aktionen / Löschen Dokum. alle Sprachen
Löschen der Feldhilfe in allen vorhandenen Sprachen. Es wird ein Bestätigungsfenster geöffnet, und wenn eine positive Antwort gegeben wird, ist der Vorgang unwiderruflich.
Option / Prüfungen / Nicht verwendete Hilfen
Allgemeine Suche in Maskendictionary nach Feldhilfen, die in keiner Maske verwendet werden. Die Liste wird als Protokolldatei angezeigt.
Option / Prüfungen / Fehlende Hilfen
Allgemeine Suche im Maskendictionary nach Feldhilfen, zu denen kein Schlüsselwort vorgegeben wurde oder zu denen das referenzierte Schlüsselwort keiner vorhandenen Feldhilfe entspricht. Die Liste wird als Protokolldatei angezeigt.
Option / Prüfungen / Leeren nicht verwendete Hilfen
Option / Verwendungen
In einem Auswahlfenster werden die Masken angezeigt, in denen die aktuelle Feldhilfe verwendet wird.