Awesome Open Source
Awesome Open Source

schild.report ist eine moderne Lsung zum Erstellen von Reports mit Daten aus der Schild-Datenbank, die den bei Schild mitgelieferten Report-Designer vollstndig ersetzen kann.

Hauptmerkmale von schild.report lassen sich wie folgt zusammenfassen:

  • bersichtliche Reporterstellung in lesbarem Format
  • perfekte Typografie
  • vollstndige Steuerung der Druckausgabe
  • untersttzung aller gngigen Grafikformate
  • schnelle Anzeige und Ausgabe der Dokumente in Vorschau und PDF
  • Live-Vorschau bei der Erstellung von Dokumenten

schild.report verwendet zur Erstellung von Reports das fr Internetseiten verwendete HTML, eine Auszeichnungssprache, die mit Hilfe von sog. Tags die Darstellung von Elementen steuert. D.h. mit Hilfe von <b>Fett</b> werden Textstellen als Fett markiert und ausgegeben. Ebenso kann CSS eingesetzt werden, mit dessen Hilfe Elemente neben weiteren Darstellungsmglichkeiten auch noch frei bzw. in Abhngigkeit zu anderen Elementen positioniert werden knnen. Mit Hilfe dieser modernen Gestaltungstechniken, man werfe einen Blick auf die Internetseiten grerer Firmen, ist unschwer zu erkennen, dass Schuldokumente keine groe Herausforderung darstellen.

Da HTML statisch ist, also erstmal nicht mit Daten aus der Schild-Datenbank gefttert werden kann, wird mit Hilfe von Platzhaltern gearbeitet, die anschlieend die Daten einfgen. Dazu wird eine JavaScript-Bibliothek namens Svelte verwendet, die sich hervorragend dazu eignet. Angaben wie {schueler.Name} geben den Nachnamen des Schlers aus. Diese Daten werden von schild.report zur Verfgung gestellt, die geschriebenen Reports knnen beliebig darauf zugreifen und verarbeiten und damit individuelle Schlerdokumente erstellen, die natrlich auch im Klassensatz verarbeitet werden knnen.

Da diese Reports im Prinzip einfache HTML-Dokumente sind, knnen sie in jedem Texteditor geschriebenen und angeschaut werden. Es werden keine Binrformate verwendet. Mit ein bisschen bung lassen sich solche Dokumente recht gut lesen und schreiben. Ein weiterer Vorteil ist, dass Svelte auf JavaScript basiert und damit auch Subreports erlaubt, d.h. man kann kleine Teile eines Reports, die in vielen anderen Dokumenten verwendet werden, auslagern und wiederverwenden.

Zur Anzeige der HTML-Dokumente setzt schild.report auf Electron, das auf dem Chromium-Browser aufbaut. Dadurch stehen einer perfekten Typografie nichts im Wege. Moderne Browsertechnologien sind spezialisiert auf die Textausgabe am Bildschirm und im Druck und knnen darber hinaus viele Grafikformate verarbeiten. Damit ist es auch mglich, dass schild.report Vektorgrafiken verarbeiten kann, die beliebig skalierbar sind und daher niemals zu klein oder zu gro dargestellt werden knnen. Die Qualitt bleibt identisch.

JavaScript ist die Sprache, die von vielen groen Internetfirmen untersttzt und finanziert wird. Dementsprechend gro ist das Interesse, dass JavaScript schneller wird. Die Leistungsfhigkeit moderner JavaScript-Engines macht sich auch in der Anzeige der Reports bemerkbar. Die Anzeige eines Klassensatzes ist innerhalb einer Sekunde mglich. Lediglich der Datenverkehr zwischen MySQL-Server und schild.report verzgert die Darstellung meist um ein oder zwei Sekunden. Geschwindigkeiten, die mit Schild nicht denkbar wren.

Die in schild.report eingesetzten Reports werden bei jedem Speichervorgang neu eingelesen und ermglichen dadurch eine Live-Vorschau von Dokumenten, whrend sie geschrieben werden. Dadurch knnen Fehler direkt behoben werden.

Voraussetzungen

schild.report setzt eine MySQL-Datenbank voraus. Access-Datenbanken knnen leider nicht angesprochen werden. Dafr luft schild.report auf Windows, Linux und MacOS.

