Version de développement
Cette documentation décrit la version « next » (develop), non encore publiée. Pour la version stable, basculez sur « v5 » dans l'en-tête.
Impression

Formats d'impression

Créer, modifier et choisir les formats d'impression de vos documents et rapports avec l'éditeur visuel ou un modèle HTML/Jinja.

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

TypeComment il est faitQuand l'utiliser
StandardLivré 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, rapports.

Les formats de l'ancien constructeur sont convertis vers l'éditeur visuel lors de la mise à jour du site. La mise en page d'origine est conservée dans le format. Les champs qui n'existent plus dans le type de document sont retirés et signalés dans le Journal des erreurs.

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

  1. Ouvrez la recherche (Ctrl+K), saisissez Format d'impression et ouvrez la liste.
  2. Cliquez sur Créer. La boîte de dialogue Nouveau format d'impression s'ouvre.
  3. Dans Format d'impression pour, choisissez DocType (un type de document) ou Report (un rapport).
  4. Sélectionnez le type de document ou le rapport.
  5. Saisissez le Nom du format.
  6. Pour un type de document, choisissez dans Commencer avec : « Éditeur de format d'impression » (éditeur visuel) ou HTML.
  7. Pour un rapport, choisissez le type de modèle (« Modèles ») : JS (rendu dans le navigateur) ou Jinja (rendu sur le serveur).
  8. Cliquez sur Créer.

Un format créé avec l'éditeur visuel s'ouvre directement dans l'éditeur. Un format HTML ou de rapport s'ouvre dans son formulaire.

Un nouveau format reçoit le Générateur PDF PlutoPrint. Si son contenu utilise du JavaScript ou une grille CSS, Dokos le règle sur chrome à l'enregistrement (voir Choisir le générateur PDF).

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 visuel fait l'objet de deux guides :

Depuis le formulaire d'un format visuel, le bouton Modifier le format ouvre l'éditeur.

Écrire un format personnalisé (HTML/Jinja)

Dans le formulaire du format :

  1. Cochez Format personnalisé.
  2. Choisissez le Type de format d'impression : Jinja ou JS.
  3. Saisissez le modèle dans le champ HTML.
  4. Ajoutez vos règles dans CSS personnalisé si besoin.
  5. 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. Les formats de rapport sont décrits dans Format d'impression de rapport.

Si votre imprimante accepte des commandes brutes, cochez Impression brute et saisissez les Commandes brutes. Voir Impression brute.

Si vous ajoutez des libellés traduisibles avec _(), ajoutez leur traduction dans le type de document Traduction pour chaque langue utilisée.

Champs du formulaire

ChampRôle
Format d'impression pourDocType ou Report.
Type de document / RapportLe document ou le rapport imprimé avec ce format.
ModuleRempli à 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.
Rôles (section Accès)Si la liste est remplie, seuls les utilisateurs qui ont un de ces rôles peuvent imprimer avec ce format. Voir Limiter un format à certains rôles.
Langue d'impression par défautLangue proposée à l'impression.
Afficher les valeurs absoluesAffiche 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èrePDF ajoutés avant ou après le document.
Générateur PDFchrome, PlutoPrint (valeur d'un nouveau format) ou Typst. Avec PlutoPrint, un contenu que ce moteur ne rend pas (JavaScript, grille CSS, code-barres, en-tête de lettre avec script ou grille, plage de pages) est imprimé avec chrome. À l'enregistrement, un nouveau format qui contient du JavaScript ou une grille CSS passe sur chrome ; un format existant est refusé avec le message « Ce format ne peut pas utiliser le moteur de rendu PlutoPrint : » suivi du motif. Voir Impression et PDF.
« Format du papier »Taille du papier d'un format HTML : A4, A5, A3, Letter, Legal, reçus 80 mm et 58 mm, ou « Custom » avec une largeur et une hauteur en mm. Vide, la taille des paramètres d'impression s'applique.

Définir le format par défaut

  1. Ouvrez le format d'impression.
  2. 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).

Supprimer un format d'impression

  1. Ouvrez le format d'impression dans son formulaire.
  2. Cliquez sur Menu > Supprimer (raccourci Maj+Ctrl+D) et confirmez. L'action n'apparaît pas pour un format qui n'est pas encore enregistré, ni si vous n'avez pas le droit de supprimer des formats d'impression.

Après la suppression, Dokos affiche :

  • la liste des Formats d'impression si vous êtes arrivé sur le formulaire depuis l'éditeur de ce format, ou si Dokos ne connaît pas la page précédente (par exemple après l'ouverture d'un lien direct). L'éditeur de ce format n'existe plus : Dokos ne vous y ramène pas ;
  • la page précédente dans tous les autres cas, par exemple la liste ou un autre document d'où vous veniez.

Exemple fictif — Maison Verte SARL Après avoir converti « Facture Atelier » vers l'éditeur, l'équipe ouvre « Facture Atelier (Éditeur) » dans l'éditeur, puis dans son formulaire, et le supprime. La liste des Formats d'impression s'affiche, au lieu d'un retour vers l'éditeur du format supprimé.

Ce comportement repose sur l'événement de formulaire after_delete, décrit dans Scripts Client.

Limiter un format à certains rôles

Par défaut, tout utilisateur qui peut ouvrir un document peut l'imprimer avec tous les formats de son type. Pour réserver un format interne (par exemple un format qui montre les coûts et les marges), limitez-le à des rôles.

  1. Ouvrez le format d'impression.
  2. Dans la section Accès, ajoutez un ou plusieurs rôles dans le champ Rôles. La section est repliée tant qu'aucun rôle n'est renseigné. Elle n'existe pas pour un format de rapport.
  3. Enregistrez.

