Ce que permet le module
- Personnalisation de vos documents
- Créer des documents PDF
- Ajouter des lignes de documents (devis, factures, commandes) dans vos modèles
- Ajouter une liste de règlements dans le modèle de document
- Faire un en-tête et pied de page personnalisé
- Opter pour un format paysage
Présentation Détaillée
Prérequis :
Pour une utilisation optimale du module, il est recommandé d’activer le module éditeur WYSIWYG natif de Dolibarr.
DocEdit vous permet de créer vos modèles de document pour vos propositions commerciales, factures, contrats et documents Agefodd.
Le module possède une prévisualisation du gabarit de notre modèle, mais celle-ci n’est pas le rendu final que nous obtenons sur la mise en page du PDF, il est donc nécessaire d‘ouvrir plusieurs onglets et de régulièrement passer d’un onglet à l’autre afin de régénérer votre document au format PDF et de voir le rendu final de celui-ci.
L’ accès au module se fait en cliquant sur l’entrée : « DocEdit » du menu principal
Liste des modèles de document
En cliquant sur le sous menu (à gauche) : Liste des modèles de document, vous accédez à l’intégralité des modèles existants. Pour faire afficher le détail, vous pouvez cliquer sur son titre et/ou sur l’icône en forme de crayon en bout de ligne.
Nouveau modèle de document
Sur le menu secondaire cliquez sur l’entrée : Nouveau modèle de document, afin d’accéder au formulaire de création d’un nouveau modèle. Vous pouvez également partir d’un modèle existant en le clonant. Pour illustrer cette documentation nous utiliserons un modèle de type « Commande client » avec les propriétés suivantes :
- Type d’objet pour le modèle de document : Type d’objet dolibarr sur lequel apparaît le document :
- Contrat
- Tiers
- Contact
- Proposition commerciale
- Facture
- Commande client
- Commande fournisseur
- Demande de prix
- Titre : Commande – ATM
- Utiliser le format paysage : Permet de basculer le document en paysage, par défaut il sera en portrait.
- Document par défaut : Permet de définir si ce modèle sera utilisé par défaut, remplace le modèle standard dolibarr.
Cliquez sur le bouton CRÉER.
Une fois le modèle créé je me trouve sur la fiche de mon modèle, je peux modifier les informations et options indiquées à la création.
Création d’un entête sur mon modèle
Cliquez sur l’onglet Entête.
Cliquez sur « Utiliser un entête personnalisé » , si la case n’est pas cochée par défaut, l’en-tête utilisé sera celui des documents standard Dolibarr.
Mon entête sera composé de deux sections.
Une 1ère section avec les éléments suivants :
- un logo
- l’intitulé de mon document
- ses références
Une 2ème section avec les éléments suivants :
- les informations de l’émetteur
- les informations du destinataire
NB : Il est également possible de créer un entête et un pied de page personnalisé par défauts définis dans les paramètres du module DocEdit, voir configurer un entête personnalisé.
Alignement des éléments
Afin d’aligner les éléments, il est nécessaire d’utiliser des tableaux. Les étapes de création de ma 1ère section sont :
- Création d’un tableau avec les propriétés suivantes, Voir créer un tableau
- 1 ligne et 2 colonnes
- Taille de la bordure : 0
- Espacement entre les cellules : 1
- Marge interne des cellules : 7
- Insérer l’image dans la 1ère cellule Voir Ajouter une image
- Régler la taille de mon tableau à 100%, afin qu’il prenne toute la largeur de mon document
- Insérer les informations de mon document. Voir les variables de substitution
Les étapes de création de ma seconde section sont :
- Créez un second tableau avec les propriétés suivantes, voir créer un tableau
- 1 ligne et 2 colonnes
- Taille de la bordure : 0
- Espacement entre les cellules : 1
- Marge interne des cellules : 5
- Régler la taille de mon tableau à 100%, afin qu’il prenne toute la largeur de mon document
- À l’intérieur des deux cellules, créez un second tableau avec les propriétés suivantes :
- Première cellule, voir propriétés des cellules
- 1 ligne et 2 colonnes
- Taille de la bordure : 0
- Espacement entre les cellules : 1
- Marge interne des cellules : 5
- Couleur d’arrière-plan : rgb (204, 204, 204)
- Ajouter des tags pour la génération des données dans le document PDF :
- {mycompany_name} → Le nom de ma société
- {mycompany_address} → L’adresse de ma société
- {mycompany_zip} {mycompany_town} → le code postal et la ville de ma société
NB : Les variables de substitution seront remplacées uniquement si toutes les données sont disponibles sur la fiche de mon tiers. Dans le cas contraire, une ligne vide sera affichée.
- Deuxième cellule :
- 1 ligne et 2 colonnes
- Taille de la bordure : 1
- Espacement entre les cellules : 1
- Marge interne des cellules : 5
- Ajouter des tags pour la génération des données dans le document PDF :
- {cust_company_name} → nom/libellé du tiers
- {cust_contactclient} → Contact du tiers définis dans l’onglet contact/adresse de mon document
- {cust_company_address} →Adresse de mon tiers
- {cust_company_zip} {cust_company_town} → Code postal et ville de mon tiers
- Régler leurs tailles à 100%, afin qu’il prenne toute la largeur de leurs cellules respectives
NB : Toutes ces informations sont disponibles dans Accueil → Configuration → Société/Organisation.
Résultat sur mon document PDF :
Création d’un tableau
Etape 1 : Sélectionnez l’outil tableau dans mon éditeur de texte enrichi
Etape 2 : Entrer les valeurs adaptées à vos besoins
NB : Voir exemple de tableau ici.
Afin de réaliser des mises en pages complexes, il sera nécessaire d’utiliser des tableaux imbriqués. Voir exemple de création d’une entête.
Propriétés des cellules
Pour accéder au propriétés des cellules il faut :
- Placez-vous dans une cellule de votre tableau
- Utiliser le clique droit de votre souris
- Sélectionnez Cellule → propriétés de la cellule
Détails de la fenêtre :
- Zone pour définir la dimension de ma cellule, en pixel ou pourcentage
- Alignement de mon contenu horizontalement et verticalement
- Définir la couleur d’arrière-plan de la cellule et la couleur de la bordure
Ajouter une image
- Positionnez le curseur à l’emplacement de votre image
- Cliquez sur l’outil image de l’éditeur de texte
- Un fenêtre Propriétés de l’image s’ouvre
- Cliquez sur « Parcourir le serveur »
Une seconde fenêtre s’ouvre, vous accéder au stockage de votre instance Dolibarr. Pour Uploader une image sur le serveur de votre instance procéder comme suit :
- Cliquez sur le bouton choisir fichier, la fenêtre de l’explorateur de fichier de votre ordinateur s’ouvre
- Sélectionnez le fichier à envoyer sur le serveur
- Cliquez sur le bouton Upload
- Cliquez de nouveau sur le fichier à intégrer à votre modèle DocEdit
Une fois le fichier importé, il est possible d’ajuster les données suivantes :
- Largeur et hauteur : Les proportions seront conservées si le cadenas est verrouillé
- Ajout d’une bordure : plus la valeur est élevée plus la bordure sera épaisse
- Espacement Horizontal / vertical : Décalage de l’image
- Alignement par rapport à la cellule ou l’ensemble du document
- Zone d’aperçu de l’image
- Validation des propriétés
Pensez bien à générer le document PDF afin de voir le rendu final, celui-ci peut être différent sur l’éditeur de document, ajuster au besoin.
Ajouter d’informations relatif au document – Variable de substitution
Les informations du document sont générées dynamiquement par Dolibarr.
Exemple :
- Date de création
- Référence du document
Afin de pouvoir intégrer ces données, il est nécessaire d’intégrer des variables de substitution ou tags. Ce sont des clefs permettant l’ajout de données de manière dynamique. Pour retrouver la définition de ces clés, un champ « Tag » est présent dans la création de mon modèle :
Pour accéder à la liste, cliquez sur le logo Afficher les tags </> (fig n°2).
Une fenêtre de type pop-in s’ouvre divisée en catégories.
NB : La liste des catégories disponibles s’affiche en fonction du type de document que vous avez choisis et des modules actifs sur votre session.
Chaque catégories comprend une liste de tags, pour obtenir les informations d’une commande client :
- Cliquez sur la section Commande Client
- Vous trouvez ici la liste des tags disponibles
- Cette zone vous montre les valeurs qui seront retournées lors de la génération du document
- Cliquez sur le tags souhaité afin de l’intégrer directement dans le modèle
NB : Chaque tags est accompagné d’un exemple de remplacement si la donnée est existante, on note également dans le modèle, que les tags affichent les clés et non les valeurs substituées, elles seront remplacées par les bonnes valeurs à la génération du document PDF.
Il est également possible d’appliquer une mise en forme sur les tags.
Ajout d’une image de fond
Afin d’intégrer une image de fond à tous vos documents, il faut :
- Cliquez sur l’onglet : Image de fond
- Cliquez sur : Sélect. fichiers → votre explorateur de fichier s’ouvre, choisir le fichier à intégrer
- Cliquez sur le bouton ENVOYER FICHIER
NB : Seuls les fichiers au format .pdf sont acceptés pour l’ajout d’une image de fond.
Configurer un entête ou un pied de page par défaut personnalisé
Il est possible de créer un entête ou un pied de page personnalisé par défaut dans DocEdit. Cet entête est à créer dans la configuration du module.
Prérequis : Avoir des droits administrateur
Vous rendre dans le menu Accueil → Configuration → Modules/Applications, puis rechercher le module DocEdit et cliquez sur l’icone ne forme de roue crantée.
Dans le module, repérer la configuration suivante et activée là en basculant le switch à droite :
- Un éditeur de texte apparaît au rechargement de la page :
Celui-ci s’utilise comme pour un modèle de document.
- Lors de l’activation de cette configuration et si du contenu est créé, un bouton supplémentaire apparaît dans les onglets « Entête » et « Pied de page » du module DocEdit :
En cliquant sur ce bouton remplir, le contenu sera automatiquement collé dans l’éditeur de texte du modèle courant.
Création d’un tableau complexe avec boucle
Afin de créer un document possédant plusieurs contenus dynamiques, cela peut par exemple être les lignes d’un devis, il est nécessaire de créer une boucle pour parcourir l’ensemble de ces données :
- Créer un nouveau chapitre représentant le corps de mon devis
- Je le nomme corps devis
- Je vais venir créer mon tableau qui accueillera les lignes de ma propale
- Je vais ajouter les colonnes suivantes :
- Désignation
- TVA
- P.U. HT
- Qté
- Réduction
- Total HT
Je crée pour cela un nouveau tableau avec 2 lignes et 6 colonnes.
Gestion des chapitres
Un chapitre correspond à une section de mon gabarit, afin de créer un nouveau chapitre cliquer sur le bouton suivant :
Vous serez redirigé vers un formulaire de création d’un nouveau chapitre.
Un chapitre est composé de :
- Un numéro d’ordre : ordre ordonné d’affichage de mon chapitre dans mon gabarit
- Titre : le nom de mon chapitre
- Texte : le contenu de mon chapitre
- Liste des options : Permet de créer une liste d’option dans le document
Afin de créer la structure de page adaptée à vos besoins, il est possible d’ajouter des sauts de pages.
Saut de page
Deux types de saut de page sont disponibles :
- AJOUTER UN SAUT DE PAGE : Un saut de page classique qui va reprendre l’en-tête personnalisé ou par défaut de Dolibarr.
- SAUT DE PAGE (sans répéter l’en-tête sur la page suivante) : Saut de page qui ne reprend pas d’en-tête sur la section suivante.
NB : Le bouton d’action ajouter le document pdf standard de l’élément, vous permettra de joindre un modèle par défaut du type de document sur lequel vous travailler à votre modèle.
Mode édition dans le texte
Un mode d’édition rapide est disponible via l’activation d’une configuration dans le module DocEdit. Depuis Accueil→ Configuration → Modules/Applications → DocEdit :
Un nouveau menu apparaîtra sur chacun des chapitres du gabarit :
Ce menu regroupe toutes les options présentes dans le formulaire d’ajout/modification d’un chapitre.
Il est également possible, d’éditer le contenus et la mise en forme via un éditeur de texte flottant :
NB : Pensez bien à cliquer sur l’icône disquette afin de sauvegarder vos changements.
Onglet modèle de document
L’onglet modèle de document présent dans les fiches de chaque objet Dolibarr, permet localement de modifier un modèle. Pour réaliser une modification, sélectionnez le modèle souhaité et cliquez sur « SÉLECTIONNER LE MODELE » .
Un formulaire d’édition s’ouvre :
Vous pouvez modifier vos chapitres afin d’adapter la génération de votre modèle en fonction de votre contexte local. Cliquez sur le bouton “CREER LE DOCUMENT » afin de générer votre PDF.
Celui-ci apparaît dans le tableau du dessus : “Les dernier(s) document(s) existant(s)” .
NB : Désactiver l’option suivante : “ Afficher le titre et la référence du document dans l’entête du document PDF” afin de ne pas afficher les informations du modèle de document dans le PDF.
Génération en masse
L’entrée génération en masse permet de régénérer tous les documents pour les types suivants : Tiers, Contact/Adresse et Facture sur un modèle spécifique.
- Choisir le type souhaité et cliquer sur OK :
- Choisir le modèle souhaité et cliquer sur OK :
Un formulaire d’édition s’ouvre :
Vous pouvez modifier vos chapitres afin d’adapter la génération de votre modèle en fonction de votre contexte local.
Il est possible dans le champ Titre d’ajouter un libellé qui sera affiché sur le document PDF si la case : « Afficher le titre et la référence du document dans l’entête du document PDF » est cochée.
La vue affiche une liste des documents qui vont être générés en bas du formulaire, il est possible de choisir les documents à générer via l’action en masse à droite de la liste (zone en bleu).
Cliquer sur le bouton « GÉNÉRER » afin de générer les PDF.
Une pop-in de progression de la génération des éléments s’affiche et vous affiche le message suivant à la fin de la génération :
Les documents générés sont disponible dans l’entré du menu secondaire du module « Liste des documents » :
Il seront également disponibles dans l’onglet « Modèle de document » de leur fiche respective :
Annexe sur bordure et dimension des tableaux
Exemple de tableaux :
Retrouvez l’aide à l’installation d’un module ici.
