Programmfunktion: Unterschied zwischen den Versionen

Version vom 11. Januar 2023, 10:39 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 ...

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:") Unterüberschrift1 (===): Fußnoten (<- wenn nötig)

Wenn mehr als ein Beispiel, dann

je Beispiel eine eigene Wiki-Seite
bei der Hauptseite keine Links dorthin einbinden!
Buch anlegen (Spezial:Bücherverwaltung) und alle Seiten in einem Buch zusammenfassen
Beispiele im Buch in einem Kapitel Beispiele zusammenfassen:
- * Beispiele
- ** Beispiel 1 ...

Struktur der Beispiel-Seite (Name der Seite = Funktionsname/Beispiel Beispielname) (z. B. Abschlussbuchungen/Beispiel_Umbuchungen)

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 Link zu DemoDB mit beschriebener Situation

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:")

Unterüberschrift1 (===): Fußnoten (<- wenn nötig)

Beispiele für Dokumentation Programmfunktion

Vorlage DB für Beispiele

DokuDBStart

Links:

Grafik Rohdaten

@@ Zeile 35: / Zeile 35: @@
 * Unterüberschrift1 (===) ''Beispieltitel2'' ...
-* Überschrift (==): '''Bit Factory interne Zusatzinfos'''<- '''wenn nötig'''
+* 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:")
+** Link zu '''interner''' Seite "'''Aktivierung'''" für Beschreibung von Configfile Einstellungen, wenn diese für dieses Beispiel benötigt werden ("Intern:")  Unterüberschrift1 (===): '''Fußnoten''' (<- wenn nötig)
-** '''Issues''': (falls per Fussnoten Issues verlinkt wurden)
+**
 <span><span /><br /></span>
-Wenn mehr als ein Beispiel, dann '''je Beispiel eine eigene Wiki-Seite''' und bei der Hauptseite nur die Links dorthin einbinden.
+Wenn mehr als ein Beispiel, dann
+* '''je Beispiel eine eigene Wiki-Seite'''
+* bei der Hauptseite '''keine''' Links dorthin einbinden!
+* Buch anlegen ([[Spezial:Bücherverwaltung]]) und alle Seiten in einem Buch zusammenfassen
+* Beispiele im Buch in einem Kapitel Beispiele zusammenfassen:
+** * Beispiele
+** ** Beispiel 1 ...
 Struktur der '''Beispiel-Seite''' (Name der Seite = ''Funktionsname''/Beispiel ''Beispielname'') ''<small>(z. B. Abschlussbuchungen/Beispiel_Umbuchungen)</small>''
@@ Zeile 51: / Zeile 58: @@
 *Unterüberschrift2 (====): '''Ergebnis''' Bild + Beschreibung
 *Unterüberschrift2 (====): '''Datenbank für Beispiel''' 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)
+Unterüberschrift1 (===): '''Fußnoten''' (<- wenn nötig)
-<span><span /><span /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><span /><span /><span /><span /><span /><br /></span>
 ==Beispiele für Dokumentation Programmfunktion==
@@ Zeile 70: / Zeile 74: @@
 [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 /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><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 /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><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 /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><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 /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><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 /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><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 /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><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 /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><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 /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><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 /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><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 /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><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 /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><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 /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><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 /><span /><span /><span /><span /><br /></span>
+<span><span /><span /><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]