Créer un modèle de document ODT

De Dolibarr Open Source ERP CRM Wiki.

Retour index
Documentation Utilisateur

File Doc user.png

Cette page décrit comment construire un modèle de document ODT pour utiliser la génération de document ODT.

Pour savoir comment générer un modèle de document PDF, voir la page Créer un modèle de document PDF. Créer un modèle PDF requiert des connaissances en programmation PHP mais pas la création de modèles ODT.

Contents

Prérequis

  • Dolibarr: 3.1+
  • OpenOffice: 3.2+, LibreOffice, ...

Créer votre document

  • Créer un document OpenOffice ou LibreOffice en partant de rien ou en prenant un example fournis. Si vous partez d'un exemple, vous les trouverez installés dans les sous-répertoires du répertoire documents/doctemplates
  • Éditer le document en utilisant toutes les fonctions de votre suite bureautique.

Inclure dans votre documents les tags des informations que vous voulez voir. Les tags seront remplacés automatiquement au moment de la génération du document par Dolibarr. La liste des tags disponibles est décrite dans le chapitre suivant.

Warning.png Attention, les tags sont entourés de {} ou [] pour les tableaux ou conditions (voir plus loin) et doivent être tapés d'une traite sous la suite Office (sans retour arrière ou effacement, ni par copié-collé). Dans le cas contraire, la suite Office ajoutera des informations invisibles qui empêche le remplacement. Il est également possible d'utiliser les copier-coller en faisant un collage spécial sans formatage (CTRL+MAJ+V).

Tags

Voici la liste des tags qui seront remplacés par les informations appropriées:

Company/foundation information

{mycompany_logo} : Your company logo
{mycompany_name} : Your company name
{mycompany_address} : Your company address
{mycompany_zip} : Your company zip
{mycompany_town} : Your company town
{mycompany_country} : Your company country (label)
{mycompany_country_code} : Your company country (code: FR, US, IT...)
{mycompany_state} : Your company state (label)
{mycompany_state_code} : Your company state (code)
{mycompany_phone}
{mycompany_fax}
{mycompany_email}
{mycompany_web}
{mycompany_barcode}
{mycompany_capital}
{mycompany_juridicalstatus}
{mycompany_idprof1}
{mycompany_idprof2}
{mycompany_idprof3}
{mycompany_idprof4}
{mycompany_idprof5}
{mycompany_idprof6}
{mycompany_vatnumber} : Your company VAT number
{mycompany_note} : Your company note

Customers, prospects or suppliers information

{company_name} : Customer or Supplier company name
{company_address}
{company_zip}
{company_town}
{company_country} : Customer or Supplier company country (label)
{company_country_code} : Customer or Supplier company country (code: FR, US, IT...)
{company_state}
{company_state_code}
{company_phone}
{company_fax}
{company_email}
{company_web}
{company_barcode}
{company_customercode} : Company customer code
{company_suppliercode} : Company supplier code
{company_customeraccountancycode} : Company customer accountancy code
{company_supplieraccountancycode} : Company supplier accountancy code
{company_capital}
{company_juridicalstatus}
{company_idprof1}
{company_idprof2}
{company_idprof3}
{company_idprof4}
{company_idprof5}
{company_idprof6}
{company_vatnumber} : Customer or Supplier company VAT number
{company_note_public} : Customer or Supplier company public note

Information utilisateur

{myuser_lastname}
{myuser_firstname}
{myuser_login}
{myuser_email}
{myuser_zip}
{myuser_town}
{myuser_country}
{myuser_country_code}
{myuser_state}
{myuser_state_code}
...

Autres informations

{current_date}
{current_datehour}
{current_server_date}
{current_server_datehour}
{current_date_locale}
{current_datehour_locale}
{current_server_date_locale}
{current_server_datehour_locale}

{__(XXX)__} = Translated value of a translation key XXX - Note: Translation must be inside a language file that was previously loaded with $langs->load("languagefile")
{__[XXX]__} = Value of constant XXX

Informations sur l'objet (facture, proposition commerciale, commande, ...)

