Vorlagen
Zur Konvertierung von verschiedenen Dateiformaten setzt webPDF Vorlagen (Templates) ein, um diese in das PDF-Format zu konvertieren. Diese Vorlagen liegen in dem Ordner templates/ der Server-Installation und haben die Dateiendung .ftl. Die Vorlagen sind textbasiert und können mit einem normalen Texteditor geöffnet werden.
Aktuell werden für die folgenden Dateiformate bei der Konvertierung über den Webservice "Converter" Vorlagen verwendet:
| Dateiendung | Dateiformat | Vorlagendatei |
|---|---|---|
| eml | MIME Mail | mail.ftl |
| msg | Outlook Mail | mail.ftl |
| ics | iCalendar/vCalendar | ics.ftl |
| vcf | vCard | vcf.ftl |
| svg | Serial Vector Format | svg.ftl |
| txt | Textdokument | text.ftl |
Die Vorlagen basieren auf HTML und enthalten Variablen und eine Makro-Sprache. Weitere Informationen dazu finden Sie im Abschnitt "Vorlagenformat".
Sprache der Vorlage
Die Vorlagen mail.ftl, ics.ftl und vcf.ftl sind in den Sprachen Deutsch und Englisch verfügbar. Die deutschen Vorlagen haben im Dateinamen die Endung _de (Beispiel: mail_de.ftl). Die Auswahl der Sprache erfolgt über den Parameter language in den Parametern des Webservice "Converter". Dort übergeben Sie den ISO 639-1 Sprachcode für die gewünschte Sprache.
Sie können die Vorlagen auch an Ihre eigene Sprache anpassen und in dem Ordner templates/ ablegen. Wenn Sie z.B. eine französische Übersetzung für die Mails haben wollen, so legen Sie die Datei mail_fr.ftl im Ordner ab und setzen bei den Parametern den Wert fr.
Änderungen in dem Ordner templates/ sind nicht vor Änderungen bei Updates geschützt. Sichern Sie daher immer ihre Vorlagen vor einem Update.
Es wird empfohlen, das Sie eigene oder angepasste Vorlagen nicht in dem Ordner templates/ ablegen, sondern direkt beim Aufruf des Webservice "Converter" über template übergeben.
Eigene Vorlagen
Sie können bei der Konvertierung eigene Vorlagen verwenden. In den Parametern des Webservice "Converter" kann unter template eine eigene Vorlage als BASE64-codierter Text übergeben werden.
API {REST}: /converter
{
"converter": {
"template": {
"data": {
"source": "value",
"uri": "",
"value": ""
},
"file": {
"name": "",
"source": "value",
"uri": "",
"value": ""
},
"language": ""
}
}
Sie können dazu die bestehenden Vorlagen verwenden und diese an Ihre Wünsche anpassen, oder Sie definieren eine komplett eigene Vorlage. Weitere Informationen zur Definition oder zum Anpassen der Vorlagen finden Sie im Abschnitt "Vorlagenformat".
Wenn Sie eine eigene Vorlage übergeben, wird keine Vorlage aus dem Ordner templates/ geladen, und auch die Sprachangabe in den Parametern wird ignoriert.