jPicEdt 1.6-pre1: User Pre/Postamble

2.2 Format de sauvegarde, utilisation des prologue et épilogue utilisateur

L’utilisation des prologue et épilogue utilisateur suppose de modifier “à la main” le fichier de sauvegarde sans l’endommager. Ceci est réservé aux utilisateurs avertis. De plus, cette manipulation est d’autant plus délicate que la version actuelle de jPicEdt ne détecte pas la modification du fichier en dehors de jPicEdt, et ne vous invite donc pas à recharger un fichier plus récent que votre dernière modification avec jPicEdt, ni ne vous avertit contre l’écrasement d’un fichier de sauvegarde de dessin modifié à l’extérieur de jPicEdt.

Alors que de base un fichier dans un format de sauvegarde peut être directement inclus dans un fichier LaTeX avec une commande \input{nom_du_fichier_jpicedt}, il est également possible d’y insérer un prologue et un épilogue utilisateur de sorte à en faire un fichier LaTeX maître.

Le prologue et l’épilogue utilisateur ne sont pas interprété par jPicEdt, il peuvent donc en fait comprendre n’importe quel texte, notamment le prologue utilisateur peut être un prologue classique de document LaTeX, c’est à dire la portion de code allant de \documentclass à \begin{document}, et un épilogue classique de document LaTeX, c’est à dire la portion de code comprenant le \end{document}. De la sorte le fichier de sauvegarde peut compiler directement avec LaTeX comme un fichier maître.

La figure ci-dessous donne un exemple de la composition d’un fichier jPicEdt dans un format de sauvegarde:

Le contenu du fichier jPicEdt correspondant à cette figure peut être téléchargé ici : help.RedStar.jpe.pstricks.

Il est illustré ci-après :

Disposition d’un fichier en format de sauvegarde

Ce fichier comprend sept parties consécutives :

Tout d’abord un prologue utilisateur. Ce prologue est par défaut vide, et le seul moyen de le renseigner est d’éditer le fichier avec un programme d’édition de texte, comme par exemple EMACS. Vous pouvez mettre n’importe quel code LaTeX valide dans ce prologue, jPicEdt ne l’interprète pas. Toutefois les deux usages typiques du prologues utilisateur sont les suivants :
- Ajouter un commentaire contenant une clef interprétée par un système de gestion de versions de fichiers pour étiquetter le fichier par sa version d’archivage. Dans l’exemple ce commentaire est celui-ci :
```
% Version: $Id: help.RedStar.jpe.pstricks,v 1.1 2013/02/26 22:16:59 vincentb1 Exp $
```
- Ajouter un prologue LaTeX classique, de sorte à permette à compiler directement le fichier pour produire une image comme ceci :
```
latex -jobname=RedStar help.RedStar.jpe.pstricks
dvips -E RedStar.dvi -o RedStar.eps
```
  Notez que :
  - L’option -jobname=RedStar passée à la commande latex n’est nécessaire que parce qu’on désire changer la racine du nom de fichier, il n’y en aurait pas eu besoin si le fichier s’était nommé directement RedStar.tex ce que jPicEdt n’empêche pas.
  - Le prologue LaTeX est encapsulé dans un :
```
\ifx\JPicIsIncluded\undefined
   …    …    …    …   …
\fi
```
    de sorte à ce que le fichier puisse non seulement être compilé comme un fichier maître mais aussi inclus via la commande \input{…} dans un autre fichier maître dans le préambule duquel on aura mis à cet effet :
```
\newcommand*\JPicIsIncluded{}
```
- Deuxièmement, le fichier contient une balise permettant de détecter le format du fichier et le début du code JPIC-XML, comme ceci :
```
%%Created by jPicEdt 1.6-pre1: mixed JPIC-XML/LaTeX format
%%Mon Feb 25 21:15:38 CET 2013
%%Begin JPIC-XML
```
- Troisièmement le code JPIC-XML enfoui lui-même.
- Quatrièmement une balise séparant le code JPIC-XML enfoui du code LaTeX d’export comme ceci :
```
%%End JPIC-XML
```
- Cinquièment le code LaTeX d’export, c’est cette partie que LaTeX compile pour produire l’image correspondant à votre dessin.
- La présence de la sixième et la septième partie est optionnelle, la sixième partie est une balise séparant le code LaTeX d’export de l’épilogue utilisateur, comme ceci :
```
%%User Data
```
- La septième partie est l’épilogue utilisateur, pour que jPicEdt le conserve il est nécessaire que la balise constituée de sixième partie soit présente. L’utilisation typique de l’épilogue utilisateur est par exemple :
  - Un épilogue LaTeX classique correspondant au prologue LaTeX au sein de la première partie s’il y en a un, ici il s’agit de :
```
\ifx\JPicIsIncluded\undefined
\end{preview}
\end{document}
\fi
```
    Notez que — autant être cohérent — pour cet épilogue LaTeX on a utilisé la même astuce de l’encapsulation dans un \ifx\JPicIsIncluded\undefined … \fi que pour le prologue LaTeX.
  - Des commentaires spéciaux interprétables par le programme d’édition de texte ou le système de gestion de versions de fichier que vous utilisez, dans l’exemple il s’agit de la déclaration de “variable fichiers” interprétable par l’éditeur EMACS :
```
%%% Local Variables:
%%% mode: latex
%%% eval: (TeX-PDF-mode 0)
%%% End:
```