{object_id}
{object_ref}
{object_ref_customer}
{object_ref_supplier}
{object_date}
{object_date_creation}
{object_date_modification}
{object_date_validation}
{object_note_private}
{object_note_public}
or
{object_note}

Amounts (numeric data):
{object_total_ht}
{object_total_vat}
{object_total_localtax1} (Dolibarr >= 3.5.0)
{object_total_localtax2} (Dolibarr >= 3.5.0)
{object_total_ttc}
{object_total_discount_ht}
{object_total_vat_x} (Dolibarr >= 3.5.0, is vat total for rate x. x can be for example 20, 8.5, 5.99 ...}

Amounts (in output language format):
{object_total_ht_locale} (Dolibarr >= 3.5.0)
{object_total_vat_locale} (Dolibarr >= 3.5.0)
{object_total_localtax1_locale} (Dolibarr >= 3.5.0)
{object_total_localtax2_locale} (Dolibarr >= 3.5.0)
{object_total_ttc_locale} (Dolibarr >= 3.5.0)
{object_total_discount_ht_locale} (Dolibarr >= 3.5.0)
{object_total_vat_locale_x.x} (Dolibarr >= 3.6.0, is vat total for rate x. x can be for example 20.000, 8.500, 5.990 ...}

Specific to proposals:
{object_date_end} : End date of validity of proposal

Specific to order:
{object_date_delivery_planed}  (Dolibarr >= 3.4.0)

Specific to invoices:
{object_date_limit}
{object_payment_mode}
{object_payment_term}
{object_source_invoice_ref}
{object_already_payed} : Amount already payed (numeric)
{object_remain_to_pay} : Remaining to pay amount (numeric)
{object_already_payed_locale} : Amount already payed (output language format)
{object_remain_to_pay_locale} : Remaining to pay amount (output language format)

Extra fields:
{object_options_xxx} : Value of extra field (where xxx is code of extra field)

Lignes des objets

Voici comment utiliser les tableaux de lignes des objets (lignes de factures, commandes, etc...). Vous devez créer un tableau dans le document et utiliser une balise "begin" et "end" pour définir la ligne du tableau. Cette ligne sera répétée autant de fois que requis au moment de la génération.

[!-- BEGIN row.lines --]
...
[!-- END row.lines --]

Ensuite, ajouter les tags de votre choix dans les lignes parmi ceux-ci:

{line_fulldesc}
{line_product_ref}
{line_product_label}
{line_desc}
{line_vatrate}
{line_up}
{line_up_locale}
{line_qty}
{line_discount_percent}
{line_price_ht}
{line_price_ht_locale}
{line_price_vat}
{line_price_vat_locale}
{line_price_ttc}
{line_price_ttc_locale}
{line_date_start}
{line_date_start_rfc}
{line_date_end}
{line_date_end_rfc}

Extra fields:
{line_options_xxx} : Value of extra field (where xxx is code of extra field)

Voici un exemple de ce que vous pourriez avoir dans votre traitement de texte: Line for document generation.png

Substitution conditionnelle

Vous pouvez utiliser des remplacements conditionnels, ce qui en termes simples signifie que vous pouvez décider d'imprimer quelque chose si une variable est vrai, ou imprimer autre chose si elle est fausse (ou rien du tout) - et cela marche non seulement avec du texte, mais aussi toute structure plus complexe comme les tableaux et les images.

Exemple:

[!-- IF {my_var} --]
Print this text if {my_var} is true (can be any value but null/0/empty string)
[!-- ELSE {my_var} --]
Or print this if it's false (null/0/empty string)
[!-- ENDIF {my_var} --]

Note: le tag ELSE est bien sûr optionnel, vous pouvez sans problème juste utiliser un IF/ENDIF si vous préférez.

ATTENTION: le format de cette balise spéciale est très précis et pointilleux, faire attention à mettre un seul espace entre:

  • [!--
  • IF/ELSE/ENDIF
  • {my var}
  • --]

Autres tags personnalisés

Si vous voulez ajouter un champ de substitution non prédéfini, il y a une solution:

  • Ajouter un fichier nommé

