Créez votre propre package

Le code minimal

Tout d'abord, commençons par la structure minimale de toute extension (pour les novices, prononcer la tek 2 epsilon) :

Code : Autre

Analyse du code minimal

Afin de mieux comprendre, rien de mieux qu'une étude ligne par ligne du code :

Spécifications de base

Code : Autre
On spécifie tout d'abord la version de LaTeX nécessaire au fonctionnement de l'extension. Dans ce cas, on demande la version 2e soit . L'argument optionnel (entre crochets) précise la date minimale de sortie du moteur TeX (ou des macros LaTeX permettant l'utilisation de l'extension crée. Ceci n'est nécessaire que si vous souhaitez utiliser des commandes présentes que dans des versions bien précises des moteurs TeX ou LaTeX.


Code : Autre
Ceci est une ligne essentielle. En effet, c'est cette ligne du code qui détermine le nom de l'extension que vous créez. Dans ce cas, le nom est très original : monPackage. Une fois de plus, l'argument optionnel permet de préciser la date de création de l'extension.
Ainsi, pour utiliser votre extension dans votre document, vous écrirez :
Code : Autre

Chargement des extensions

Code : Autre

Bien sûr que non ! Les marqueurs de commentaires ne varient pas entre les fichiers source et les fichiers d'extensions. Je ne voulais simplement pas vous donner d'exemple, et donner directement la commande sans arguments n'aurait pas été très explicite.
Je vous propose maintenant la syntaxe correcte à utiliser :
Code : Autre
Comme on peut aisément le remarquer, \RequirePackage[]{} possède la même syntaxe que \usepackage[]{} que l'on utilise dans les fichiers source "classiques".

Options

Code : Autre
Afin de déclarer les options que vous comptez utiliser, on procède comme suit :

1. Options définies

Code : Autre
Dans <nom de l'option>, on indique le mot clef à indiquer dans les arguments optionnels de la commande \usepackage[]{}.
Dans <action>, on indique l'action à réaliser si l'option est demandée.

