Académique Documents
Professionnel Documents
Culture Documents
package
Par sp.conductos
www.openclassrooms.com
2/14
Sommaire
Sommaire ........................................................................................................................................... 2
Crez votre propre package ............................................................................................................... 3
Structure de base .............................................................................................................................................................. 3
Le code minimal .......................................................................................................................................................................................................... 3
Analyse du code minimal ............................................................................................................................................................................................ 3
Q.C.M. ............................................................................................................................................................................. 12
Partager ..................................................................................................................................................................................................................... 13
www.openclassrooms.com
Sommaire
3/14
Par
sp.conductos
(et sa surcouche
)?
Suivez le guide...
Dans la suite du tutoriel, par pure fainantise, j'crirai TeX et LaTeX, respectivement la place de
et
Sommaire du tutoriel :
Structure de base
L'astuce babel
Conditions TeX, conditions LaTeX
Utilisation de votre extension
Q.C.M.
Structure de base
Le code minimal
Tout d'abord, commenons par la structure minimale de toute extension
epsilon) :
Code : TeX
\NeedsTeXFormat{LaTeX2e}[1999/01/01]
\ProvidesPackage{nomPackage}[2007/11/26]
www.openclassrooms.com
4/14
Spcifications de base
Code : TeX
\NeedsTeXFormat{LaTeX2e}[1999/01/01]
On spcifie tout d'abord la version de LaTeX ncessaire au fonctionnement de l'extension. Dans ce cas, on demande la version
2e soit . L'argument optionnel (entre crochets) prcise la date minimale de sortie du moteur TeX (ou des macros LaTeX
permettant l'utilisation de l'extension cre). Ceci n'est ncessaire que si vous souhaitez utiliser des commandes seulement
prsentes dans des versions bien prcises des moteurs TeX ou LaTeX.
Aux utilisateurs de
:
il est actuellement fortement dconseill d'utiliser cette version du systme de macros LaTeX, car de plus en plus
d'extensions sont inaccessibles et l'utilisation est bien moins confortable pour de nombreuses actions.
Code : TeX
\ProvidesPackage{monPackage}[2007/11/26]
Ceci est une ligne essentielle. En effet, c'est elle qui dtermine le nom de l'extension que vous crez. Dans ce cas, le nom est trs
original : monPackage. Une fois de plus, l'argument optionnel permet de prciser la date de cration de l'extension.
Ainsi, pour utiliser votre extension dans votre document, vous crirez :
Code : TeX
\usepackage{monPackage}
Eh ! C'est quoi cette ligne en commentaire ? Tu crois vraiment que le compilateur va la lire ?
Bien sr que non ! Les marqueurs de commentaires ne varient pas entre les fichiers sources et les fichiers d'extensions. Je ne
voulais simplement pas vous donner d'exemple et donner directement la commande sans argument n'aurait pas t trs explicite.
Je vous propose maintenant la syntaxe correcte utiliser :
Code : TeX
\RequirePackage[<options]{<package>}
Comme on peut aisment le remarquer, \RequirePackage[]{} possde la mme syntaxe que \usepackage[]{} que l'on utilise dans
les fichiers sources "classiques".
Veillez bien charger toutes les extensions ncessaires au fonctionnement de votre extension. Je pense notamment aux
www.openclassrooms.com
5/14
extensions du type amsmath si vous dfinissez dans votre extension une commande utilisant la famille \mathbb{}.
Options
Code : TeX
%dclaration des options de l'extension
Afin de dclarer les options que vous comptez utiliser, on procde comme suit.
1. Options dfinies
Code : TeX
\DeclareOption{<nom de l'option>}{<action>}
Dans <nom de l'option>, on met le mot clef indiquer dans les arguments optionnels de la commande \usepackage[]{}.
Dans <action>, on indique l'action raliser si l'option est demande.
C'est bien beau tout a, mais cela ne m'indique pas ce qu'il faut mettre dans <action>.
En fait, on met bien souvent (voire toujours) un changement de valeur de boolen. Je m'explique : imaginons que je veuille rendre
l'utilisation de l'extension hyperref (pour crer des liens hypertextes et bien d'autres choses dans mon document) optionnelle. Je
cre alors un boolen auquel j'affecte la valeur false :
Code : TeX
www.openclassrooms.com
6/14
Imaginons prsent que vous tes polyglottes. Vous aurez donc besoin de charger des options de babel diffrentes (eh oui,
mme babel est charg par votre extension personnelle ! ). Dans ce cas, on ne peut pas dclarer les options comme indiqu cidessus. On utilise donc un joker : l'toile (*).
Code : TeX
\DeclareOption*{action}
Ce qui permet de passer l'ensemble des options non dclares explicitement l'extension <package> souhaite.
L'extension voulue doit tre charge avec un (\RequirePackage[]{}) aprs la commande \DeclareOption*{}.
et :
Code : TeX
\newenvironnment{<nomEnvironnement>}{<clausesDbut>}{<clausesFin>}
La cration de commandes et d'environnements n'tant pas le sujet de ce tutoriel, je ne m'tendrai pas d'avantage.
Et pour finir...
Eh bien, on indique au compilateur que c'est fini avec :
Code : TeX
\endinput
Et voil !
L'astuce babel
Comme nous l'avons vu dans la sous-partie prcdente, il faut recourir au joker toil pour optimiser le chargement de l'extension
www.openclassrooms.com
7/14
babel. Je vous propose ici d'tudier plus en dtail ce que j'ai baptis "l'astuce babel", afin d'en matriser toutes les facettes.
Elle permet d'adapter diffrents paramtres (traduction des titres, gestion de la typographie, etc.) la langue choisie. Cependant,
babel ne se contente pas de grer une seule langue la fois. En effet, il est possible d'utiliser plusieurs langues dans un mme
document.
Imaginons, par exemple, que je veuille crire en franais, en anglais et en allemand. Dans une source normale, j'crirai :
Code : TeX
\usepackage[deutsch,english,franais]{babel}
Ce qui aura pour effet de charger les modules de traduction en anglais, en allemand et en franais.
Mais il y a un problme. Pour les chapitres par exemple, il sera marqu ceci : Kapitel, Chapter, Chapitre 1 ?
Euh non ! Ce serait d'ailleurs bien embtant ! En fait, c'est la dernire langue demande (ici franais) qui est applique par dfaut.
Il sera donc marqu, si je ne prcise rien : Chapitre 1. Ouf !
Changement de langue
Pour changer de langue, babel offre plusieurs possibilits :
un environnement :
Code : TeX
\begin{otherlanguage}{<langue>}
\end{otherlanguage}
une commande :
Code : TeX
\foreignlanguage{<langue>}{<texte dans la langue <langue>>}
une dclaration :
Code : TeX
\selectlanguage{<langue>}
Dans tous les cas, la langue (<langue>) indique en argument doit avoir t charge par babel.
www.openclassrooms.com
8/14
Utilisation de \DeclareOption*{}
Nous allons prsent voir comment on peut utiliser intelligemment la commande \DeclareOption*{}.
Je vous propose le code suivant que je commenterai brivement ensuite :
Code : TeX
%tout ce qui doit tre l...
\DeclareOption*{\PassOptionsToPackage{\CurrentOption}{babel}}
\ProcessOptions
%ligne vide pour y voir plus clair
\RequirePackage{babel}
Comme je l'avais dj propos prcdemment, on demande passer l'ensemble des options non dclares explicitement, c'est-dire avec une commande \DeclareOption{}{}, au package babel. Celui-ci doit donc tre charg aprs, comme indiqu sur le code
ci-dessus et sans aucune option.
J'insiste bien sur le fait qu'il ne faut surtout pas indiquer d'options l'extension babel dans la ligne :
Code : TeX
\RequirePackage{babel}
Sinon, vous risquez d'avoir un superbe message d'erreur :
Code : Console
! LaTeX Error : Option clash for package babel
Ce qui signifie que vous avez tent de charger l'extension babel avec des options diffrentes, deux moments
diffrents. Et bien sr, la compilation plante !
Autrement dit, si vous ne voulez pas avoir d'erreur de compilation, il ne vous reste plus qu' inventer la langue colorlinks
www.openclassrooms.com
9/14
Explications
On commence par crer une variable de type if avec la commande :
Code : TeX
\newif
Cette variable possde pour nom :
Code : TeX
\if@ca
Soit en franais :
Code : Autre
si "a" est ...
Ben oui, il faut encore assigner une valeur notre variable :
Code : TeX
\@ifcatrue
Dans notre cas, on assigne notre variable la valeur true, soit vrai.
Les programmeurs, tous langages confondus, reconnatront ici un boolen. La logique boolenne est la base de tous
les langages de programmation, mais galement de la logique en gnral. C'est cette logique que l'on utilise lorsqu'on
effectue des associations de conditions avec les oprateurs logiques AND ("et"), OR ("ou"), XOR ("ou" exclusif) et
NOT (ngation).
Sa formalisation est appele algbre de Boole.
Enfin, le code devant s'excuter lorsque la condition est vraie est dans le bloc :
Code : TeX
\if@ca
\fi
www.openclassrooms.com
10/14
\if@couleur
\RequirePackage{xcolor}
\fi
J'utilise ici le mme exemple que prcdemment : on charge l'extension xcolor si l'option color est envoye l'extension
personnelle.
En LaTeX, surcouche de TeX, l'utilisation de boolens est beaucoup plus vidente. En effet, le boolen est cr par la commande
:
Code : TeX
\newboolean{<nom>}
On lui affecte une valeur avec :
Code : TeX
\setboolean{<nom>}{<valeur>}
Et pour finir, on teste sa valeur avec :
Code : TeX
\boolean{<nom>}
Dans une grosse commande :
Code : TeX
\ifthenelse{<condition>}{<code si vrai>}{<code si faux>}
On pourrait reprocher la syntaxe LaTeX d'tre trs lourde (ceci est visible notamment dans la comparaison des deux codes
donnant le mme rsultat prsents ci-dessus), mais il est bon de connatre les deux syntaxes. La syntaxe TeX est majoritairement
utilise 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 prfre.
11/14
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 rpertoire suivant (ici sous
Windows avec une distribution TeXlive 2007) :
Code : Console
C:\TeXLive2007\texmf\tex\latex\perso
Pour les dtenteurs d'autres distributions, je pense notamment nos amis linuxiens, veillez utiliser un rpertoire similaire (le
nom perso n'est pas obligatoire, vous pouvez choisir autre chose, mais sans espace de prfrence). Vous trouverez quelques
informations complmentaires pour l'utilisation sous Linux plus bas.
Et quelle extension dois-je mettre ?
J'allais l'oublier ! Effectivement, il ne faut pas enregistrer l'extension en *.tex qui est rserve aux sources de documents.
L'extension tant un ensemble de paramtres stylistiques, on met l'extension *.sty (de l'anglais style).
Il s'agit ensuite, comme sous Windows, de mettre jour la base de donnes Is-R. Pour cela, ouvrez votre mulateur de console
favori et tapez :
Code : Console
sudo texhash
www.openclassrooms.com
12/14
Q.C.M.
Le premier QCM de ce cours vous est offert en libre accs.
Pour accder aux suivants
Connectez-vous Inscrivez-vous
Quelle est la bonne commande pour charger une extension dans un fichier de style (*.sty) ?
\usepapckage[]{}
\package{}
\RequirePackage[]{}
\RequirePackage[]
\package[]{}
Oui.
Non.
Oui.
Non.
www.openclassrooms.com
13/14
Correction !
Statistiques de rponses au Q CM
Ce tutoriel s'achve ici. J'espre avoir t suffisamment clair dans l'explication de toutes les tapes de la cration d'une extension
personnalise, et bien sr, que cela vous soit utile !
Pour tous renseignements complmentaires, merci de vous tourner vers les commentaires.
sp.conductos
Partager
Ce tutoriel a t corrig par les zCorrecteurs.
www.openclassrooms.com