Programmfunktion: Unterschied zwischen den Versionen

Version vom 10. Januar 2023, 15:08 Uhr

Programmfunktion und Daten

Eine Programmfunktion berechnet aus einer Eingabe (beschrieben durch "Ausgangssituation") eine Ausgabe (beschrieben durch "Ergebnis").

Steuerdaten(beschrieben durch "Parametrierung") sind Daten, die von der Programmfunktion ausschließlich lesend verwendet werden und die für viele Aufrufe der Funktion gleich sind.

Ändert eine Programmfunktion die Alex^®-Daten, ist das eine Transition. Solange die Transition nicht abgespeichert ist,

kann sie rückgängig gemacht werden.
sind die von ihr geänderten Daten gesperrt, damit keine gleichzeitige Änderung in anderen Sitzungen möglich ist.

Es können beliebig viele Transitionen durchgeführt werden, bevor abgespeichert wird. Nach dem Speichern sind die Änderungen in anderen Sitzungen sichtbar.

Ändert die Programmfunktion keine Daten, da sie ausschließlich eine Ansicht berechnet, ist das eine Anzeigefunktion.

Wird im Alex^®Wiki von einer Funktion oder Programmfunktion gesprochen, ist stets eine Transition gemeint. Ist eine Anzeigefunktion gemeint, wird das ausdrücklich ausgeschrieben.

Struktur eines Artikels für Programmfunktion

Abstract
Überschrift (==): Aufruf der Funktion (optional)
Überschrift (==): Funktionsbeschreibung
- Unterüberschrift1 (===): Unterschritt1
  - Unterüberschrift2 (====): Unterschritt1.1
  - Unterüberschrift2 (====): Unterschritt1.2...
- Unterüberschrift1 (===) Unterschritt2..
Überschrift (==): Parametrierungsrichtlinien

Überschrift (==): Beispiele (siehe unten)
Unterüberschrift1 (===): Beispieltitel1 + Absatz Einleitung
- Unterüberschrift2 (====): Ausgangssituation Bild + Beschreibung
- Unterüberschrift2 (====): Parametrierung Bild + Beschreibung
- Unterüberschrift2 (====): Ergebnis Bild + Beschreibung
- Unterüberschrift2 (====): Datenbank für Beispiel 1 Link zu DokuDB mit beschriebener Situation + Parametrierung
Unterüberschrift1 (===) Beispieltitel2 ...

Überschrift (==): Bit Factory interne Zusatzinfos<- wenn nötig
- Link zu interner Seite "Aktivierung" für Beschreibung von Configfile Einstellungen, wenn diese für dieses Beispiel benötigt werden ("Intern:")
- Issues: (falls per Fussnoten Issues verlinkt wurden)

Wenn zu viele Beispiele, dann je Beispiel eine eigene Wiki-Seite und bei der Hauptseite nur die Links dorthin einbinden.

Struktur der Beispiel-Seite (Name der Seite = Funktionsname/Beispiel Beispielname):

Abstract mit Link zur Seite der Programmfunktion

Unterüberschrift1 (===): Beispieltitel + Absatz Einleitung

Unterüberschrift2 (====): Ausgangssituation Bild + Beschreibung
Unterüberschrift2 (====): Parametrierung Bild + Beschreibung
Unterüberschrift2 (====): Ergebnis Bild + Beschreibung
Unterüberschrift2 (====): Datenbank für Beispiel 1 Link zu DemoDB mit beschriebener Situation

Unterüberschrift1 (===): Links

Link zur Funktionsseite
Links zu den anderen Beispielen

Unterüberschrift1 (===): Bit Factory interne Zusatzinfos (<- wenn nötig)

Link zu interner Seite "Aktivierung" für Beschreibung von Configfile Einstellungen, wenn diese für dieses Beispiel benötigt werden ("Intern:")
Issues: (falls per Fussnoten Issues verlinkt wurden)

Beispiele für Dokumentation Programmfunktion

Vorlage DB für Beispiele

DokuDBStart

Links:

Grafik Rohdaten

@@ Zeile 32: / Zeile 32: @@
 ** Unterüberschrift2 (====): '''Parametrierung''' Bild + Beschreibung
 ** Unterüberschrift2 (====): '''Ergebnis''' Bild + Beschreibung
-** Unterüberschrift2 (====): '''Datenbank für Beispiel 1''' Link zu DemoDB mit beschriebener Situation
+** Unterüberschrift2 (====): '''Datenbank für Beispiel 1''' Link zu DokuDB mit beschriebener Situation + Parametrierung
 * Unterüberschrift1 (===) ''Beispieltitel2'' ...
@@ Zeile 39: / Zeile 39: @@
 ** '''Issues''': (falls per Fussnoten Issues verlinkt wurden)
-<span><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><br /></span>
 Wenn zu viele Beispiele, dann '''je Beispiel eine eigene Wiki-Seite''' und bei der Hauptseite nur die Links dorthin einbinden.
@@ Zeile 58: / Zeile 58: @@
 * '''Issues''': (falls per Fussnoten Issues verlinkt wurden)
-<span><span /><span /><br /></span>
+<span><span /><span /><span /><br /></span>
 ==Beispiele für Dokumentation Programmfunktion==
@@ Zeile 70: / Zeile 70: @@
 [https://drive.google.com/open?id=1-S0WHE_vuCi0pcU2UD0glM95R59AhZX_&authuser=alex%40bitfactory.at&usp=drive_fs DokuDBStart]
-<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
-<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
-<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
-<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
-<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
-<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
-<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
-<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
-<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
-<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
-<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
-<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
-<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><span /><br /></span>
 Links:
 [https://drive.google.com/open?id=1-ALzjxWYk3yBJkBgTZP1ze4zwJkAtZ0E&authuser=alex%40bitfactory.at&usp=drive_fs Grafik Rohdaten]