1 - Exemple adapté à la situation
Nous allons prendre un exemple avec un seul index, mais avec plusieurs niveau d’entrées, et en en prenant des entrées présentent sur plusieurs pages.
Après la série de compilation grâce a latexmk configuré pour xindy, nous obtenons l’index ci-dessous.
2 - Répartition des tâches
Ouvrons le fichier .ind produit par xindy pour observer son contenu :
\begin{theindex}
\providecommand*\lettergroupDefault[1]{}
\providecommand*\lettergroup[1]{%
\par\textbf{#1}\par
\nopagebreak
}
\lettergroup{C}
\item chat
\subitem domestique, 1, 2
\subitem sauvage, 1, 2
\indexspace
\lettergroup{E}
\item élan
\subitem d'Amérique, 1, 2
\subitem de Sibérie, 1, 2
\item élèphant
\subitem d'Afrique, 1, 2
\subitem d'Asie, 1, 2
\indexspace
\lettergroup{T}
\item tortue
\subitem marine, 1, 2
\subitem terrestre, 1, 2
\end{theindex}On voit qu’il s’agit tout simplement d’un ensemble d’instruction LaTeX.
Il y a donc une répartition du travail entre :
- le noyau LaTeX, les package et notre propre code LaTeX qui se chargent de définir les commandes.
-
xindyqui se charge d’insérer les commandes LaTeX dans le fichier.indà partir du fichier.idxyet de ses propres fichiers de configuration.
3 - Trois exemples de configuration niveau LaTeX
3.1 - Colonages : les options de indextools
L’environnement theindex est défini par chaque classe LaTeX, mais redéfini indextools pour le rendre facilement configurable.
Ainsi, je vous invite à lire la documentation d’indextool et de la commande makeindex qui explique comment facilement personnaliser l’apparence. Je ne vais présenter ici qu’une option : celle qui permet d’avoir un filet de séparation entre les deux colonnes.
À la place de
\makeindex[name=animal,title=Animaux]mettons
\makeindex[name=animal,title=Animaux,columnseprule]et nous obtenons alors l’index avec son filet de séparation.
3.2 - Apparence des sectionnement par lettre
En revanche, certaines éléments d’apparence sont à définir via la personnalisation des commandes. C’est par exemple le cas de l’apparence des entêtes de groupe par initiales.
Nous voyons en consultant le fichier .ind qu’elle sont formatées via la commande \lettergroup.
Cette commande est définie ainsi au début de l’environnement theindex :
\providecommand*\lettergroup[1]{%
\par\textbf{#1}\par
\nopagebreak
}La commande \providecommand est très utile : elle définit une commande sauf si celle-ci est aussi définie via \newcommand. Dans le cas présent, cela permet de proposer un formatage par défaut mais personnalisable.
Ainsi, si nous ne souhaitons pas afficher les lettres de séparation, il suffit de mettre dans son préambule :
\newcommand{lettergroup}[1]{}Mais on on peut aussi s’en servir pour personnaliser de manière plus subtile l’apparence. Par exemple avec le code suivant :
La lettre est centrée dans la colonne, en taille \large, en italique, et entouré de tirets longs.
3.3 - Une flèche avant les sous-entrée bibliographique
Supposons maintenant que nous souhaitions mettre une petite flèche avant chaque sous-entrée bibliographique. La méthode la plus simple est de modifier la commande \subitem pour ajouter cette flèche à la fin. On peut utiliser pour cela la commande \apptocmd du package etoolbox qui est chargé par indextools :
\apptocmd{\subitem}{$\rightarrow$\,}{}{}Le \, insère une espace fine insécable après la flèche.
Ceci donne le résultat ci-dessous.
4 - XXX exemples de configuration niveau au niveau de xindy
4.1 - xindy, ou la succession de fichiers de configuration
Lorsque vous lancez texxindy, vous voyez apparaître dans le terminal les lignes suivantes :
Loading module "lang/french/utf8-lang.xdy"...
Loading module "lang/french/utf8.xdy"...
Finished loading module "lang/french/utf8.xdy".
Finished loading module "lang/french/utf8-lang.xdy".
Loading module "texindy.xdy"...
Loading module "numeric-sort.xdy"...
Finished loading module "numeric-sort.xdy".
Loading module "latex.xdy"...
Loading module "tex.xdy"...
Finished loading module "tex.xdy".
Finished loading module "latex.xdy".
Loading module "latex-loc-fmts.xdy"...
Finished loading module "latex-loc-fmts.xdy".
Loading module "makeindex.xdy"...
Finished loading module "makeindex.xdy".
Loading module "latin-lettergroups.xdy"...
Finished loading module "latin-lettergroups.xdy".
Finished loading module "texindy.xdy".
Loading module "page-ranges.xdy"...
Finished loading module "page-ranges.xdy".
Loading module "word-order.xdy"...
Finished loading module "word-order.xdy".Ces lignes indiquent que xindy chargent des modules de configuration .xdy et y lis les instructions pour savoir comment transformer les fichiers .idx en .ind.
Contrairement à makeindex qui pour cela utilise un fichier .ist, xindy peut utiliser plusieurs fichiers .xdy.
L’intérêt étant évidemment de permettre d’avoir une configuration modulaire.
Un fichier .xdy est essentiellement une liste d’instruction.
On trouve dans le manuel de xindy la listes des instructions fournies. Par ailleurs, un certain nombre de fichiers .xdy sont livrés par défaut avec xindy.
Vous les trouverez dans le dossier xindy/modules du dossier texmf-dist de votre distribution tex. Typiquement avec une installation MacTeX2014, dans le dossier /usr/local/texlive/2014/texmf-dist/xindy. Ou plus simplement vous pouvez les consulter sur le CTAN (prendre la version 2.5.0, qui est celle livrée avec TeXLive).
Il suffit donc pour avoir ses propres styles de créer un fichier monstyle.xdy dans le dossier à côté du .tex et d’utiliser l’option -M monstyle lors de l’appel à la commande :
$ texindy -L french -I xelatex -M monstyle animal.idxEt donc dans le fichier de configuration de latexmk
$makeindex = "texindy -L french -I xelatex -M philologue";Après ce préalable, il est temps de voir ce qu’on met dans ce fichier.
4.2 - Séparation l’entrée et ses références par une ligne de point
Par défaut, l’entrée dans l’index est séparé de ses par une virgule. À titre personnel, je trouve plus lisibles les index dont la séparation entre les deux est plus marquée. Par exemple lorsque la séparation est constituée par une ligne de point : \dotfill en LaTeX.
Mettons donc la ligne suivante
Commentons rapidement ces lignes :
- un
;marque un commentaire qui s’étend jusqu’à la fin de la ligne. Il est d’usage de mettre deux;lorsque nous avons affaire à une ligne de commentaire - chaque instruction est mise entre parenthèse. Une instruction peut courir sur plusieurs lignes (pas le cas ici)
- en général une instruction correspond à une propriété, ici
markup-locclass-lisà laquelle est passée des paramètres. Souvent les paramètres sont des liste d’option, chaque option étant préfixée par:(deux-points). Ici la valeur de l’optionopenest une chaîne de caractère (marquée par les guillemets) égalent à\dotfill.
Après avoir executé texindy -L french -I xelatex -M monstyle animal.idx, on constate que le nouveau fichier .ind est devenu
\begin{theindex}
\providecommand*\lettergroupDefault[1]{}
\providecommand*\lettergroup[1]{%
\par\textbf{#1}\par
\nopagebreak
}
\lettergroup{C}
\item chat
\subitem domestique\dotfill 1, 2
\subitem sauvage\dotfill 1, 2
\indexspace
\lettergroup{E}
\item élan
\subitem d'Amérique\dotfill 1, 2
\subitem de Sibérie\dotfill 1, 2
\item élèphant
\subitem d'Afrique\dotfill 1, 2
\subitem d'Asie\dotfill 1, 2
\indexspace
\lettergroup{T}
\item tortue
\subitem marine\dotfill 1, 2
\subitem terrestre\dotfill 1, 2
\end{theindex}Ce qui nous produit donc l’index ci-dessous.
4.3 - Regrouper les pages dans un intervalle
Ajoutons maintenant avant l’index une nouvelle page de telle sorte que certains termes se trouvent sur trois pages d’affilée, d’autre sur deux pages d’affilée, et d’autres sur une seule page.
\newpage
Et pour la bonne cause, on va aussi parler de chats sauvages\index[animal]{chat!sauvage} qui se disputent avec les chiens errants\index[animal]{chien!errant}.On obtient l’index ci-dessous.
On constate que si le nombre de pages consécutives est supérieur à 2, xindy va remplacer par la page de début et la page de fin. On peut cependant vouloir d’autres réglages
4.3.1 - Pas de regroupement des pages
On peut tout simplement ne pas vouloir de regroupement des pages. Dans ce cas on peut utiliser :
(define-location-class "arabic-page-numbers"
("arabic-numbers") :min-range-length 9999999999)Explication :
- on définit une manière de référencer des termes. Cette manière est nommée
arabic-page-numbers - cette manière consiste à tout simplement utiliser un nombre arabe
("arabic-numbers"). - on indique que pour pour fusionner plusieurs références consécutives, il faut que les références consécutives tiennent dans un intervalle de
9999999999[1], c’est à dire que la différence entre la première et la dernière référence consécutive soit de9999999999. Cas qui ne risque normalement pas d’arriver [2].
On obtient alors l’index ci-dessous.
4.3.2 - Regroupement dès deux pages
Cependant en général on souhaite plutôt regrouper les numéros de page, y compris s’il n’y a que deux pages consécutives. Dans ce cas on peut utiliser :
(define-location-class "arabic-page-numbers"
("arabic-numbers") :min-range-length 1)Ce qui signifie que si l’écart entre les références consécutives est d’au moins 1, on fusionne les références.
Ce qui permet d’obtenir l’index ci-dessous.
Note : les numéros sont séparés par des tirets demi-cadratins (--). On peut vouloir utiliser à la place des traits d’unions simples. Dans ce cas il suffit d’utiliser :
(markup-range :sep "-")4.3.3 - s et ss
On peut aussi vouloir :
- que deux pages d’affilée soit rendu par
XsoùXest le premier numéro de page. - que plus de deux pages d’affilée soit rendu par
Xss.
On va pour cela prendre le modèle livré dans le fichier base/ff-ranges-only.xdy, en nous contenant de remplacer f par s et ff par s.
Commentaire :
- l. 1-2 : même chose que précédemment.
- l. 3 : balisage des pages consécutives lorsque l’écart entre la première et la dernière référence est de
1: utiliserscomme séparateur, et ne pas afficher la page de fin. - l. 4 : balisage des références consécutives dans les autres cas : utiliser
sscomme séparateur, et ne pas afficher la page de fin.
Ce qui nous donne l’index ci-dessous.
Cependant, dans un tel cas, lorsqu’on aura plus de trois pages consécutives, par exemple « 1,2,3,4 » on aura aussi ss. Ce qui manque de précision.
Dans ce cas on peut s’inspirer du fichier base/ff-ranges.xdy et remplacer
par
Ce qui signifie que ss ne sera utilisé que si l’écart entre la première et la dernière référence est de 2. Donc pour 1-3 mais pas pour 1-4.
5 - Synthèse