Um Reports erstellen oder bearbeiten zu knnen, sollte ein einfacher Texteditor vorhanden sein, mit dem sich HTML-Dateien erstellen lassen. Empfehlenswert ist z.B. VS-Code. Aber auch notepad.exe lsst sich problemlos einsetzen.

Installation

Fr Windows stehen unter Github aktuelle Ausgaben im MSI-Format zur Verfgung, d.h. es sind automatisch ausfhrbare Installationsdateien. Fr Linux und MacOS sind ebenfalls aktuelle Pakete verfgbar. Bitte unter https://github.com/schild-report/schild.report/releases nachschauen.

schild.report erstellt im Dokumentenverzeichnis folgende Ordner:

schild.report
  |- reports
  |- pdf

Der Ordner pdf archiviert alle erstellten Dokumente entsprechend dem gewhlten Jahr, reports enthlt weitere Ordner, die als Sammlung fr Reports dienen.

Wird ein Ordner unter reports erstellt, erscheint er in der Schler-, bzw Klassenansicht. Gleiches gilt fr darin abgelegt Reports.

Nutzung

Um schild.report nutzen zu knnen, mssen Reports im oben genannten reports-Ordner abelegt werden. Dazu kann man z.B. die Demo-Reports verwenden, die sich auf Github befinden.

So siehts aus

Hier ein paar Bilder mit Schlern aus der Testdatenbank und den Demo-Reports unter Version 1. Version 2 startet mit leicht vernderter Optik:

auswahl ber eine Suchfunktion knnen Klassen oder einzelne Schler ausgewhlt werden.

klasse Hier die Klassenbersicht mit Links zu allen Schlern. Um Dokumente fr eine Teilauswahl zu erzeugen, werden diese in der Klassenbersicht selektiert.

schueler Schler werden mit einer Notenbersicht und Personaldaten angezeigt. Wenn ein Bild vorhanden ist, wird auch dies angezeigt.

zeugnis Hier ein Zeugnis als Beispiel. Die Gestaltung ist in diesem Fall recht einfach gehalten. Da die Testdatenbank anonymisiert worden ist, fehlen einige Daten. In der Auswahl oben rechts knnen die jeweiligen Halbjahre ausgewhlt werden. Voreingestellt ist das aktuelle Halbjahr.

pdf Der PDF-Button erzeugt ein PDF im PDF-Ordner und zeigt das Dokument mit dem systemeigenen PDF-Programm an. In diesem Fall der Internet Explorer. Es kann auch Acrobat eingestellt werden.

vorlagen Im Dokumentenordner befindet sich das schild.report-Verzeichnis mit dem PDF-Archiv und den Reportvorlagen. Jeder Ordner wird als Einheit dargestellt, so auch der Demo-Ordner mit seinen Reports. Wie man erkennen kann, sind die Reports HTML-Dateien. Wird ein zustzlicher Report erstell, erscheint er automatisch in der Dokumentenbersicht in schild.report. Vernderungen werden ebenfalls automatisch erfasst, so dass man einen Report bearbeiten kann und mit jeder Speicherung wird die Anzeige in schild.report aktualisiert.

quelle Die Notenliste ist auf diesem Bild fast vollstndig abgebildet und nur einige Zeilen lang.

schild.report ist Open Source

Da der Quellcode auf GitHub verffentlicht wird und unter der freien MIT-Lizenz steht, kann schild.report beliebig angepasst und verndert werden. Mitarbeit und neue Ideen sind ausdrcklich erwnscht.

Quellen

Hier nun eine bersicht ber die verwendeten Quellen:

schild.report fr Windows, Mac und Linux (jeweils aktuelle MSI-Datei): https://github.com/schild-report/schild.report/releases

Quellcode fr schild.report: https://github.com/schild-report/schild.report

Das in den Bildern verwendete Demo-Verzeichnis ist veraltet. Bitte das bk-2018 verwenden. Diese Dokumente sind aktuell und gepflegt: https://github.com/schild-report/demo

Ein Video mit den wichtigsten Funktionen: https://b.hmt.im/schild.report.webm

Eine bersicht zu Svelte, dem verwendenten Framework zur Steuerung der Reports: https://svelte.dev

Related Awesome Lists
Top Programming Languages
Top Projects

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Svelte (5,759
Svelte Components (175
Reporting Tool (113
Reporting Engine (77
Schule (20
Nrw (4
Zeugnisse (3