Skip to end of metadata
Go to start of metadata

Mit Snippets steht im Synesty Studio ein Mittel zur Verfügung, um wiederverwendbare Funktionen und Macros mittels Freemarker zu erstellen.
Snippets können Sie im Mapper auf Spaltenbasis verwenden, äquivalent zu unseren Template Funktionen.
Nutzen Sie die Freemarker Syntax, um wiederverwendbare Methoden und Macros für Ihre Projekte zu erstellen.
Ab dem Plus Paket können pro Workspace 25 Snippets erstellt werden.

Erstellen eines Snippets

Über Mein Konto > Snippets öffnet sich die Bearbeitungsansicht ihrer Snippets. Mit Klick auf den Button öffnet sich folgendes Bild.

Sie haben die Wahl zwischen Freemarker Funktion und Freemarker Makro. Makros ermöglichen Inhalte wiederzuverwenden. Funktionen agieren wie Methoden in jeder anderen Programmiersprache. Initial wird eine Beispielfunktion / ein Beispielmakro erstellt.  Alle Felder des Snippets sind bereits mit Beispielwerten versehen, sodass das Snippet direkt verwendet werden kann.

Anwendungsbeispiel

Es soll eine Funktion zum Erkennen der Mehrwertsteuer erstellt werden. Hierfür lassen wir das Auswahlfeld auf FREEMARKER FUNCTION. Wir nennen die Methode addVAT und klicken auf Neues Snippet erstellen.
Mit Klick auf Snippet bearbeiten öffnet sich die Bearbeitungsansicht des Snippet.


per Klick auf die jeweiligen Felder, öffnen sich Formularfelder zum Bearbeiten des Snippets.
Das Snippet - Feld beschreibt den Methoden-/ Makrorumpf. Alle eingegebenen Parameter sind hier verfügbar. Ein Beispiel wird direkt zur Veranschaulichung des Workflows mit erstellt.
für Funktionen kann eine Freemarker Return Anweisung gesetzt werden (siehe Beispiel unten). Für Makros wird wie gewohnt der gerenderte Rumpf ausgegeben.


Um Anwendungsbeispiele ihres Snippets zu erstellen, öffnen Sie die Examples Reiter. Hier können Sie zugleich prüfen, ob ihr Snippet die korrekten Werte ausgibt, indem Sie einen erwarteten Output hinzufügen.
Das ist nützlich, falls Sie Ihr Snippet erweitern wollen, das bisherige Verhalten aber gleich bleiben soll.


Anwendung

Nach den Speichern des Snippets taucht dieses nun beim Klick auf den Schraubenschlüssel unter einem neuen Reiter namens Snippets auf.
Die Methoden werden - wie gewohnt - per Klick direkt eingefügt.


Ihre Snippets können Sie nun in jedem Feld mit dem Schraubenschlüssel wiederverwenden, so z.B. im Mapper oder auch im HtmlTextWriter

Beim Klick auf Hilfe zu den Snippets gibt es zudem eine für alle Nutzer des Accounts zugängliche Dokumentationsseite, die mit dem Speichern des Snippets direkt aktualisiert wird.

Anmerkungen / Restriktionen

Pro Workspace sind im Plus Paket 25 Snippets erlaubt.



  • No labels