En fait, on met bien souvent (voire toujours) une changement de valeur de booléen. Je m'explique :
Imaginons que je veuille rendre l'utilisation de l'extension hyperref (pour créer des liens hypertextes et bien d'autres choses dans mon document) optionnelle. Je crée alors un booléen auquel j'affecte la valeur false :
Code : Autre

Ensuite, lorsque je déclare mon option, j'écris :

Code : Autre
Donc, si l'option est demandée, on affecte à mon booleenH la valeur true.

Enfin, et après le \ProcessOptions, je charge l'extension hyperref, uniquement si l'option optionH est demandée :
Code : Autre

Remarque : une autre solution est présentée dans la suite du tutoriel.


2. Options indéfinies

Imaginons à présent que vous êtes polyglotte. Vous aurez donc besoin de charger des options de babel différentes (et oui, même babel est chargé par votre extension personelle !). Dans ce cas, on ne peut pas déclarer les options comme indiqué ci-dessus. On utilise donc un joker : l'étoile (*) :
Code : Autre
Évidemment, on il n'y a pas de champ <nom de l'option> à compléter !
Dans le champ <action>, on utilise bien souvent la ligne suivante :
Code : Autre
Ce qui permet de passer l'ensemble des options non déclarées explicitement à l'extension <package> souhaitée.

Puis vient la validation des options avec
Code : Autre

Commandes et environnements personnalisés

La dernière partie de votre extension est consacrée à la définition de vos propres commandes et environnements. On utilise pour ce faire les deux commandes suivantes, respectivement pour les commandes et les environnements :
Code : Autre
et
Code : Autre
La création de commandes et d'environnements n'étant pas le sujet de ce tutoriel, je ne m'étendrai pas d'avantage sur le sujet.

Et pour finir...

Eh bien on indique au compilateur que c'est fini avec :
Code : Autre
Et voilà !

Comme nous l'avons vu dans la sous-partie précédente, il faut recourir au joker étoilé pour optimiser le chargement de l'extension babel. Je vous propose ici d'étudier plus en détail ce que j'ai baptisé "l'astuce babel", afin d'en maîtriser toutes les facettes.

Gestion des langues : ce qu'il faut savoir

Vous le savez peut-être : l'extension babel, habituellement chargée, pour nous francophones par l'un des codes suivants :
Code : Autre
permet d'adapter différents paramètres (traduction des titres, gestion de la typographie,...) à la langue choisie. Cependant, babel ne se contente pas de gérer une seule langue à la fois : il est possible d'uiliser plusieures langues dans un même document.
Imaginons par exemple que je veuille écrire en français, en anglais et en allemand. Dans une source normale, j'écrirai alors :
Code : Autre
ce qui aura pour effet de charger les modules de traduction en annglais, en allemand et en français.

Euh non ! Ce serait d'ailleurs bien embêtant ! En fait, c'est la dernière langue demandée (ici francais qui est appliquée par défaut. Il aura donc marqué, si je ne précise rien : Chapitre 1. Ouf !

Changement de langue

Pour changer de langue, babel offre plusieurs possibilités :

• un environnement : Code : Autre

  1 2	\begin{otherlanguage}{<langue>} \end{otherlanguage}

• une commande : Code : Autre

  1	\foreignlanguage{<langue>}{<texte dans la langue <langue>>}

• une déclaration : Code : Autre

  1	\selectlanguage{<langue>}

Utilisation de \DeclareOption*{}

Nous allons à présent voire comment on peut utiliser intelligemment la commande \DeclareOption*{}.
Je vous propose le code suivant, que je commenterai brièvement ensuite :
Code : Autre
Comme je l'avais déjà proposé précédemment, on demande à passer l'ensemble des options non déclarées explicitement, c'est-à-dire avec une commande \DeclareOption{}{}, au package babel. Celui-ci doit donc être chargé après, comme indiqué sur le code ci-dessus, et sans aucune option.

Remarques concernant l'utilisation de "l'astuce babel".

Il existe cependant un désavantage majeur à l'utilisation de cette, par ailleurs, très utile astuce :
Vous êtes obligés de donner une option de langage à votre extension. De plus, n'oubliez pas que c'est la dernière langue entrée qui est utilisée par défaut dans votre document.
D'autre part, il est ensuite impossible de passer d'autres options non déclarées explicitement à d'autres package que babel.
Exemple : vous voulez utiliser les options non déclarées explicitement pour les extensions hyperref et babel. Dans la source de votre document, vous écrivez alors :
Code : Autre
et, lors de la compilation, vous obtenez :
Code : Console
Autrement dit, si vous ne voulez pas avoir d'erreur de compilation, il ne vous reste plus qu'à inventer la langue colorlinks !

Nous allons, pour finir, aborder un point un peu plus technique, mais pas de quoi s'arracher les cheveux, rassurez-vous. Il s'agit simplement d'approfondir un point essentiel de la création d'extensions, que j'ai auparavant quelque peu estompé : les conditions.

Les conditions en TeX.

Le système TeX de base utilise le système de conditions suivant :
Code : Autre
Explications :
on commence par créer une variable de type if, avec la commande Code : AutreCette variable possède pour nom Code : Autresoit en français : Code : AutreBen oui, il faut encore assigner un valeur à notre variable : Code : AutreDans notre cas, on assigne à notre variable la valeur true, soit vrai.

Enfin, le code devant s'éxécuter lorsque la condition est vraie est dans le bloc Code : Autre

Application aux extensions

Il est possible d'utiliser ce système de conditions dans les extensions, notamment dans la gestion des options.
Exemple :
Code : Autre
On charge l'extension xcolor si l'option color est envoyée à l'extension personnelle.

Les conditions en LaTeX.

Les conditions en LaTeX utilisent une syntaxe beaucoup plus familière.
Pour commencer, il faut charger l'extension ifthen :
Code : Autre
Ensuite, on applique le code suivant :
Code : Autre
J'utilise ici le même exemple que précédemment : on charge l'extension xcolor si l'option color est envoyée à l'extension personnelle.
En LaTeX, surcouche de TeX, l'utilisation de booléens est beaucou plus évidente :
Le booléen est crée par la commande Code : Autreon lui affecte une valeur avec Code : Autreet pour finir, on teste sa valeur avec Code : Autredans une grosse commande Code : Autre

On pourrait reprocher à la syntaxe LaTeX d'être très lourde (ceci est visible notamment dans la comparaison des deux codes donnant le même résultat présentés ci-dessus), mais il est bon de connaitre les deux syntaxes. La syntaxe TeX est majoritairement utilisée dans les squelettes des extensions et des classes, la syntaxe LaTeX l'est beaucoup plus dans les environnements, notamment car elle permet d'y voir plus clair. Enfin, chacun choisit celle qu'il préfère.

C'est bien beau de coder une extension, encore faudrait-il pouvoir l'utiliser ! Pour cela, suivez le guide :

Enregistrement

En suivant une architecture TeX classique, on enregistre les extensions personnelles dans le répertoire suivant (ici sous Windows avec une distribution TeXlive 2007) :
Code : Console
Pour les détenteurs d'autres distributions, je pense notamment à nos amis linuxiens, veillez à utiliser un répertorie similaire (le nom perso n'est pas obligatoire, vous pouvez choisir autre chose, mais sans espace de préférence). Vous trouverez quelques informations complémentaires pour l'utilisation sous Linux plus bas.

J'allais l'oublier ! Effectivement, il ne faut pas enregistrer l'extension en *.tex, qui est réservée aux sources de documents. L'extension étant un ensemble de paramètres stylistiques, on met l'extension *.sty (de l'anglais style).