htdocs/monmodule/core/substitutions/functions_mymodule.lib.php

  • Dans ce fichier , écrivez juste une fonction du genre:
/** 		Function called to complete substitution array (before generating on ODT, or a personalized email)
 * 		functions xxx_completesubstitutionarray are called by make_substitutions() if file
 * 		is inside directory htdocs/core/substitutions
 * 
 *		@param	array		$substitutionarray	Array with substitution key=>val
 *		@param	Translate	$langs			Output langs
 *		@param	Object		$object			Object to use to get values
 * 		@return	void					The entry parameter $substitutionarray is modified
 */
function mymodule_completesubstitutionarray(&$substitutionarray,$langs,$object)
{
   global $conf,$db;
 
   $myvalue='Put here calculated value to insert';
   $substitutionarray['myowntag']=$myvalue;
}

La fonction sera appelée avant la génération du document afin de compléter le tableau des substitutions afin que le tag myowntag soit remplacé par la valeur définie dans $myvalue. Vous pouvez ajouter autant de tag que désiré, et mettre le code que vous voulez pour définir les valeurs (recherche en base, en fichier, calcul, partir des variables reçues ou globales...).

Attention: Le premier paramètre dans la déclaration de la fonction doit commencer par & car il est modifié par le code et doit être retourné modifié.

Pour que vote votre fonction de substitution soit bien appelée, il vous faut:

  • Vérifier que votre fichier de substitution est bien stocké dans le répertoire htdocs/mymodule/core/substitutions
  • Créer un module (Voir la page Développement module) avec son fichier descripteur de module.
  • Vérifier que le fichier descripteur de module contient une entrée pour déclarer qu'il y a un fichier de substitution à appeler. Cette doit être
$this->module_parts = array('substitutions' => 1)
  • Activer le module (un module doit être activé et désactivé pour prendre en compte les changement dans son fichier descripteur)

Autres tags personnalisées pour les lignes

Cette fonctionnalité est disponible depuis Dolibarr v3.3 (version de développement futur).

De manière similaire au chapitre précédent, vous devez définir une fonction de la même façon mais avec quelques différences:

  • Créez ou modifiez le même fichier que précédemment (voir le chapitre précédent).
  • Voici les différences: dans le fichier, écrire une autre fonction avec presque le même nom mais avec '_lines' en suffixe, et également ajouter une nouvelle variable $lines:
/** 		Function called to complete substitution array for lines (before generating on ODT, or a personalized email)
 * 		functions xxx_completesubstitutionarray_lines are called by make_substitutions() if file
 * 		is inside directory htdocs/core/substitutions
 * 
 *		@param	array		$substitutionarray	Array with substitution key=>val
 *		@param	Translate	$langs			Output langs
 *		@param	Object		$object			Object to use to get values
 *              @param  Object          $line                   Current line being processed, use this object to get values
 * 		@return	void					The entry parameter $substitutionarray is modified
 */
function mymodule_completesubstitutionarray_lines(&$substitutionarray,$langs,$object,$line) {
{
   global $conf,$db;
 
   $myvalue='Put here calculated value to insert';
   $substitutionarray['myowntag']=$myvalue;
}

Contrairement à la fonction précédente qui n'est jamais appelée qu'une seule fois, cette fonction sera appelée à chaque fois qu'une ligne de produit sera traitée, en vous donnant chaque fois un objet $line différent que vous pouvez traiter. Cela vous permet de faire des substitutions de tags différentes pour chaque produit.

Enregistrer votre document

Pour voir apparaitre votre modèle de document dans la liste des modèles disponibles, placer le dans le sous-répertoire adéquat qui se trouve dans le répertoire documents/doctemplates

Outils personnels
  • Ask to contact@dolibarr.org to request an account to contribute to this documentation
  • Connexion
Autres langues
AnglaisEspagnolAllemand
Pas de traduction en Allemand.
Italien
Pas de traduction en Italien.
Grèque
Pas de traduction en Grèque.
<multilanguagemanager_cn>
Pas de traduction en &lt;multilanguagemanager_cn&gt;.

Social networks
Follow us on Google+ Follow us on Facebook Follow us on LinkedIn Follow us on Twitter