Modèles de documents

Un modèle de document se compose de trois parties :

  • en-tête
  • corps
  • pied de page

L'en-tête et le pied sont à créer une seule fois. Le corps sera propre à chaque type de document.

Un nouveau modèle

Le corps du modèle se défini en créant un contenu de type Modèle dans le sous-menu d'OPAGA à gauche.

Le titre est celui qui sera utilisé ensuite dans OPAGA pour désigner le document. Il n'est pas intégré automatiquement dans le document, c'est à vous de choisir son emplacement en utilisant le mot-clé document:titre.

Options de modèle

Le premier bloc vous permet de définir certaines options dont le contexte d'utilisation du document :

  • type de contrat, direct ou en sous-traitance ;
  • l'entité concernée (il peut y en avoir plusieurs), c'est-à-dire dans quel onglet sera géré ce document ;
  • qui doit signer (sachant qu'actuellement, une signature par le responsable bloque la création du document final par le formateur).

Par exemple, la convention de formation est un contrat géré en direct, pour une personne morale. Elle doit apparaître au niveau du client et doit être signée par le responsable et le client au minimum (vous pouvez également envisager une signature par le formateur).

Autre exemple, le contrat de formation à titre individuel est un contrat géré en direct, pour une personne physique. Le destinataire est à la fois client et stagiaire. Il apparaît au niveau du client ()

Ainsi que d'autres options :

  • l'orientation du papier ;
  • peut-être d'autres…

Rédigez

Vous pouvez rédiger directement dans l'éditeur de texte correspondant à la partie concernée. Cependant, il est plus probable que vous ayez déjà des modèles de document au format traitement de texte. Dans ce cas, vous pouvez copier-coller leurs contenus.

Attention au copié-collé

La copie depuis un traitement de texte importe également tout un tas de styles qui vont perturber le rendu des documents PDF. C'est pourquoi est activé par défaut le bouton Coller en texte (icône rouge avec un T). Vous devrez donc refaire la mise en forme de votre texte.

Utilisez des mots-clés

Vos modèles doivent être remplis avec des informations collectées auprès des clients, des stagiaires voire définies au niveau des sessions. pour tous ces champs utilisés les mots-clés à votre disposition à droite de l'éditeur de texte. Ils sont rangés par entité.

Certains mots-clés peuvent accepter un paramètre (cela est indiqué lorsque vous passez la souris sur le bouton du mot-clé) comme par exemple of:logo:30 qui affiche le logo de l'OF avec une largeur de 30mm.

Il n'est pas possible pour vous d'ajouter de nouveaux mots-clés permettant d'extraire des données depuis la base, à moins de modifier le code source d'OPAGA. Si vous avez besoin de nouveaux mots-clés, n'hésitez pas à prendre contact avec l'auteur.

Insérez un mot-clé

La liste des mots-clés se trouve à droite de la zone de saisie du texte. ils sont classés par entité où se trouve la donnée (par exemple, toutes les informations de tarif se trouvent au niveau du client). Cliquez sur le nom d'une entité pour ouvrir la sous-liste.

Les noms peuvent paraître un peu abscons parfois. Si c'est le cas, passez la souris sur un mot-clé et l'infobulle vous donnera plus de détails.

Cliquez sur le bouton du mot-clé pour l'ajouter dans l'éditeur de texte, à l'endroit où se trouve le curseur (pensez à bien positionner votre curseur avant).

Notez que les accolades apparaissent dans l'éditeur pour rendre visible les limites du mot-clé. Elles ne sont pas présentes dans le texte, c'est seulement pour l'affichage dans l'éditeur.

Structure technique d'un mot-clé

Un mot-clé est constitué du nom de l'entité support suivi d'un deux-points suivi de la donnée recherchée. Ce mot-clé est inséré dans le modèle avec un style nommé keyword affiché dans l'éditeur en rouge et entouré d'accolades (notez que les accolades ne sont pas dans le texte, seulement dans le style). Ce style est indispensable pour la détection des mots-clés lors de la création du document.

Veillez à toujours bien conserver ces styles ! Il vaut mieux effacer un mot-clé qui vous parait défectueux puis le recréer plutôt que d'essayer de le réparer.

Paramétrez un mot-clé

Certains mots-clés acceptent un paramètre pour modifier leur comportement. Cette information est présente dans l'infobulle.

Par exemple, pour les tarifs et autres montants, vous ajouter les paramètres suivants :

  • ht : le montant sera affiché hors taxes (comportement par défaut) ;
  • ttc : le montant est affiché avec la TVA, si toutefois votre organisme est concerné (sinon, la valeur sera la même que HT) ;
  • tva : affiche le montant de la TVA.

Ainsi, à partir du mot-clé client:tarif_total_chiffre il faut ajouter :ttc à la fin pour avoir le montant en TTC.

Voici un exemple :

En contrepartie de cette action de formation, l’employeur s’acquittera des coûts suivants :

Coût pédagogique par stagiaire : client:tarif_stagiaire:ht € HT

Soit un total de : client:tarif_total_chiffre:ht € HT plus TVA à client:tarif_total_chiffre:tva (of:tauxtva%)

TOTAL GÉNÉRAL : client:tarif_total_chiffre:ttc € TTC

Mots-clés personnalisés

Si vous ne pouvez créer vous-même de mot-clé traités automatiquement, vous pouvez cependant créer des mots-clés personnalisés. Ces derniers sont obligatoirement rattachés à l'entité Document et nécessiteront une action de la part du/de la formatrice ou toute autre personne créant les documents : un formulaire permet, pour chaque document dont le modèle contient des champs personnalisés, de renseigner les informations demandées (voir Complétez les paramètres personnalisés).

Dans l'entité Document utilisez le mot-clé document:personnalisable puis remplacez personnalisable par ce que vous souhaitez. Notez que tant qu'il n'est pas reconnu comme un mot-clé personnalisé, le fond du texte est gris.

Enregistrez votre modèle via la boîte WordPress Publier (bouton Publier ou Mettre à jour). Au rechargement de la page vous voyez apparaître un nouveau bloc dans les options.

Insérez des conditions de test

Pour ajouter un peu de souplesse dans vos modèles vous pouvez utiliser des conditions de test. Par exemple, si telle valeur vaut tant, alors on affiche tel tel texte, sinon tel autre.

Comme exemple concret, prenons la convention de formation. Parfois il est nécessaire de faire apparaître les noms des stagiaires, parfois ce n'est pas utile (voire compliqué si tous les noms ne sont pas connus au moment de la signature).

Pour cela procédez comme suit : ouvrez le bloc de mots-clés Tests et conditions puis insérez le mot-clé Est vrai.

Le mot-clé est inséré, il faut en adapter le contenu. Un mot-clé de test est composé de trois parties séparées par le caractère barre verticale | :

  • la condition de test qui se décompose elle-même en :
    • operande1
    • un éventuel signe de comparaison
    • operande2
  • le texte affiché si la condition est validée
  • le texte affiché si la condition n'est pas valide

Les textes à afficher sont facultatifs : on peut choisir de ne rien afficher si la condition n'est pas valide.

Les signes de comparaison

Voici, pour information, la liste des signes de comparaisons, directement issus du langage PHP.

  • == : est égal à
  • > : est supérieur à
  • < : est inférieur à
  • >= : est supérieur ou égal à
  • <= : est inférieur ou égal à
  • != : est différent de

Pas de signe pour tester si un opérande est vrai ou faux. Si l'opérande testé est vide ou égal à 0, il est considéré comme faux.

Il n'existe pas de mot-clé pour déterminer si les noms des stagiaires doivent être inclus ou non. Il faut donc créer un mot-clé personnalisé.

Sélectionnez le texte operande1 operande2 et insérez le mot-clé document:personnalisable (dans un test vrai ou faux, il n'y a qu'un seul opérande).

Remplacez personnalisable par ce que vous voulez. Disons affiche les stagiaires. Ne vous inquiétez pas des espaces et accents éventuels, le mot-clé est nettoyé automatiquement. Mettez à jour (enregistrez) le modèle depuis la boîte Publier puis Mettre à jour.

La boîte Mot-clés personnalisés apparaît sous les options du modèle.

Définissez avec précision la description : c'est elle qui est affichée dans le formulaire demandant aux formateur⋅trices de définir une valeur pour ce mot-clé. Il faut donc être précis.

Il s'agit ici d'une question dont la réponse sera oui ou non. Vous pouvez préciser une valeur par défaut ou non.

Enfin, le mot-clé ainsi défini apparaît désormais dans la liste des mot-clés de l'entité Document pour ce modèle de document uniquement.

Insérez des lignes formatées

Le menu Format de l'éditeur propose d'insérer des lignes préformatées :

  • Ligne flexible : comme une ligne de tableau mais la largeur des cases s'adapte au contenu.
  • Ligne de signatures : identique à la ligne flexible mais avec une hauteur minimale de 35 mm afin d'avoir la place physique de signer.
  • Bas de page : un simple bloc dont le contenu sera inséré en bas de page dans le PDF.

Prenons comme exemple la ligne de signatures. Vous pouvez créer autant de cases que vous le souhaitez en pressant Entrée. Si vous souhaitez aller à la ligne dans une même case, utilisez Shift + Entrée.

Chaque case peut être alignée à gauche, à droite ou centrée (utilisez les boutons d'alignement). Les flèches vertes vous indiquent l'alignement (droite et gauche pour le centrage).

Notez que les contours en pointillés comme les flèches n'apparaissent pas dans le document final. Ce ne sont que des repères pour vous aiguiller.

La ligne bas de page est un simple cadre, dont le contenu sera inséré en pied de page.

Feuilles d'émargement

Le cas des feuilles d'émargement est particulier. En effet, vous définissez un modèle qui peut se reproduire sur plusieurs pages.

L'emploi d'un mot-clé tel que client:emargement_collectif entraîne le calcul du nombre de pages et la duplication du modèle afin de répartir tous les stagiaires et créneaux horaires sur plusieurs pages.

En-tête et pied de page

Ces deux parties se définissent dans les options générales puis l'onglet Options PDF.

Hormis les mots-clés personnalisables qui n'ont pas d'utilité pour ces parties, la rédaction de l'en-tête et du pied de page est identique à celle du contenu.