Overview of the user functions

Darstellung einer Beispielfunktion mit einem kurzen Merksatz.

Diese Funktion mit dem Namen Beispiel zeigt, wie die Funktionsbeschreibungen aufgebaut sind.

In dem Kasten steht links der Funktionsnamen, wie er im Moskito vergeben ist und rechts in eckigen Klammern steht das zugehörige dreibuchstabige Kürzel für die Eingabe über die Tastatur. Bei Funktionen, die auch schon in Gradis-Systemen eingesetzt wurden, entspricht dieser Ausdruck der Gradis-Abkürzung.

Nach dem Kasten folgt ein Merksatz, der eine kurze Funktionsbeschreibung darstellt. Dieser Satz stellt eine Unterstützung dar, die helfen soll die Funktionsnamen transparenter zu machen.

In dem Abschnitt Voraussetzung werden Bedingungen aufgezählt, die notwendig sind, damit die Funktion ihre Aufgabe korrekt erfüllt.

Der Abschnitt Parameter beschreibt alle Parameter und Schalter, die im Zusammenhang mit der Funktion einzusetzen sind. Zu jedem Parameter und Schalter gehört eine Beschreibung die das Verhalten aufzeigt.

Der Abschnitt Rückgabewert enthält Angaben zu dem Rückgabewert, den die Funktion nach Beendigung liefert.

Der Abschnitt Dialog enthält die Meldungen, die im Programmverlauf erscheinen. Zu jeder Meldung erfolgt eine Beschreibung, die erklärt, wie auf die Meldung reagiert werden muß.

Sind Besonderheiten zu beachten, die nicht zu den Voraussetzungen gehören, so stehen diese in dem Abschnitt Bemerkungen. Die Bemerkungen, enthalten zusätzliche Hinweise, die das Verhalten der Funktion erklären.

Der letzte Abschnitt zu der Funktionsbeschreibung ist eine Auflistung von Beispiel-Aufrufen. Diese Beispiele zeigen, wie die Funktion zu verwendet ist, wie Parameter und Schalter einzusetzen sind und welche Dialoge und Meldung erscheinen. Diese Beispiele sind so gewählt, dass sie die gebräuchlichsten Aufrufe zeigen.

Voraussetzung

In diesem Beispiel gibt es keine Voraussetzungen

Parameter

Parameter/1

Hier steht, falls vorhanden die Beschreibung des Parameters 1 der Funktion Beispiel. Dieser Parameter wird über den Namen „Parameter“ identifiziert und übergibt den Wert 1.

/Parameter2

Hier würde die nächste Parameterbeschreibung stehen. Dieser Parameter ist im Gegensatz zum Parameter 1, ein Parameter, der keinen Wert übergibt, sondern als Schalter dient. Wird dieser Parameter so aufgerufen, gilt er als „eingeschaltet“.

Rückgabewert

Dialog

Dies ist eine Dialogmeldung

Hier werden die Meldungen beschrieben, die in einem Dialog vorkommen.

Beispiel

1. Beispiel

Hier ist die Beschreibung eines Beispielaufrufs der Funktion.

Bemerkung

Zu diesem Beispiel gibt es keine weiteren Bemerkungen.

Siehe auch

Hier sind andere Funktionen aufgeführt, die eine ähnliche Funktionsweise oder zur Arbeitsvorbereitung oder zur Nachbearbeitung dienen können.

--------------------OLD_TEXT---------------------

Representation of an example function with a short maxim.

This function with the name Example shows how the functional descriptions are built up.

In the box stands to the left of the functional names how he is awarded in the Moskito and on the right in angular clips the accompanying dreibuchstabige abbreviation stands for the input over the keyboard. With the functions which were already used in Gradis systems corresponds this expression of the Gradis abbreviation.

After the box follows a maxim which shows a short functional description. This sentence shows a support which should help the functional names more clear to make.

In the segment Condition conditions are enumerated which are necessary, so that the function fulfils her job correctly.

The segment Parametre describes all parametres and counters which are to be used in connection with the function. A description hears to every parametre and counter them the behaviour indicates.

The segment Return value contains information to the return value which the function delivers after ending.

The segment Dialogue contains the announcements which appear in the program course. To every announcement occurs a description which explains how must be reacted to the announcement.

If specific features are to be followed which do not belong to the conditions, these stand in the segment Remarks. The remarks, the additional tips which explain the behaviour of the function contain.

The last segment to the functional description is a listing of example calls. These examples show how the function is too used, as parametres and counters are to be used and which dialogues and announcement appear. These examples are so chosen that they show the most common calls.

Condition

In this example there are no conditions

Parametre

Parametre / 1

Here stands, if available the description of the parametre 1 of the function example. This parametre is identified about the name "Parametre" and hands over the value 1.

/Parameter2

Here the next parametre description would stand. This parametre is in contrast to the parametre 1, a parametre which hands over no value, but serves as a counter. If this parametre is called in such a way, he is valid as "switched on".

Return value

Dialogue

This is a dialogue announcement

Here the announcements which seem in a dialogue are described.

Example

1. Example

Here is the description of an example call of the function.

Remark

To this example there are no other remarks.

See also

Here the other functions which can serve a similar functionality or for the working preparation or to the postprocessing are performed.