Introduction
PDF Printer est un module Dolibarr permettant de générer des documents PDF totalement personnalisables à l’aide de blocs.
Pour s’assurer du bon fonctionnement du module, veuillez vous assurer que vous disposez de la dernière version du module depuis le Dolistore.
La numérotation des versions est effectuée de la manière suivante:
- 1er nombre: version max compatible de Dolibarr;
- 2ème nombre: version majeure de PDF Printer (modification des fonctionnalités, tables SQL, …);
- 3ème nombre: corrections et mises à jour mineures;
Installation et mise à jour
Téléchargez le fichier archive «module_ancodepdfprinter-x.y.z.zip» depuis le site web DoliStore.com.
Vous pouvez, soit décompresser ce fichier dans le répertoire racine de Dolibarr ou dans le répertoire «custom», soit sélectionner ce fichier depuis l’installateur de modules de Dolibarr.
Les tables SQL du module pourront être modifiées à chaque mise à jour majeure, mais ne seront jamais supprimées automatiquement en désactivant ou en supprimant le module.
Gestion des Feuilles
| Démonstration | |
|---|---|
| Utilisateur | demo |
| Mot de passe | demodemodemo |
| URL | https://demo.dolibarr.ancode.fr |
Une feuille est une page indivisible qui peut être composée d’une ou plusieurs cellules, un peu comme un tableur office. Chaque cellule peut accueillir un gabarit.
Par exemple, il peut tout aussi bien s’agir:
- D’une planche étiquettes au format A4 sur laquelle est disposée 24 cellules (étiquettes) 70x37mm,
- D’une simple feuille A4 pour créer des documents personnalisés (1 cellule),
- Ou d’une feuille 102x152mm, détachable d’un rouleau, sur laquelle n’est disposée qu’une seule étiquette (une seule cellule).
La gestion des feuilles se trouve dans les paramètres du module. Elle permet d’ajouter, de modifier ou de supprimer des feuilles comme bon vous semble. Quelques feuilles sont d’ores et déjà disponibles par défaut à titre d’exemple.
Pour ajouter une nouvelle feuille, il suffit de renseigner les champs suivants:
- Nom: Le libellé qui sera affiché sur le formulaire d’impression;
- Orientation: L’orientation de la feuille;
- Format: Le format est la taille de la page. Il peut être indiqué de manière littérale pour les formats les plus communs (A4, A5, B2, …), ou numériquement en millimètre (210×297, 102×152, 57×32, …);
- Marges horizontales: Les marges horizontales sont les espaces hors étiquette situées à gauche et à droite de la feuille. La valeur attendue correspond à la largeur d’une des marges en millimètre;
- Marges verticales: Les marges verticales sont les espaces hors étiquette situées en haut et en bas de la feuille. La valeur attendue correspond à la hauteur d’une des marges en millimètre;
- Largeur cellule: La largeur d’une cellule en millimètre.
- Hauteur cellule: La hauteur d’une cellule en millimètre.
- Nombre de lignes: Le nombre de lignes de cellules (Soit le nombre de cellules dans une colonne).
- Nombre de colonnes: Le nombre de colonnes de cellules (soit le nombre de cellule dans une ligne).
À noter que les dimensions des marges entre-cellules sont automatiquement calculées par le module et n’ont donc pas besoin d’être renseignées.
Gestion des Gabarits
| Démonstration | |
|---|---|
| Utilisateur | demo |
| Mot de passe | demodemodemo |
| URL | https://demo.dolibarr.ancode.fr |
La gestion des gabarits se trouve dans les paramètres du module. Le gabarit contient toute la mise en forme d’un document ou d’une cellule.
La conception d’un gabarit consiste à ajouter des éléments les uns à la suite des autres, soit en renseignant leurs coordonnées, soit en indiquant leur position par rapport à l’élément précédent.
Comme les coordonnées et les dimensions de chaque élément peuvent être renseignées en pourcentage, et qu’un gabarit n’est pas lié à un format de cellule précis, un même gabarit peut s’adapter à différents formats de feuilles et de cellules.
Créer un gabarit
Pour créer un nouveau gabarit, il suffit d’indiquer le nom que vous souhaitez lui donner, ainsi que le contexte où il sera affiché.
Selon le contexte, le gabarit ne sera disponible que sur les pages compatibles.
En cliquant sur le bouton «Gabarit», on accède à la conception du gabarit.
Cette page permet de concevoir le gabarit en y ajoutant différents types d’éléments comme du texte, un code-barre ou une forme, par exemple.
Lorsque qu’un document est généré, chaque élément est traité l’un après l’autre en suivant précisément l’ordre indiqué par la séquence de positionnement des éléments.
Séquence d’agencement des éléments
L’agencement séquencé permet de placer facilement les éléments les uns à côté des autres sans avoir à renseigner systématiquement leurs coordonnées.
Ainsi, l’emplacement d’un élément peut être défini de deux façons:
- Fixe: En renseignant ses coordonnées;
- Relatif: En indiquant son emplacement par rapport à l’élément précédent (à droite, en dessous ou à la ligne suivante);
L’emplacement du premier élément devra toujours être défini en indiquant ses coordonnées (emplacement fixe).
Chaque élément fixe peut servir de point de départ d’une série d’éléments agencés de façon relative par rapport au précédent.
Paramètres par défaut du gabarit
Cette section permet de définir des paramètres par défaut à tous les éléments.
Pour le moment il s’agit uniquement de prédéfinir la famille de la police ainsi que la taille du texte.
Par défaut, lorsque ces paramètres ne sont pas définis, la famille de la police est «Helvetica» et la taille du texte est de 16 points.
Les éléments
Différents types d’éléments peuvent être insérés sur le gabarit:
- Texte: Une ligne de texte simple pouvant accueillir des variables;
- Paragraphe: Un bloc de texte de plusieurs lignes pouvant accueillir des variables;
- Rectangle: Un simple rectangle pouvant disposer de bordures et d’une couleur d’arrière plan. Il peut être utilisé pour délimiter différentes zones sur le gabarit, par exemple;
- Ligne: Un segment pouvant, par exemple, être utilisé pour barrer ou délimiter une zone sur le gabarit;
- Code-barre: Le code-barre peut représenter n’importe quelle valeur disponible, sous n’importe quel type de code-barre;
- Adresse: Cet élément n’est disponible que pour certains contextes. Il a l’avantage de formater l’adresse et d’agir comme un seul et même bloc, pour être centré plus facilement et offrir plus de possibilités de personnalisation.
Placement fixe/relatif
Comme expliqué précédemment, les éléments peuvent être placés de manière fixe ou relative.
Les coordonnées d’un élément correspondent à l’emplacement de son coin supérieur gauche (droit si RTL) sur le gabarit.
Si aucune coordonnée n’est renseignée, l’élément sera positionné au point zéro situé en haut à gauche (droite si RTL) du gabarit.
Lorsque l’élément est placé de façon relative, vous avez le choix entre trois options classiques «Sur la grille» (à droite, au-dessous, à la ligne suivante), et trois autres options spéciales «Même pente» pour agencer une série inclinée d’éléments.
Les options «Même pente» demandent plus de ressources. C’est pourquoi, je recommande de les utiliser uniquement lorsque l’on souhaite agencer une série inclinée d’éléments.
Que ce soit sur la grille ou sur la même pente, 3 choix sont possibles:
- à droite de l’élément précédent;
- au dessous de l’élément précédent;
- à la ligne suivante, après l’élément précédent: l’élément se positionne sous le premier élément (fixe) de la série;
Unités de mesure
Toutes les dimensions et coordonnées peuvent être renseignées en millimètre ou en pourcentage.
Si vous êtes amené à utiliser plusieurs formats de feuilles différents pour le même gabarit, il est possible de rendre ce dernier adaptable (responsive) en renseignant toutes ses mesures en pourcentage.
Les espacements
Sur certains éléments, il est possible de définir différents types d’espacement:
- Les marges: Ce sont les espaces situés à l’extérieur de l’élément, qui permettent de définir une zone libre autour de ce dernier;
- Les remplissages: Contrairement aux marges, ils s’agit du contour intérieur de l’élément. Ils permettent de définir un espacement entre le contenu et la bordure.
Les éléments textuels
Les éléments textuels offrent différentes options pour formater le texte. On y retrouve les options les plus classiques comme le gras, l’italique, le soulignement, la casse (minuscule ou majuscule), l’alignement horizontal et vertical ou la couleur, mais également toutes les options concernant la police de caractère.
Certaines options sont plus spécifiques, comme par exemple:
- Contenir le contenu: Lorsque la hauteur de l’élément est limitée, cette option permet de réduire automatiquement la taille de la police si nécessaire;
- Respecter le ratio: Grâce à cette option, il est possible de conserver le ratio d’origine des dimensions dans le cas où un redimensionnement automatique est nécessaire pour contenir l’élément dans l’espace disponible;
Pour générer une adresse, il est conseillé d’utiliser l’élément «Adresse» plutôt que de saisir les variables dans un ou plusieurs éléments textuels.
L’élément adresse s’occupera automatiquement du formatage de l’adresse selon le pays du destinataire. Il offre également plusieurs options de personnalisation tout en gardant la possibilité d’aligner le texte verticalement.
Les variables
Tous les éléments textuels permettent d’insérer une ou plusieurs variables en rapport avec le contexte du gabarit.
Toutes les variables disponibles sont accessibles depuis le bouton {{ }} situé à proximité du champs de saisie.
La variable s’insère automatiquement dans le champ de saisie, sous la forme d’un tag, en le sélectionnant.
La liste des variables disponibles dépend du contexte du gabarit, et sera donc différente selon qu’il s’agit d’un gabarit de produit, de tiers ou de contact, par exemple.
Si un variable vous manque, veuillez me contacter, et je ferai le nécessaire dans la mesure du possible.
Import et Export de gabarit
L’exportation et l’importation des gabarits permet notamment de sauvegarder votre gabarits en lieu sûr, mais cela permet également la création de gabarits sur un serveur différent de celui en production, par exemple.
Exporter
Il est possible d’exporter les formats de feuilles et les gabarits en cliquant simplement sur le bouton de téléchargement.
Le gabarit est alors téléchargé au format JSON. Le JSON est un format facilement éditable depuis un logiciel de texte comme le «Bloc note» de Windows, ou le logiciel «Text» des Chromebooks, par exemple.
Importer
Pour importer un gabarit, il suffit de sélectionner le fichier depuis le formulaire d’importation et de cliquer sur «Importer». Le formulaire est situé en haut de la page de chaque liste de gabarits.
Impression de documents
PDF Printer permet l’édition de documents depuis une page (et certaines listes):
- de produit,
- de lot,
- d’ordre de fabrication,
- de réception,
- de commande fournisseur,
- de tiers,
- de contacts/adresses,
- d’expédition,
- …
Sur chaque page et liste compatible, une nouvelle action nommée «Imprimer» est ajoutée.
Cette action fera apparaître un formulaire d’impression ressemblant à ceci:
Ce formulaire vous propose différents choix selon le contexte de la page. Les principales options sont:
- Le format de feuille;
- L’orientation de la feuille;
- Le gabarit d’étiquette à utiliser;
- Le point de départ: lorsque la feuille dispose de plusieurs étiquettes, cette option permet de débuter l’impression depuis n’importe quelle étiquette. L’étiquette numéro 1 se trouve en haut à gauche (droite si RTL).
- Le nombre d’exemplaire par objet;
Selon le contexte, il est possible que votre gabarit contienne un élément de type Adresse. Dans ce cas, il vous sera possible de sélectionner l’objet (ou le type d’objet) à utiliser pour générer l’adresse.
Depuis une Expédition, il est possible d’éditer une adresse expéditeur personnalisée.