DocEdit/Documentation utilisateur
Révision datée du 13 février 2018 à 15:49 par Berengere (discussion | contributions) (→Présentation du module)
Sommaire
Présentation du module
- DocEdit est un module pour Dolibarr permettant la personnalisation de vos documents. Il est destiné à la création de documents PDF à partir d'une trame modifiable, de balises qui seront remplacées par les données correspondant à l'élément source et des options de formatage de texte offerte par l'éditeur de texte enrichi natif. DocEdit permet l'édition de PDF depuis les tiers, contacts, propositions commerciales, factures et contrats.
- Les nouveautés de cette version V2 sont :
- 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
Informations pratiques
- Ce module fonctionne à partir de la version 5.0 de Dolibarr
- Disponible sur Dolistore
- Retrouvez également le Guide d'installation de module
Configuration du module
- Pour configurer ce nouveau module, il faut aller dans "'Accueil", puis dans le menu de gauche "Configuration" -> "Modules/Applications"; recherchez alors le module "DocEdit".
- Cliquez sur l'icône
en bout de ligne pour accéder au détail de la configuration.
- C'est ici que vous aller pouvoir créer votre en-tête et pied de page par défaut.
- Vous pourrez tout à fait définir des en-têtes et pieds de page différents dans vos modèles, comme vous le verrez par la suite.
Pour une utilisation optimale du module, il est recommandé d'activer le module éditeur WYSIWYG natif de Dolibarr.
Pensez également à gérer les droits de vos utilisateurs pour qu'ils aient accès à la consultation/modification/suppression ou l'utilisation des modèles de document.
Utilisation du module
- Les fonctionnalités du module Modèle de documents sont accessibles depuis le menu principal de Dolibarr par l'onglet "DocEdit" :
- Le menu principal affiche un tableau de bord de l’utilisation des différents modèles de documents avec :
- une liste des derniers modèles de courriers créés/modifiés
- une liste des derniers courriers générés. Vous pouvez remarquer que chaque courrier a sa propre référence.
- Vous disposez ensuite d'un menu secondaire :
- Nous allons détailler ici les différentes entrées de ce menu.
Liste des modèles de document
- En cliquant sur "DocEdit" on accède au 6 derniers modèles créés, et en cliquant sur "Liste des modèles de document", on accède à l'intégralité des modèles existants.
- On peut accéder au détail du modèle en cliquant sur son titre, son type d'objet ou sur l'icône d'édition en bout de ligne :
- Les différents onglets permettent d'accéder aux différents éléments de votre modèle pour les visualiser/modifier (corps du courrier, en-tête, pied de page, image de fond) :
Le module propose 4 modèles, type que vous pouvez réutiliser en les clonant.
- Il est possible de désactiver/activer ou supprimer un modèle : pour cela il faut éditer le modèle, puis cliquer sur le bouton souhaité Désactiver/Activer ou Supprimer. La suppression est bloquante si le modèle à supprimer est utilisé dans Dolibarr. Pour retrouver la liste des utilisations, il faut se rendre dans La liste des documents et supprimer ces courriers. Il sera alors possible de supprimer définitivement le modèle.
Nouveau modèle de document
- Pour créer un nouveau modèle de document, cliquez sur l'entrée du menu secondaire "Nouveau modèle de document".
Pour rappel, vous disposez dans la liste des modèles de document de 4 modèles type que vous pouvez cloner pour vous en inspirer.
- On sélectionne le type d'objet parmi :
- Contrat
- Tiers
- Contact
- Proposition commerciale
- Facture
- Commande client
- Saisissez ensuite le titre du futur document
- Enfin indiquez si vous souhaitez un format paysage plutôt qu'un format portrait; par défaut, si rien n'est modifié, votre document sera en format portrait.
- Vous pouvez maintenant cliquer sur le bouton "Créer".
- 4 onglets sont à votre disposition pour modifier les différents éléments de votre document :
- le corps du document, onglet "Modèles de document"
- en-tête
- pied de page
- image de fond (utiliser un PDF)
Pour rappel, l'achat du module comprend une heure d'assistance afin de vous aider dans la création / modification de vos documents.
Création des chapitres
- Un modèle de document est une succession de « chapitres ». Chaque chapitre pouvant contenir des balises et être complété d'options.
- Chaque chapitre peut aussi être formaté à votre convenance, en utilisant les fonctionnalités de l'éditeur de texte (Gras, souligné, couleur...).
- À partir d'un modèle de document, cliquez sur le bouton "Nouveau chapitre" :
- La création d'un nouveau chapitre ouvre une page permettant :
- de saisir le numéro d'ordre du chapitre dans la future édition
- d'afficher la liste des tags qui pourront être copiés/collés dans le document avec le "+"
- d'enregistrer le titre du chapitre
- de saisir le texte contenu dans le chapitre
- et de saisir les options.
Les Tags et options
Les tags (ou balises) présents dans le texte modèle seront remplacés au moment de l'édition du document par les valeurs présentent dans Dolibarr. Par exemple, la balise {mycompany_name} générera la valeur enregistrée dans le champs nom/enseigne/raison sociale/ de votre société/institution dans Dolibarr.
- Terminez la création du chapitre en cliquant sur le bouton Créer.
- Il est toujours possible de modifier ou supprimer le chapitre via les boutons disponibles
et 
.
- Répétez l'opération de création de chapitre autant de fois que nécessaire pour compléter le modèle de votre document. Plus votre document sera détaillé, plus les modifications et sa personnalisation seront faciles.
Autres options
- Il est aussi possible , suite à chacun des chapitres, d'insérer des sauts de page qui seront pris en compte lors de l'édition du document.
- Les modèles complets peuvent être clonés, c'est-à-dire copiés depuis leur élément d'origine. Le nom du nouveau modèle de document précisera qu'il est issu d'un clonage jusqu'à sa modification.
Liste des documents
- En cliquant dans le menu secondaire sur "Liste des documents", vous accédez à la liste des courriers utilisés, chaque courrier généré a sa propre référence. Vous pouvez alors filtrer votre liste par type d'objet ou par société.
Génération en masse
- La génération en masse permet de sélectionner toutes les factures pour lesquelles vous souhaitez générer en un clic les courriers correspondants. Il est possible de sélectionner une période à l'aide des filtres.
- Ceci est disponible uniquement pour les factures.
Édition d'un modèle
- Une fois le modèle terminé, vous pourrez l'éditer depuis la liste des modèles de document en cliquant sur l'un des accès disponibles :
Création des documents depuis une fiche
Depuis une fiche en cours
- Prenons l'exemple d'une fiche proposition, sur l'onglet "Fiche proposition" , on peut sélectionner directement le modèle souhaité dans l'encart "Fichiers joints" :
- Cliquer ensuite sur "Générer" pour créer le document correspondant. Si vous cliquez ensuite sur "Envoyer par mail'", ce sera alors le modèle utilisé dans votre envoi de mail.
- Ce nouveau document est alors accessible dans la liste des documents dans l'onglet "Modèle de document".
Depuis l'onglet "Courrier" de la fiche
- Il faut se rendre sur l'onglet "Modèle de document" de votre fiche en cours, dans l'exemple suivant nous sommes sur une fiche proposition :
- Puis dans le menu déroulant sélectionnez le modèle correspondant, et cliquez sur le bouton "Sélectionner le modèle".
- La page d'édition s'affiche.
- Les chapitres créés dans le modèle ont chacun leur éditeur permettant leur modification pour les adapter au contexte, et la sélection ou non des options prévues avec les cases à cocher :
- Une fois votre personnalisation terminée, vous pouvez créer la lettre avec le bouton en bas de page.
Création du PDF
- Le document créé est accessible depuis la liste des Lettres existantes.
- Vous pouvez également y accéder depuis l'entrée du menu secondaire Liste des documents
- Il est possible de générer le document en format PDF, les balises sont bien remplacées par leurs valeurs, et le texte modifié lors de la personnalisation a été pris en charge.
Historique et mise à jour
- Disponible sur Dolistore depuis le 13/02/2018 - version 2.0
