Programmfunktion

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 (==): Beispiel (wenn mehr als ein Beispiel, siehe unten)
• Unterüberschrift1 (===): Beispieltitel + Absatz Einleitung
  • Unterüberschrift2 (====): Ausgangssituation Bild + Beschreibung
  • Unterüberschrift2 (====): Aktivierung Link zur internen Seite Aktivierung
  • Unterüberschrift2 (====): Parametrierung Bild + Beschreibung
  • Unterüberschrift2 (====): Ergebnis Bild + Beschreibung
  • Unterüberschrift2 (====): Datenbank für Beispiel 1 Link zu DokuDB mit beschriebener Situation + Parametrierung

• Überschrift (==): Bit Factory interne Zusatzinfos (<- wenn nötig)
  • Link zu interner Seite "Aktivierung" für Beschreibung von Configfile Einstellungen, wenn diese für diese Programmfunktion benötigt werden ("Intern:")
• Überschrift (==): 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 (====): Aktivierung Link zur internen Seite Aktivierung
  • Unterüberschrift2 (====): Parametrierung Bild + Beschreibung
  • Unterüberschrift2 (====): Ergebnis Bild + Beschreibung
  • Unterüberschrift2 (====): Datenbank für Beispiel Link zu DemoDB mit beschriebener Situation
• Unterüberschrift1 (===): Fußnoten (<- wenn nötig)

Kategorien

Die Funktionsbeschreibung muss mit folgenden Kategorien versehen werden:

• Neu ab Version 202x.xx (falls relevant)
• Funktionsübersicht
• Eine Kategorie, aus der Funktionsübersicht Thematisch

Die Aktivierungsseite braucht die Kategorie "Aktivierung".

Verlinken aus Alex®

• möglichst von den Systemeinstellungen aus
• Alle 3 Ebenen verlinken!
• Jeden Parameter!
• Weiterleitung an den Zielort : möglichst genau zur jeweiligen Überschrift

Corporate Identity

• Screenshots und Tabellen: Alex-Vorlagen verwenden
• Alex® sparsam aber wenn, dann mit Template {{Alex}} verwenden
• Bit Factory korrekt schreiben
• Bei eigenen Übersichten / Bildern auf die Bit Factory-Farbcodes achten

Screenshots

• siehe: Wie füge ich einen Screenshot ein?

Tabellen

• Tabellen können im Bearbeiten-Modus mit Copy-Paste eingefügt werden
• Speichern
• Im Modus "Quelltext bearbeiten" den Header korrigieren:
  • Spaltenüberschriften mit ! markieren
  • ganz oben: class = "wikitable" ändern auf class="wikitable alex-blue"

Parameter

Parameter werden als <code></code> geschrieben in der Form <code>Objekttyp: Gruppe: Parametername</code>

Beispiel:

Systemeinstellungen: Einsatzanfragen: Benachrichtigungen per Email senden

Beispiele für Dokumentation Programmfunktion

• Abschlussbuchungen
• Indikatoren
• Schemaanpassung

Vorlage DB für Beispiele

DokuDBStart

Links:

Grafik Rohdaten