Formats d'impression
Un format d'impression définit la présentation d'un document imprimé, envoyé par e-mail ou téléchargé en PDF. Chaque format est lié à un type de document (par exemple Facture de vente) ou à un rapport.
Deux niveaux de réglage existent :
- Les paramètres d'impression sont globaux. Ils s'appliquent à tous les formats.
- Chaque format d'impression a ses propres réglages. Ils ne s'appliquent qu'à ce format.
Prérequis
- Avoir le droit de créer ou de modifier des Formats d'impression (rôle Gestionnaire système par défaut).
- Pour définir un format par défaut, avoir le droit de modifier Personnaliser un formulaire.
Types de formats
| Type | Comment il est fait | Quand l'utiliser |
|---|---|---|
| Standard | Livré avec Dokos ou une application. Il est mis à jour avec le logiciel. | Tel quel, ou comme base d'une copie. |
| Éditeur visuel (« Éditeur de format d'impression ») | Glisser-déposer des champs, sections et tableaux. | La plupart des besoins, sans code. |
| Format personnalisé | HTML et Jinja écrits à la main (type Jinja, rendu sur le serveur) ou JavaScript (type JS, rendu dans le navigateur). | Mises en page complexes, impression brute. |
| Ancien constructeur (Éditeur de format d'impression) | Sections et colonnes dans l'ancien éditeur. | Formats existants seulement. Un bandeau indique qu'il sera retiré en version 17. |
Vous ne pouvez pas modifier un format standard. Le formulaire affiche « Veuillez créer un duplicata pour faire des changements ». Dupliquez-le (Menu > Dupliquer), donnez un autre nom à la copie, puis modifiez la copie.
Créer un format d'impression
- Ouvrez la recherche (Ctrl+K), saisissez Format d'impression et ouvrez la liste.
- Cliquez sur Créer. Une boîte de dialogue s'ouvre.
- Dans « Print Format For », choisissez DocType (un type de document) ou Report (un rapport).
- Sélectionnez le type de document ou le rapport.
- Saisissez le Nom du format.
- Dans « Commencer avec », choisissez « Éditeur de format d'impression » (éditeur visuel) ou HTML. Un format de rapport est toujours en HTML.
- Cliquez sur Créer.
Un format créé avec l'éditeur visuel s'ouvre directement dans l'éditeur. Un format HTML s'ouvre dans son formulaire.
Vous pouvez aussi partir de l'aperçu d'impression d'un document : cliquez sur Menu > Personnaliser.
- Si le format affiché est un de vos formats, Dokos l'ouvre dans son éditeur ou son formulaire.
- Sinon, Dokos demande le Nouveau format d'impression, puis ouvre une copie dans l'éditeur visuel.
Modifier avec l'éditeur visuel
L'éditeur affiche le format sur un canevas. Ajoutez des champs du document, des sections, des tableaux, des images ou des codes-barres, puis déplacez-les.
Cliquez sur le canevas en dehors de tout élément pour afficher les réglages du format dans l'inspecteur. Les réglages sont rangés en groupes repliables. Dans la v5, plusieurs libellés de l'éditeur ne sont pas encore traduits : le tableau les reprend tels qu'ils s'affichent.
| Groupe | Réglages |
|---|---|
| « Typography » | Police (Google Fonts) et taille de police. |
| « Style » | Couleur des étiquettes et des valeurs, deux-points après les étiquettes. |
| « Page » | Format du papier et orientation (portrait ou paysage), enregistrés avec le format. Voir Régler le papier et l'arrière-plan d'un format. |
| « Spacing (mm) » | Les quatre marges de la page, en millimètres, dans un seul réglage « Margins ». Les valeurs décimales sont conservées. |
| « Arrière-plan de la page » | Image de fond et opacité, sur toutes les pages du format. |
| « Document » | Moteur PDF, en-tête de lettre, position des numéros de page. |
| CSS personnalisé | Règles CSS propres au format. Ce groupe est replié à l'ouverture. |
Le moteur PDF par défaut est Chromium. « PlutoPrint (léger) » et « Typst (rapide) » sont aussi proposés. Quand l'un d'eux est choisi, l'icône d'information à côté de « Moteur de rendu PDF » affiche Expérimental. Typst n'est disponible que si le format ne contient aucun élément incompatible. Si le format contient un bloc Typst, Chromium et PlutoPrint ne sont plus disponibles. Un format qui utilise encore WeasyPrint affiche « Deprecated, removed in version 17 » : choisissez un autre moteur.
PlutoPrint produit le PDF sans navigateur. Pour un document qui contient un code-barres, ou pour l'impression d'une plage de pages, Dokos utilise tout de même Chromium. Voir Quand PlutoPrint imprime avec chrome.
Vos modifications sont enregistrées dans un brouillon. Cliquez sur Enregistrer et appliquer pour les utiliser lors des impressions. L'historique des versions permet de revenir à une version appliquée.
Cet éditeur remplace l'application Print Designer, dépréciée à partir de Dodock v5.50.
Un format de l'ancien constructeur affiche le bouton « Convertir vers le nouvel éditeur » dans son formulaire. Après la conversion, le bouton « Restaurer la mise en page classique » restaure l'ancienne mise en page.
Régler le papier et l'arrière-plan d'un format
Ces réglages sont enregistrés dans le format lui-même. Ils s'appliquent à chaque impression de ce format, quel que soit le format de papier défini dans les paramètres d'impression.
- Ouvrez le format dans l'éditeur visuel et cliquez sur le canevas en dehors de tout élément.
- Dans le groupe « Page », choisissez le Format du papier : Par défaut, A4, A5, A3, Letter, Legal ou Tabloid. Avec Par défaut, le format de papier des paramètres d'impression s'applique.
- Dans le même groupe, choisissez l'Orientation : Portrait (valeur par défaut) ou Paysage.
- Dans le groupe « Arrière-plan de la page », cliquez sur Télécharger une image et choisissez le fichier. Vous pouvez aussi saisir une adresse dans le champ « ou URL de l'image ». Une fois l'image choisie, le bouton devient Modifier l'image et le bouton Réinitialiser retire l'image.
- Réglez l'Opacité de l'image, de 0 à 100 %. Sans réglage, l'image est affichée à 100 %.
- Cliquez sur Enregistrer et appliquer.
Ce que vous obtenez :
- Le canevas de l'éditeur affiche la taille et l'orientation choisies, ainsi que l'image de fond.
- L'image couvre chaque page du bord à bord, dans l'aperçu et dans les PDF générés avec Chromium, PlutoPrint ou Typst. Les fonds des cellules des tableaux deviennent transparents pour laisser voir l'image.
- Un nom de fichier qui contient des espaces ou des crochets est accepté.
- L'adresse de l'image doit commencer par
/(fichier du site) ou parhttp://ouhttps://. Sinon, l'image est ignorée à l'impression.
Limites :
- Un format qui utilise encore WeasyPrint n'affiche ni l'arrière-plan, ni le format de papier ou l'orientation enregistrés avec le format.
- Avec Typst, une image chargée depuis une adresse web n'est pas acceptée : l'éditeur signale « Image d'arrière-plan chargée depuis une adresse web » parmi les éléments incompatibles. Utilisez une image téléchargée sur le site. Si Typst ne peut pas intégrer l'image, la génération s'arrête avec le message « Le moteur de rendu Typst ne peut pas intégrer cette image d'arrière-plan : » suivi du nom de l'image, sous le titre « Moteur de rendu Typst indisponible ».
Exemple fictif : pour une attestation de formation, vous choisissez le format du papier A4 et l'orientation Paysage. Vous téléchargez l'image « fond-attestation.png » (un cadre décoratif) et réglez l'Opacité sur 40 %. Chaque page du PDF est imprimée en A4 paysage, avec le cadre en filigrane derrière le texte.
Afficher le libellé des champs fusionnés dans une colonne de tableau
Dans un tableau de l'éditeur visuel (par exemple les lignes d'articles), une colonne peut regrouper plusieurs champs de la ligne. Quand un champ fusionné est précédé de son libellé, la cellule imprime « Libellé : valeur » au lieu de la valeur seule.
- Sélectionnez le tableau sur le canevas. L'inspecteur affiche ses colonnes.
- Sur la colonne voulue, cliquez sur le bouton Fusionner les champs (icône de réglages).
- Dans « Ajouter un champ... », choisissez le champ à ajouter à la colonne.
- Sur la ligne du champ ajouté, vérifiez le bouton à l'icône d'étiquette. Son infobulle est Afficher le libellé. Il est enfoncé (fond grisé) quand le libellé est affiché. Cliquez dessus pour afficher ou masquer le libellé.
Ce que vous obtenez à l'impression :
- Le libellé est celui du champ dans la ligne du tableau, traduit dans la langue d'impression. Il est suivi de deux-points et imprimé en gras.
- Un champ dont le libellé est affiché et dont la valeur est vide n'est pas imprimé : ni le libellé, ni la ligne.
- Un champ ajouté à une colonne a son libellé affiché par défaut. Les champs déjà fusionnés dans un format existant restent sans libellé, et le format s'imprime comme avant.
- Le bouton n'existe pas pour les champs de type image ou fichier joint, ni pour les champs de texte enrichi (Éditeur de texte, Éditeur HTML) : ces champs n'ont pas de libellé.
- L'aperçu de l'éditeur, le PDF Chromium et le PDF Typst affichent le libellé de la même façon.
Exemple fictif : la colonne « Article » d'une facture contient le champ Nom de l'article, puis le champ Groupe d'article. Avec le libellé activé sur le groupe, la cellule affiche le nom de l'article, puis une seconde ligne « Groupe d'article : Produits ». Pour une ligne dont le groupe est vide, la seconde ligne n'est pas imprimée.
Écrire un format personnalisé (HTML/Jinja)
Dans le formulaire du format :
- Cochez Format personnalisé.
- Choisissez le Type de format d'impression : Jinja ou JS.
- Saisissez le modèle dans le champ HTML.
- Ajoutez vos règles dans CSS personnalisé si besoin.
- Enregistrez.
Le modèle accède au document par la variable doc. Vous pouvez utiliser les classes de Bootstrap 3.3, inclus dans les feuilles d'impression.
Exemple : afficher le compte bancaire par défaut du client sur une facture (le champ default_bank_account est un exemple, vérifiez le nom du champ sur votre site) :
{% set bank_account = frappe.db.get_value("Customer", doc.customer, "default_bank_account") %}
<div class="row">
<div class="col-xs-3 text-right">{{ _("Bank Account") }}</div>
<div class="col-xs-9">{{ bank_account or "" }}</div>
</div>
Les fonctions disponibles dans les modèles sont listées dans Modèles Jinja.
Si votre imprimante accepte des commandes brutes, cochez Impression brute et saisissez les Commandes brutes. Voir Impression brute.
_(), ajoutez leur traduction dans le type de document Traduction pour chaque langue utilisée.Champs du formulaire
| Champ | Rôle |
|---|---|
| Format d'impression pour | DocType ou Report. |
| Type de document / Rapport | Le document ou le rapport imprimé avec ce format. |
| Module | Rempli à partir du type de document. |
| Désactivé | Retire le format des choix. Si c'est le format par défaut, Dokos demande une confirmation et le retire des défauts. |
| Format personnalisé | Format écrit en HTML/Jinja ou JS. |
| Langue d'impression par défaut | Langue proposée à l'impression. |
| Police Google Font, couleurs | Police et couleurs d'un format de l'ancien constructeur. |
| Alignez les étiquettes à droite, Afficher les titres de section, Afficher les sauts de Ligne après chaque section | Réglages de l'ancien constructeur. |
| Afficher les valeurs absolues | Affiche les nombres négatifs (montants, quantités) sans signe. Visible si le document a des champs numériques. |
| Page de couverture / Page de couverture arrière | PDF ajoutés avant ou après le document. |
| « Générateur PDF » | wkhtmltopdf, chrome, PlutoPrint, Typst ou WeasyPrint. Un nouveau format laisse ce champ vide : le générateur des paramètres d'impression s'applique alors, et il suit leurs changements. Un format existant garde le générateur qu'il avait. Avec PlutoPrint, si le format contient du JavaScript ou une grille CSS, ou si PlutoPrint n'est pas installé sur le serveur, un format existant est refusé à l'enregistrement (« Ce format ne peut pas utiliser le moteur de rendu PlutoPrint : » suivi du motif). Sur un nouveau format, Dokos règle le champ sur chrome. Voir Choisir le générateur PDF. Ce champ est masqué pour un format créé avec l'éditeur visuel : son moteur se règle dans l'éditeur. |
| « Format du papier » | Taille du papier d'un format HTML (A4, A5, A3, Letter, Legal, reçus 80 mm et 58 mm). Affiché quand le générateur utilisé par le format est chrome ou PlutoPrint, qu'il soit réglé sur le format ou hérité des paramètres d'impression. Masqué pour un format de l'éditeur visuel et pour l'impression brute : le format du papier d'un format de l'éditeur visuel se règle dans le groupe « Page » de l'éditeur. Vide, la taille des paramètres d'impression s'applique. Voir Taille du papier d'un format d'impression. |
Définir le format par défaut
- Ouvrez le format d'impression.
- Cliquez sur Définir par défaut.
Le bouton n'apparaît pas si le format est déjà le format par défaut du type de document. Dans l'aperçu d'impression, le menu propose aussi « Set as Default Format » (libellé non traduit).
Page d'impression
La page d'impression d'un document affiche l'aperçu et une barre latérale. Pour son usage pas à pas, voir Page d'impression.
Le menu de la page d'impression propose :
| Élément | Visible |
|---|---|
| Pleine Page : ouvre le document seul dans un nouvel onglet. | Toujours |
| Actualiser : recalcule l'aperçu (Shift+R). | Toujours |
| « Set as Default Format » (libellé non traduit) : fait du format choisi le format par défaut du type de document. | Si vous pouvez modifier les formats d'impression |
| Paramètres d'impression : ouvre les paramètres globaux. | Toujours |
| Paramètres d'impression brute : associe un format d'impression brute à une imprimante. | Si l'impression brute est activée |
| Personnaliser : ouvre le format affiché ou crée une copie à modifier. | Si vous pouvez créer des formats d'impression |
| Sélectionnez l'imprimante réseau : choisit l'imprimante du serveur d'impression. | Si le serveur d'impression est activé |
La section Page de la barre latérale change la taille du papier (« Paper Size », libellé non traduit) et l'Orientation pour une impression. Les tailles proposées sont « Par défaut », A4, A5, A3, Letter, Legal et Tabloid. Cette section est masquée pour l'impression brute. Elle reste visible pour les formats personnalisés (HTML/Jinja ou JS).
Avec le format Standard, la section Style présente les styles d'impression actifs sous forme de cartes. Le code de la page cite aussi un style « Redesign » parmi les styles standard. Aucun style de ce nom n'est livré avec Dokos : il n'apparaît pas dans les cartes.
Exemple fictif : Paul imprime un bon de livraison en A5 paysage pour une seule fois. Dans la section Page, il choisit A5 et Paysage, puis clique sur Imprimer. Le format d'impression n'est pas modifié.
Ajouter une page de couverture
Créer une page de couverture dans la démoUne page de couverture est un fichier PDF ajouté au début du PDF généré. Une page de couverture arrière est ajoutée à la fin.
- Ouvrez la recherche (Ctrl+K) et saisissez Page de couverture.
- Créez une page : saisissez son nom et joignez le PDF.
- Ouvrez le format d'impression et sélectionnez-la dans Page de couverture ou Page de couverture arrière.
Exemple fictif : vous joignez vos conditions générales de vente en PDF comme page de couverture arrière du format « Facture Atelier ». Chaque facture téléchargée en PDF avec ce format se termine par ces conditions.
Cas d'usage
Ajouter un titre au-dessus d'une ligne d'article
Le tableau d'articles des formats standard de Dokos imprime une ligne de titre au-dessus d'un article quand la ligne a une valeur dans un champ nommé title ou print_title.
- Ouvrez Personnaliser un formulaire sur le tableau d'articles, par exemple Article de la facture de vente.
- Ajoutez un champ de type Données dont le nom technique est
print_title. - Cochez Autoriser les modifications après validation et Masquer à l'impression.
- Cliquez sur Mettre à jour.
custom_..., par exemple custom_print_title. Le format standard ne le reconnaît pas. Vérifiez le nom technique du champ.Le titre saisi sur une ligne s'imprime au-dessus de cette ligne.
Ajouter un texte au-dessus du tableau des articles
- Ouvrez Personnaliser un formulaire sur le type de document.
- Ajoutez un champ du type voulu (par exemple Texte) et donnez-lui un libellé.
- Cliquez sur Mettre à jour.
- Dans votre format d'impression, placez ce champ juste au-dessus du tableau des articles.