Mise à jour de la base Is-R

Seconde, et donc dernière étape, il s'agit de mettre à jour la base de donnée Is-R. Pour faire très simple, cette base de données regroupe tous les chemins d'accès aux extensions, aux classes et aux polices (entres autres) de votre distribution. Ainsi, si vous voulez que le compilatuer connaisse votre extension, il faut qu'elle soit répertoriée dans Is-R.
Voici comment procéder (sous TeXLive 2007) :

• Ouvrez TeXlive Manager
• Allez dans l'onglet "Gestion de l'installation"
• Cliquez sur "Mettre à jour", dans le champ "Mettre à jour la base de donnée Is-R"
• Patientez...
• C'est fini, vous pouvez fermer TeXlive Manager

Pour les autres distributions, une démarche similaire est à effectuer.

Pour les utilisateurs de Linux

La distribution LaTeX traditionnellement utilisée sous Linux est teTeX. Cependant, elle l'est de moins en moins et cède peu à peu la main à TeXLive du fait que cette dernière est bien plus maintenue (source). Je vous recommende donc, si vous ne disposez pas encore de distribution LaTeX sous Linux, d'installer le paquet texlive (utilisateurs d'Ubuntu, c'est par ici).

La distribution installée, vous devez enregistrer votre extension personnelle dans le répertoire suivant (le perso n'est à nouveau pas obligatoire) :
Code : Console
Ensuite, comme il s'agit également de mettre à jour la base de données. Pour cela, entrez la commande suivante dans votre terminal favori :
Code : Console
Et voilà, votre extension personnelle est utilisable !

Utilisation dans un document

Votre extension personnelle s'utilise à présent de la même manière que toute autre extension. On la charge dans le préambule de la source, avec un Code : Autre tout ce qu'il y a de plus normal.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

\NeedsTeXFormat{LaTeX2e}
\ProvidesPackage{package}
\RequirePackage[latin1]{inputenc}
\RequirePackage[T1]{fontenc}
\RequirePackage{pifont}
\RequirePackage{beton}
\RequirePackage{amsmath}
\RequirePackage{amsfonts}
\RequirePackage{ifthen}
\newboolean{signature}
\setboolean{signature}{false}
\DeclareOption{signe}{\setboolean{signature}{true}}
\DeclareOption*{\PassOptionsToPackage{\CurrentOption}{babel}}
\RequirePackage{babel}
\newcommand{\moi}{\textsc{sp.conductos}}
\newcommand{\R}{\mathbb{R}}
\endinput

1

\usepackage[col=5,lig=12]{package}