Voir la source de Modèle de courrier pour créer vos PDF V2/Documentation utilisateur

= Présentation du module =

* Modèle de courrier est un module pour Dolibarr 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.
Modèles de courrier 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 courrier
** 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

* [http://dolibarr.atm-consulting.fr Plateforme de test]

* Prochainement disponible sur [ Dolistore]

* Retrouvez également le [http://wiki.atm-consulting.fr/index.php/Guide_installation_de_module/Guide_installation_de_module 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 "''Modèles de courriers''".

[[Image:Mcv2.1.png|center|thumb|1300px|Modèle de courriers pour créer vos PDF V2 - Configuration]]


* Cliquez sur l'icône [[Fichier:Mcv2.3.png]] en bout de ligne pour accéder au détail de la configuration.

[[Image:Mcv2.2.png|center|thumb|1300px|Modèle de courriers pour créer vos PDF V2 - Configuration]]


* C'est ici que vous aller pouvoir créer votre en-tête et pied de page par défaut.

[[Image:Mcv2.4.png|center|thumb|1300px|Modèle de courriers pour créer vos PDF V2 - Personnalisation entête et pied de page]]


* 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 courrier.


= Utilisation du module =


* Les fonctionnalités du module Modèle de documents sont accessibles depuis le menu principal de Dolibarr par l'onglet "'''Modèles de courriers'''" :

[[Image:Mcv2.5.png|center|thumb|1300px|Modèle de courriers pour créer vos PDF V2 - Menu principal]]


* 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 : 

[[Image:Mcv2.7.png|center|thumb|800px|Modèle de courriers pour créer vos PDF V2 - Menu secondaire]]

* Nous allons détailler ici les différentes entrées de ce menu.


== Liste des modèles de courrier ==


* En cliquant sur "'''Modèles de courriers'''" on accède au 6 derniers modèles créés, et en cliquant sur "'''Liste des modèles de courrier'''", on accède à l'intégralité des modèles existants.

[[Image:Mcv2.9.png|center|thumb|800px|Modèle de courriers pour créer vos PDF V2 - Menu secondaire]]


[[Image:Mcv2.10.png|center|thumb|1300px|Modèle de courriers pour créer vos PDF V2 - Liste des modèles de courriers]]


* 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 :


[[Image:Mcv2.11.png|center|thumb|1300px|Modèle de courriers pour créer vos PDF V2 - Liste des modèles de courriers]]


* 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) :

[[Image:Mcv2.12.png|center|thumb|1300px|Modèle de courriers pour créer vos PDF V2 - Liste des modèles de courriers]]


   Le module propose 4 modèles, type que vous pouvez réutiliser en les clonant.

== Nouveau modèle de courrier ==


* Pour créer un nouveau modèle de courrier, cliquez sur l'entrée du menu secondaire "'''Nouveau modèle de courrier'''".

[[Image:Mcv2.14.png|center|thumb|1300px|Modèle de courriers pour créer vos PDF V2 - Nouveau modèle de courrier]]


   Pour rappel, vous disposez dans la liste des modèles de courriers 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'''".

[[Image:Mcv2.15.png|center|thumb|1300px|Modèle de courriers pour créer vos PDF V2 - Nouveau modèle de courrier]]


* 4 onglets sont à votre disposition pour modifier les différents éléments de votre courrier :
** le corps du courrier, onglet "'''Modèles de courriers'''"
** 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 courriers. 


=== Création des chapitres ===


* Un modèle de courrier 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'''" :

[[Image:Mcv2.16.png|center|thumb|1300px|Modèle de courriers pour créer vos PDF V2 - 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.

[[Image:Mcv2.17.png|center|thumb|800px|Modèle de courriers pour créer vos PDF V2 - Nouveau chapitre]]


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

[[Image:Mcv2.19.png|center|thumb|1300px|Modèle de courrier pour vos PDF V2 - Tags et options]]


* 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 [[Fichier:mcv2.20.png]] et [[Fichier:mcv2.21.png]].

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

[[Image:Mcv2.23.png|center|thumb|1300px|Modèle de courrier pour vos PDF V2]]


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

[[Image:Mcv2.24.png|center|thumb|1300px|Modèle de courrier pour vos PDF V2]]

== Liste des courriers ==

* En cliquant dans le menu secondaire sur "'''Liste des courriers'''", 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é.

[[Image:Docedit15.png|center|thumb|1300px|DocEdit - Liste des documents]]

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

[[Image:Docedit16.png|center|thumb|1300px|Modèle de courriers pour créer vos PDF V2 - Génération en masse]]

= Édition d'un modèle =


* Une fois le modèle terminé, vous pourrez l'éditer depuis la liste des modèles de courrier en cliquant sur l'un des accès disponibles :

[[Image:Mcv2.11.png|center|thumb|1300px|Modèle de courriers pour créer vos PDF V2 - Liste des modèles de courriers]]

= Création des courriers 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'''" :

[[Image:Mcv2.29.png|center|thumb|1300px|Modèle de courrier pour vos PDF V2 - Fiche proposition]]


* Cliquer ensuite sur "'''Générer'''" pour créer le courrier correspondant. Si vous cliquez ensuite sur "'''Envoyer par mail''''", ce sera alors le modèle utilisé dans votre envoi de mail.

* Ce nouveau courrier est alors accessible dans la liste des courriers dans l'onglet "'''Courrier'''".

[[Image:Mcv2.28.png|center|thumb|1300px|Modèle de courrier pour vos PDF V2 - Onglet "Courrier" d'une fiche]]

== Depuis l'onglet "Courrier" de la fiche ==


* Il faut se rendre sur l'onglet "'''Courrier'''" de votre fiche en cours, dans l'exemple suivant nous sommes sur une fiche proposition :

[[Image:Mcv2.25.png|center|thumb|1300px|Modèle de courrier pour vos PDF V2 - Onglet "Courrier" d'une fiche]]


* Puis dans le menu déroulant sélectionnez le modèle correspondant, et cliquez sur le bouton "'''Sélectionner le modèle'''".

[[Image:Mcv2.26.png|center|thumb|1300px|Modèle de courrier pour vos PDF V2 - Onglet "Courrier" d'une fiche]]


* 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 :

[[Image:Mcv2.27.png|center|thumb|1300px|Modèle de courrier pour vos PDF V2 - Onglet "Courrier" d'une fiche]]


* 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''.


[[Image:Mcv2.28.png|center|thumb|1300px|Modèle de courrier pour vos PDF V2 - Création du PDF]]


* Vous pouvez également y accéder depuis l'entrée du menu secondaire [http://wiki.atm-consulting.fr/index.php/Mod%C3%A8le_de_courrier_pour_cr%C3%A9er_vos_PDF_V2/Documentation_utilisateur#Liste_des_courriers Liste des courriers]

* 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 : - version 2.0