Jak przesłać szablon dokumentów (okładka, nagłówek i stopka)

Szablon dokumentu to wizualna oprawa Twoich dokumentów: okładka, powtarzający się nagłówek i stopka, czcionki, kolory i logo. Treść nadal jest tym, co piszesz w WorkOS. Szablon jest używany w portalu klienta i w pobieranym PDF.

Jeśli żadnego nie prześlesz, WorkOS używa neutralnego wyglądu z Twoim logo.

Jak go przesłać

1. Wejdź w Ustawienia, znajdź kartę Dokumentacja i kliknij Otwórz konfigurator.
2. Przejdź do kroku Szablon dokumentu.
3. Wybierz plik .zip i kliknij Prześlij szablon. Może to zrobić tylko Właściciel.

Plik .zip może ważyć do 10 MB. Przesłanie nowego zastępuje poprzedni.

Co musi zawierać plik .zip

Plik template.html z trzema strefami oznaczonymi tymi komentarzami: <!-- SDS:COVER --> (okładka), <!-- SDS:HEADFOOT --> (nagłówek i stopka) oraz <!-- SDS:BODY --> (treść, którą zostawiasz pustą, a WorkOS ją wypełnia). Każda strefa jest zamykana swoim znacznikiem <!-- /SDS:... -->. Jeśli którejś brakuje, przesłanie zostaje odrzucone, a poprzedni szablon pozostaje.

Możesz dodać style (.css), obrazy (PNG, JPG, GIF, SVG, WebP) i czcionki (WOFF, WOFF2, TTF, OTF). Nie dodawaj JavaScriptu: jest ignorowany.

Dane dokumentu

Na okładce, w nagłówku i w stopce możesz używać tych zmiennych, które WorkOS zastępuje prawdziwymi danymi:

{{doc.titulo}}, {{doc.fecha}}, {{doc.tipo}}, {{doc.destinatario}} (Firma, do której skierowany jest dokument), {{doc.proyecto}}, {{doc.valor_bruto}}, {{doc.valor_neto}}, {{doc.valor_mensual_bruto}}, {{doc.valor_mensual_neto}}, {{doc.moneda}}, {{doc.cliente_nombre}} (Twoja firma), {{doc.cliente_logo}}, {{doc.fecha_generacion}} i {{doc.ultima_modificacion}}.

Jeśli jakaś dana nie jest skonfigurowana, pozostaje pusta. Aby pokazać numer strony, dodaj element z klasą sds-pagenum.

Treść trafia jako prosty HTML (nagłówki, akapity, listy, tabele, obrazy...), więc Twój CSS powinien stylizować te znaczniki, a nie klasy.

Jeden szablon na typ dokumentu

W Szablony według typu dokumentu możesz przesłać własny szablon dla konkretnego Typu. Dokument tego Typu użyje własnego; pozostałe nadal korzystają z ogólnego.

Wskazówka: zwykle przygotowuje go osoba, która projektuje Twoją markę. Po przesłaniu otwórz dokument w portalu i kliknij Pobierz PDF, aby sprawdzić efekt.