diff options
author | Étienne Loks <etienne.loks@iggdrasil.net> | 2018-12-05 10:00:35 +0100 |
---|---|---|
committer | Étienne Loks <etienne.loks@iggdrasil.net> | 2018-12-05 10:00:35 +0100 |
commit | cfc3615cb3ceb1bcbddd09a3a1fc77d93bd17d81 (patch) | |
tree | 1e92483932ff0f1c0b1f7b3af79887b0a1fab1c4 /docs | |
parent | 0a1c58cfb0c70df78b5379238ec1fc36fb961edb (diff) | |
download | Ishtar-cfc3615cb3ceb1bcbddd09a3a1fc77d93bd17d81.tar.bz2 Ishtar-cfc3615cb3ceb1bcbddd09a3a1fc77d93bd17d81.zip |
Docs-fr: doc template
Diffstat (limited to 'docs')
-rw-r--r-- | docs/fr/source/interface-administrateur.rst | 67 |
1 files changed, 67 insertions, 0 deletions
diff --git a/docs/fr/source/interface-administrateur.rst b/docs/fr/source/interface-administrateur.rst index c0d2b26c7..44cb86f29 100644 --- a/docs/fr/source/interface-administrateur.rst +++ b/docs/fr/source/interface-administrateur.rst @@ -172,5 +172,72 @@ Une fois le compte créé, les droits se spécifient dans les pages d'administra L'ouverture de l'accès aux pages d'administration se fait en cochant le « Statut équipe ». Si l'on souhaite n'ouvrir l'accès qu'à certaines pages spécifiques, on ajoute les « Permissions de l'utilisateur » correspondant aux tables que l'on souhaite ouvrir, si l'on souhaite ouvrir l'accès à toutes les tables, il suffit de cocher le « Statut super-utilisateur ». +Patrons de documents +-------------------- + +Principes de base +***************** + +Ishtar propose une génération automatisée de document. Depuis un patron au format LibreOffice (ODT), les données relatives à un élément (acte administratif, mobilier, ...) remplacent les variables du patron pour obtenir le document désiré. + +On créé le patron au format ODT avec un contenu adapté, puis depuis l'interface d'administration, sous l'entrée *Ishtar - Commun › Patrons de document › Document de référence*, on créé un patron de document avec ce fichier ODT associé au type d'élément pour lequel il est destiné. + +Le document peut alors être généré depuis n'importe quelle fiche de l'élément concerné (en haut à droite sous « Documents »). + +Un premier patron +***************** + +Pour créer un patron, la première étape est de récupérer toutes les variables disponibles pour l'élément à partir duquel on veut générer un document. Il existe pour cela un `document de référence`_ que l'on peut attacher à l'élément pour lequel on souhaite éditer un nouveau document. + +.. _document de référence: https://gitlab.com/iggdrasil/ishtar/raw/master/archaeological_operations/tests/document_reference.odt + +.. note:: En cas d'indisponibilité du lien pour ce document, ce document est très simple et peut être recréé facilement, il suffit d'insérer : ``{{VALUES}}`` dans un document ODT vide et de sauvegarder le document. + +Depuis *Ishtar - Commun › Patrons de document › Document de référence*, on ajoute un nouveau patron de document : « Document de référence » auquel on associe le document de référence téléchargé et le type d'élément pour lequel on souhaite créer un patron de document. + +Ensuite, il faut récupérer un document de référence généré depuis la fiche d'un élément contenant tous les champs que l'on souhaite exploiter. + +On ouvre ce document sous LibreOffice. Le document produit contient une liste de clé avec la valeur associée concernant l'élément que l'on a choisi. + +Les différentes clés vont permettre de constituer un patron répondant à ce qui est attendu. Pour cela reprendre un exemple du document que l'on souhaite générer (toujours au format ODT) et remplacer chaque occurence d'une valeur par la clé entourée de deux acccolades, exemple : :: + + Je, sousigné, {{nom_de_ma_clef_1}}, vous accorde un prêt de {{nom_ma_clef_2}}. + +Une fois quelques substitutions faites, on peut l'enregistrer et créer le patron dans l'interface d'administration Ishtar. Ce premier patron est alors disponible depuis la fiche des éléments. + +Notions avancées +**************** + +Parcours de liste ++++++++++++++++++ + +Certaines clés peuvent parfois renvoyer à des listes d'éléments, chacun ayant des attributs. On peut alors parcourir cette liste d'élément de cette manière : :: + + {% for element in liste_elements %} + {{element.nom}} - {{element.prenom}} + {% endfor %} + +Cela se structure autour des mots clés ``for``, ``in`` et ``endfor``. Au lieu de doubles accolades, ``{%`` et ``%}`` encadrent ces mots clés. + +Conditions +++++++++++ + +{% if already_paid %}YOU ALREADY PAID{% else %}YOU HAVEN'T PAID{% endif %} + + +Images +++++++ + +Secretary allows you to use placeholder images in templates that will be replaced when rendering the final document. To create a placeholder image on your template: + + Insert an image into the document as normal. This image will be replaced when rendering the final document. + Change the name of the recently added image to a Jinja2 print tag (the ones with double curly braces). The variable should call the image filter, i.e.: Suppose you have a client record (passed to template as client object), and a picture of him is stored in the picture field. To print the client's picture into a document set the image name to {{ client.picture|image }}. + + To change image name, right click under image, select "Picture..." from the popup menu and navigate to "Options" tab. + + + + + .. TODO: Profil d'instance Ishtar |