Simon: Bericht-Vorlagen

Simon > Simon-Fenster > Bericht-Fenster (Neu/Bearbeiten) Index

Bericht-Vorlagen

Der Bericht-Vorlagen-Ordner enthält HTML-Dateien (und andere Formate), die Sie zur Darstellung des Inhalt von Simon-Berichten verändern können. Dieser Ordner liegt im Datenordner von Simon: ~/Library/Application Support/Dejal/Simon/. Sie können ihn rasch im Finder anzeigen lassen, wenn Sie im Bericht-Fenster (Neu/Bearbeiten) in der Seite Bericht-Optionen auf den Button [Im Finder zeigen] klicken.

Sie brauchen die Vorlagen nicht zu bearbeiten (geschweige denn anzusehen), um Simon zu benutzen. Simon bietet schon eine Anzahl nützlicher Vorlagen, die automatisch im Bericht-Vorlagen-Ordner installiert werden, wenn Sie Simon ab Version 2.1 das erste Mal starten. Die Simon-Website bietet weitere aktualisierte oder von Anwendern zur Verfügung gestellte Vorlagen: Besuchen Sie die Seite Simon-Extras. Natürlich können Sie vorbereiteten Vorlagen trotzdem nach Ihren Wünschen bearbeiten oder sogar neue erzeugen, wenn Sie möchten. Wenn Sie eine Vorlage neu erzeugen oder bearbeiten und meinen, auch andere Anwender könnten davon profitieren, nutzen Sie die Simon-Extras-Webseite, um sie zu verbreiten; dort steht auch, wie das geht.

Der Bericht-Vorlagen-Ordner enthält Unterordner für jede Vorlage. Innerhalb jedes dieser Ordner gibt es einige oder alle der nachfolgend beschriebenen Objekte:

Eine Datei namens index oder summary, ohne jede Dateiendung. Diese Datei enthält den HTML-Inhalt für die Zusammenfassung-Seite und listet alle im Bericht enthaltenen Tests auf.
Eine Datei oder ein Ordner namens detail. Falls es eine Datei ist, kann sie irgendeine Endung haben; falls es ein Ordner ist, muss darin eine Datei namens index enthalten sein, wiederum ohne jede Dateiendung. In jedem Fall enthält diese Datei den HTML-Inhalt für die Detailseiten. Die Datei bzw. der Ordner namens detail wird für jede Detailseite kopiert, wobei eine Kurzform des entsprechenden Test-Namens zur Unterscheidung verwendet wird.
Ein Ordner namens images. Er ist optional; falls vorhanden, wird er samt seinem Inhalt unverändert ausgegeben. Hier ist der richtige Ort, um Ihre Grafiken für Berichte abzulegen.
Ein Ordner namens resources. Er ist ebenfalls optional und wird ebenso unverändert ausgegeben, falls vorhanden. Hier können Sie andere Dateien ablegen, z.B. CSS-Dateien (Cascading Style Sheets), zusätzliche PHP-Skripte, Formular-Seiten usw.
Alle anderen Dateien werden ignoriert, daher können Sie problemlos z.B. LIESMICH-Dateien usw. im Vorlagen-Ordner ablegen.

Die meisten Vorlagen benutzen HTML-Formatierung, aber das ist kein Muss. Sie können jedes textbasierte Format nutzen. Die eingebauten Vorlagen z.B. nutzen XML für einen RSS-Feed, oder tab-limitierten Text.

Zusätzlich enthalten die Vorlagen-Dateien spezielle, Simon-spezifische Tags, die mit den Tests, Prüfungen, Änderungen, Fehlschlägen und Meldungen von Simon sowie weiteren Werten ersetzt werden. Diese Tags nutzen weitgehend die normalen HTML-Konventionen, aber mit genauen Begrenzern. Es gibt zwei Arten von Simon-Tags:

Block-Tags

Sind umschlossen von eckigen Klammern, z.B. [test].
Haben Schluss-Tags, z.B. [/test], genau wie HTML.
Gelten als Bereich für enthaltene Variablen.
Erzeugen HTML-Code, der für jede Zeile wiederholt werden sollte, z.B. für jeden Test auf einer Zusammenfassung-Seite oder jede Prüfung auf einer Detailseite.
Können Parameter haben; momentan wird nur der count-Parameter unterstützt, der die Anzahl benutzter Zeilen begrenzt.

Variablen-Tags

Sind umschlossen von geschweiften Klammern, ohne separaten Schluss-Tag, z.B. {name}.
Haben einen Variablen-Namen und können optional Parameter enthalten, z.B. {date type="absolute"}.
Parameter-Werte müssen von Gänsefüßchen umschlossen sein.
Zwischen Parametername, Gleich-Zeichen, Anführungszeichen und Wert dürfen keine Leerzeichen stehen.
Mehrfache Parameter können genutzt werden. Falls nicht, werden Standardwerte genutzt.

Block- und Variablen-Tags und ihre Parameter werden nicht nach Groß-/Kleinschreibung unterschieden, daher können Sie gerne auch GroßBuchStaben nutzen, um die Namen lesbarer zu machen, falls Sie möchten.

Die Zusammenfassung-Seite hat zwei Block-Bereiche – das Dokument selbst und den Test-Block. Klicken Sie auf die Variablen-Namen für jede Block-Art, um mehr Informationen zu erhalten:

Dokument: Das HTML-Dokument unterstützt verschiedene Variablen, die beliebig im Dokument benutzt werden können.
Test: Enthält die Vorlage für einen einzelnen Test; sie wird für jeden in der Zusammenfassung enthaltenen Test wiederholt.

Die Detail-Seiten unterstützen verschiedene Block-Arten:

Dokument: Genau wie die Zusammenfassung-Seite unterstützen auch die Detailseiten Variablen auf Dokumentebene.
Test: In diesem Fall enthält dieser Block Informationen über den einzelnen Test in der Detailseite.
Prüfung: enthält die Vorlage für eine einzelne Prüfung; wird für jede Prüfung wiederholt.
Änderung: enthält die Vorlage für eine einzelne Änderung; wird für jede Änderung wiederholt.
Fehlschlag: enthält die Vorlage für einen einzelnen Fehlschlag; wird für jeden Fehlschlag wiederholt.
Aktivität: enthält die Vorlage für eine einzelne Aktivität; wird für jede Aktivität wiederholt.

Im Kapitel Berichtvorlage-Parameter finden Sie Informationen über die verfügbaren Parameter.

Die nachfolgenden Seiten geben weitere Informationen über die verfügbaren Vorlagen-Beispiele.