Pour un format de l'éditeur visuel, vous pouvez aussi renseigner les rôles dans le groupe Accès des réglages du format, puis cliquer sur Enregistrer et appliquer (voir Créer et modifier un format d'impression).

Une fois les rôles renseignés, seuls les utilisateurs qui ont au moins un de ces rôles peuvent imprimer avec le format. Un format sans rôle reste utilisable par tous.

OùPour un utilisateur sans l'un de ces rôles
Page d'impression, champ Format d'impressionLe format n'est pas proposé.
Fenêtre d'email, choix du format d'impressionLe format n'est pas proposé. L'envoi avec ce format est refusé.
Impression en masse depuis la listeLe format n'est pas proposé. Le format proposé en premier est le format par défaut du type de document s'il est autorisé, sinon Standard.
Adresse directe de la vue d'impression ou du PDF avec ce formatDokos affiche « Vous n'êtes pas autorisé à imprimer avec » suivi du nom du format (titre « Non autorisé »).
Format limité qui est aussi le format par défaut du type de documentLe format par défaut est ignoré : Dokos utilise Standard, sans message d'erreur.
La limite par rôles porte sur le choix du format, pas sur l'accès au document. Un utilisateur qui peut lire un document peut toujours l'imprimer avec les formats ouverts à tous. Les rôles se vérifient à l'impression : après avoir ajouté un rôle, testez avec un compte qui ne l'a pas.

Exemple fictif : Maison Verte SARL crée le format « Facture interne avec marges » pour le type Facture de vente. Il affiche le coût et la marge de chaque ligne. Dans Rôles, elle ajoute Responsable Comptabilité. Un responsable comptable voit le format dans la page d'impression, dans l'email et dans l'impression en masse. Un collègue sans ce rôle ne le voit pas. S'il ouvre l'adresse directe du PDF avec ce format, Dokos refuse l'impression.

Imprimer plusieurs documents dans un seul PDF

Depuis la vue liste d'un type de document, vous pouvez imprimer plusieurs documents en un seul PDF. Le PDF contient un signet par document : vous retrouvez une facture dans un long PDF sans faire défiler toutes les pages.

  1. Dans la liste, cochez les documents à imprimer.
  2. Cliquez sur Actions > Imprimer. Le bouton Actions apparaît en haut de la liste dès qu'un document est coché. La fenêtre Imprimer des documents s'ouvre.
  3. Choisissez l'En-Tête, le Format d'impression et la Taille de la page.
  4. Cliquez sur le bouton Imprimer de la fenêtre. Le PDF s'ouvre dans un nouvel onglet. Autorisez les fenêtres pop-up si le navigateur les bloque.

Conditions et limites :

  • Vous pouvez imprimer 500 documents au plus à la fois.
  • Pour un type de document soumettable, la sélection ne doit contenir que des documents validés. Si elle contient des brouillons ou des documents annulés, Dokos refuse l'impression, sauf si les paramètres d'impression autorisent l'impression des brouillons ou des documents annulés. Un administrateur n'est pas soumis à cette règle.
  • Au-delà de 25 documents, la case Impression en arrière plan (obligatoire si > 25 documents) est cochée et ne peut pas être décochée. Dokos prépare alors le PDF en arrière-plan et affiche un message avec un lien de téléchargement quand il est prêt. Gardez l'onglet ouvert pendant la préparation.
  • Un document qui ne peut pas être imprimé n'est pas ajouté au PDF. Dokos le liste dans un message à la fin de la préparation.

Signets du PDF

Dokos ajoute un signet à chaque document imprimé :

  • le signet porte le nom (l'identifiant) du document, par exemple ACC-SINV-2026-00012 ;
  • il pointe vers la première page de ce document ;
  • les documents suivent l'ordre de la sélection.

Les signets s'affichent dans le panneau latéral de votre lecteur PDF (panneau « Signets » ou « Plan du document », selon le lecteur). Ils sont ajoutés quel que soit le format d'impression ou le moteur PDF. Les pages elles-mêmes ne changent pas.

Exemple fictif : vous cochez trois factures de vente de mars dans la liste, puis vous cliquez sur Actions > Imprimer. Le PDF compte, par exemple, 1 page pour la première facture, 2 pour la deuxième et 1 pour la troisième. Le lecteur PDF affiche trois signets, un par numéro de facture. Un clic sur le deuxième signet ouvre la page 2.

Ajouter une page de couverture

Créer une page de couverture dans la démo

Une 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.

  1. Ouvrez la recherche (Ctrl+K) et saisissez Page de couverture.
  2. Créez une page : saisissez son nom et joignez le PDF.
  3. 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.

  1. Ouvrez Personnaliser un formulaire sur le tableau d'articles, par exemple Article de la facture de vente.
  2. Ajoutez un champ de type Données dont le nom technique est print_title.
  3. Cochez Autoriser les modifications après validation et Masquer à l'impression.
  4. Cliquez sur Mettre à jour.
Un champ ajouté sans nom technique reçoit un nom en 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

  1. Ouvrez Personnaliser un formulaire sur le type de document.
  2. Ajoutez un champ du type voulu (par exemple Texte) et donnez-lui un libellé.
  3. Cliquez sur Mettre à jour.
  4. Dans votre format d'impression, placez ce champ juste au-dessus du tableau des articles.