Hierarchische Dokumentation von Objekten

Worum geht es ?
Beim Design von Ausgabeobjekten ist es sinnvoll, einen genauen Überblick darüber zu erhalten, ob die gewünschten Informationen auch darstellbar sind. In der Praxis stellt sich nämlich immer wieder heraus, dass sich alle geforderten Informationen nicht in der gewünschten Form darstellen lassen.

Hierzu ist es notwendig, alle Felder neben ihrer evtl. vorhandenen Beschreibung auch in ihrer maximalen Länge auf dem Ausgabeobjekt darzustellen. Dies verhindert, dass z. B. bei einer Liste zu viele Felder nebeneinander gepackt werden.

Wie wird es gemacht?

Für die korrekte Darstellung der Felder sollten Platzhalter genutzt werden. Diese Platzhalter haben die Aufgabe, den maximal benötigten Raum der Felder auf dem Ausgabeobjekt darzustellen. Für die unterschiedlichen Feldarten können verschiedene Arten von Platzhaltern genutzt werden.

Unser Vorschlag:

Numerische Felder:            66666666606666666660
Alphanumerische Felder:    XXXXXXXXXOXXXXXXXXXO
Datumsfelder:                    TT.MM.JJJJ
Uhrzeiten:                         HH:MM:SS
Fortlaufende Felder:           N

Die obige Liste stellt alle für einen Ausdruck benötigen Felder dar. Zur Erleichterung für den Anwender und die Entwicklung ist alle 10 Zeichen ein Trennungszeichen dargestellt. Auf diese Art und Weise kann speziell bei längeren Feldern die Feldlänge schnell ermittelt werden, ohne dass man mühselig erst jedes einzelne Zeichen zählen muss. Sicherlich kann diese Darstellung noch wesentlich ausgefeilt werden, jedoch hat die Praxis gezeigt, dass diese Form der Darstellung völlig ausreicht.

Felder ohne Feldbeschreibung
Bei den meisten Ausgabeobjekten kommt es vor, dass bei einigen Feldern nur der Feldinhalt und nicht die Feldbeschreibung im Layout ausgegeben wird. Die ist z. B. fast immer bei Adressen so. Für diesen Fall hilft bei der Feldbeschreibung die abstrakte Darstellung der Feldlänge im Beleg nur unzureichend weiter. Alternativ kann daher  innerhalb der Feldlänge der Name des Feldes mit ausgegeben werden.

Beispiel:
NAME1XXXXOXXXXXXXXXO
NAME2XXXXOXXXXXXXXXO
STRASSEXXOXXXXXXXXXO
PLZ6666660 ORTXXXXXXOXXXXXXXXXOXXXXX

In diesem Fall wird der Feldname mit zum Teil der Feldlängendarstellung! Sonst kann die eigentliche Feldlänge nicht mehr richtig dargestellt werden.

Kleine Felder ohne Feldbeschreibung
Sollte die im Ausgabebeleg dargestellte Feldlänge kürzer sein als die Feldbeschreibung kann ein Verweis im Beleg gemacht werden.

Beispiel:
6666⁽¹⁾
(1):            Kunden-Artikel-Nummer

Proportionale Schriftarten
Bei der Verwendung von Textverarbeitungen haben sich proportionale Schriftarten wie z. B. Arial und Times Roman weitgehend durchgesetzt. (Bei diesen Schriften nehmen Buchstaben wie z. B. ein „I“ weniger Platz ein als z. B. ein „X“.) Bei der Gestaltung von Ausgabeobjekten kann die Verwendung von proportionalen Schriftarten böse Überraschungen nach sich ziehen! Dies ist immer dann der Fall, wenn Referenzwerte, anstatt Platzhalter für die Feldlängenbestimmung herangezogen werden. Das nachfolgende Beispiel zeigt deutlich, das ein Referenzwert bei einer proportionalen Schriftart nicht die „echte“ maximale Länge des Feldes wiedergibt.

Beispiel:
Referenzwert:           Filiale Wiesbaden            (17 Zeichen)
Platzhalter:              XXXXXXXXXOXXXXXXX       (17 Zeichen)

Aus diesem Grunde sollten unbedingt Platzhalter und keine Referenzwerte genutzt werden, wenn in Ausgabeobjekten mit proportionalen Schriftarten gearbeitet wird. Auch bei der Verwendung von Schriftarten mit gleicher Zeichenbreite bieten Platzhalter die bessere Übersicht, wenn es darum geht, dass Layout eines Ausgabeobjektes zu prüfen.