Geekographie Maïeulesque

xindy et bibleref

Maïeul — 2016-04-08T12:30:36Z

On m'a posé récemment la question de l'utilisation de xindy avec bibleref. Quelques petites adaptations sont nécessaires pour permettre aux deux outils de cohabiter.

Le problème

Soit l'exemple complet minimum suivant :

\documentclass[a4paper, notitlepage, 11pt]{article} \usepackage[xindy]{indextools} \usepackage{bibleref-french} \renewcommand{\biblerefindex}[0]{\index[bible]} \makeindex[name=bible, title=Index des sources bibliques] \begin{document} Une ref biblique: \ibibleverse{Lc}(3:12) \newpage \printindex[bible] \end{document}

Première compilation XeLaTeX : production d'un PDF sans index.

Compilation avec xindy

texindy -L french -I xelatex bible.idx

Seconde compilation avec XeLaTeX : un index vide. Ha ! Quid ?

Analyse du problème

Ouvrons le fichier .ind. On voit effectivement qu'il ne contient que l'introduction de l'index :

\begin{theindex} \providecommand*\lettergroupDefault[1]{} \providecommand*\lettergroup[1]{% \par\textbf{#1}\par \nopagebreak } \end{theindex}

Le problème se situe donc au niveau de texindy. Regardons donc les messages de compilation. Une ligne nous renseigne sur la cause du problème :

WARNING : unknown attribute `textrm' ! (ignored)

Rappelons que pour xindy un attribut correspond à ce qui est mis après un | lors de l'indexation.

En ouvrant le fichier .idx produit lors de la compilation, on constate effectivement la présence d'un |textrm.

\indexentry{Lc\relax \relax @\BRbooktitlestyle {Luc}!003:012@\BRchapterstyle {3}\BRchvsep \BRversestyle {12}|textrm}{1}

À la différence de makeindex, tout attribut doit être déclaré explicitement dans un fichier .xdy. En l'occurrence, le |textrm ne me paraît pas particulièrement utile. Donc plutôt que de le déclarer dans un .xdy, nous allons plutôt demander à bibleref de ne pas l'insérer.

Pour cela, une seule ligne suffit, à mettre dans le préambule :

\renewcommand{\bvidxpgformat}{}

Résultat final

Après cela, recompilons avec XeLaTeX, puis avec texindy, puis à nouveau XeLaTeX.

L'index est effectivement inséré.

Un index biblique avec xindy

Évidemment, dans le cadre d'un index biblique, il n'est pas utile d'avoir des sectionnement de l'index par lettres. Mais je renvoie à mon article sur la personnalisation de l'apparence des index.

xindy, hyperref et |see

Maïeul — 2015-11-02T21:45:52Z

Une personne m'a demandé comment utiliser xindy avec hyperref et l'option d'indexation |see. Je tire donc un article de la solution proposée.

Fichier d'exemple

Je suppose que vous avez, au préalable, créé votre fichier .xdy contenant les instructions proposées dans l'article xindy et hyperref. Je suppose que vous avez également chargé le package hyperref avec l'option hyperindex=false :

\usepackage[hyperindex=false]{hyperref}

Je prend maintenant le fichier contenant les commandes d'indexation suivantes :

\indexentry{félin}{1} \indexentry{chat|see{félin}}{1}

Je souhaite que la commande |see non seulement renvoie vers la bonne entrée, mais en plus intègre un lien hypertexte.

Analyse du fichier `.idx` et du fichier `.ind`

Le fichier .idx produit est le suivant

\indexentry{félin}{1} \indexentry{chat|see{félin}}{1}

Après un passage par xindy avec mon précédent .xdy, on obtient les lignes suivantes dans le fichier .ind :

(…) \item chat, \see{félin}{} (…) \item félin, \hyperpage{1} (…)

On constate donc que si il existe bien un renvoi depuis « chat » vers « félin » et si félin pointe bien avec un lien hypertexte sur la page 1, le renvoi ne propose pas de lien hypertexte.

Modification du `.xdy`

Nous allons modifier notre fichier .xdy pour ajouter :

une commande pour indiquer que « félin » est un lieu de destination.
une commande pour indiquer que « chat » pointe vers félin, ou plus exactement que le \see{félin}{} point vers félin.

Ajoutons donc les deux lignes suivantes au fichier .xdy :

(markup-keyword-list :open "\targetindexentry{" :close"}") (markup-crossref-list :open "\seelink{" :close "}{}" :class "see")

La première ligne indique d'entourer les mots-c'est à dire les entrées d'indexation, par \targetindexentry{ à gauche et par } à droite.

La seconde ligne indique que le paramètre marqué entre les accolades qui suivant le |see, ici félin doit être entouré à gauche par \seelink{ et à droite par }{}.

Ceci nous produit donc le fichier .ind avec les lignes suivantes :

(…) \item \targetindexentry{chat}, \seelink{félin}{} (…) \item \targetindexentry{félin}, \hyperpage{1}

Définition de `\seelink` et de `\targetindexentry`

Il ne reste plus qu'à définir dans notre fichier .tex les deux commandes \targetindexentry et \seelink qui utilisent des commandes du package hyperref.

\newcommand{\targetindexentry}[1]{\hypertarget{index:#1}{#1}} \newcommand{\seelink}[1]{\hyperlink{index:#1}{\see{#1}}}

Rien de bien méchant : targetindexentry crée une ancre sur son argument. Le nom de l'ancre correspond à son argument précédé par index: ; \seelink point vers une ancre dont le nom correspond à son argument précédé de index:, le texte pointeur étant tout simple la commande \see à laquelle on passe son argument.

Correction de `\hyperlink` et `hypertarget`

Le problème est que les commandes \hyperkink et hypertarget ne fonctionne pas si le premier argument contient des accents. Il nous faut donc corriger ces commandes. Cependant une telle correction ralentissant considérablement le temps de calcul [1], il est recommandé de les faire uniquement avant l'index.

Ajoutez donc ces lignes avant le premier \printindex.

\makeatletter \long\def\hyper@@anchor#1#2{% \pdfstringdef\@temp@anchorpdfstring{#1}% \@hyper@@anchor\@temp@anchorpdfstring\relax#2\relax% } \def\hyperlink#1#2{% \pdfstringdef\@temp@anchorpdfstring{#1}% \hyper@@link{}{\@temp@anchorpdfstring}{#2}% } \makeatother

La différence principale avec les définitions de hyperref est l'emploi de \pdfstringdef qui permet de transformer les accents en caractères acceptables dans le code interner d'un pdf, donc dans les liens hypertextes.

Et maintant, non seulement |see fonctionne, mais en plus il produit des liens hypertextes. Miaou !

[1] D'après l'auteur du package, Otto Oberdierk.

Tri personnalisé des entrées avec xindy

Maïeul — 2015-04-20T06:30:00Z

Il arrive fréquemment que l'on souhaite qu'un index n'utilise pas l'ordre alphabétique. Par exemple si on consacre un index à des détenteurs de pouvoir (empereurs, rois, présidents, papes) on peut souhaiter classer les noms par ordre de régne/de mandature/de pontificat. Si makeindex permet déjà de faire cela, xindy permet de simplifier les choses.

Exemple

Prenons un exemple simple :

% À compiler avec XeLaTeX
\documentclass{article} \usepackage{fontspec}
\usepackage{polyglossia}
\setmainlanguage{french}
\setmainfont{Linux Libertine O}
\usepackage{setspace}
\onehalfspacing
\usepackage[xindy]{indextools}%On précise qu'on veut utiliser xindy
\makeindex[name=animal,title=Animaux,columnseprule] % Personnaliser l'apparence de lettergroup
\newcommand{\lettergroup}[1]{% {\centering\large---\emph{#1}---\par}%
}
\apptocmd{\subitem}{$\rightarrow$\,}{}{} \begin{document} On va parler de chats sauvages\index[animal]{chat!sauvage} et domestiques\index[animal]{chat!domestique},
de tortues marines\index[animal]{tortue!marine} et terrestres\index[animal]{tortue!terrestre},
d'élèphant d'Asie\index[animal]{élèphant!d'Asie} et d'Afrique\index[animal]{élèphant!d'Afrique},
et soyons fou, d'élans de Sibérie\index[animal]{élan!de Sibérie} et d'Amérique\index[animal]{élan!d'Amérique}. \newpage On va parler sur la page suivante des même animaux. C'est à dire : de chats sauvages\index[animal]{chat!sauvage} et domestiques\index[animal]{chat!domestique},
de tortues marines\index[animal]{tortue!marine} et terrestres\index[animal]{tortue!terrestre},
d'élèphant d'Asie\index[animal]{élèphant!d'Asie} et d'Afrique\index[animal]{élèphant!d'Afrique},
et soyons fou, d'élans de Sibérie\index[animal]{élan!de Sibérie} et d'Amérique\index[animal]{élan!d'Amérique}. \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}.
\printindex[animal]
\end{document}

En utilisant le fichier de configuration .xdy des précédents tutoriels, on obtient l'index suivant.

Tri des empereurs par ordre alphabétique

Les empereurs sont classés par ordre alphabétique, ce qui est parfaitement normal, puisqu'on n'a pas demandé un autre tri.

Première méthode : l'arobase

La première méthode à laquelle on pense spontanément est l'utilisation du @, pour indiquer pour chaque entrée un ordre de tri personnalisé.

Les empereurs julio-claudiens sont Auguste\index[emp]{001@Auguste}, Tibère\index[emp]{002@Tibère}, Caligula\index[emp]{003@Caligula}, Claude\index[emp]{004@Claude} et Néron\index[emp]{005@Néron}.

Ceci permet donc de trier les empereurs par ordre de règne. Et fonctionne parfaitement comme le montre l'exemple ci-dessous.

Tri des empereurs par ordre de règne

Deuxième méthode : le fichier `.xdy`

Seulement cette méthode implique d'indiquer systématiquement le numéro d'ordre de l'empereur lors de l'indexation. Ce qui, outre ralentir l'écriture, est source d'erreur. Quid si je frappe par erreur \index[emp]002@Caligula ?

Et bien j'aurai deux entrées « Caligula », donc une situé entre « Auguste » et « Tibère ». Certes ce genre d'erreur ne devrait pas arriver ... mais autant utiliser les potentialités de xindy en indiquant dans le fichier .xdy l'ordre des empereurs.

Pour ce faire mettre simple les lignes suivantes

 (merge-rule "Auguste" "001" :string) (merge-rule "Tibère" "002" :string) (merge-rule "Caligula" "003" :string) (merge-rule "Claude" "004" :string) (merge-rule "Néron" "005" :string)

Ceci signifie simplement que l'entrée « Auguste » sera transformée en une entrée « 001 » avant que xindy ne commence à analyser les règles de tri, que l'entrée « Tibère » sera transformée en « 002 » etc.

Notez deux choses importantes :

la transformation ne concerne que la valeur utilisée pour le tri, pas la valeur utilisée à l'affichage
la transformation est opérée avant que ne soit appliquée les règles de tri propre à une langue. Cela n'a aucune importance dans le cas d'espèce, mais pourrait être pertinent si vous vous vouliez vous servir de ce genre de règle pour unifier des présentation, comme nous le verrons dans un autre article.

Avec ce fichier .xdy, mettre dans son fichier .tex directement

Les empereurs julio-claudiens sont Auguste\index[emp]{Auguste}, Tibère\index[emp]{Tibère}, Caligula\index[emp]{Caligula}, Claude\index[emp]{Claude} et Néron\index[emp]{Néron}.

nous produit quand même un index trié par ordre de règne. Mais cette fois, on s'allège la rédaction du fichier .tex.

xindy, eledmac et hyperref

Maïeul — 2015-04-17T06:30:00Z

J'en viens maintenant à aborder l'utilisation de \xindy avec eledmac, et plus précisément avec sa commande \edindex qui permet d'indexer une référence en renvoyant à la page et au numéro de ligne.

Pré-requis

La compatibilité pleine de eledmac avec xindy n'est fournie qu'avec la version 1.22.0 de eledmac.

Pour l'installer :

télécharger le zip disponible sur le CTAN.
appliquer la commande pdflatex sur les deux fichiers .ins pour obtenir les fichiers .sty.
mettre les fichiers .sty à côté de votre fichier d'exemple ou dans le dossier tex/latex/eledmac de [votre dossier texmf local.

Fichier d'exemple

Prenons un fichier .tex reprenant le code de mes précédents exemples, mais utilisant \edindex à la place de \index.

% À compiler avec XeLaTeX % À compiler avec XeLaTeX \documentclass{article} % Réglages géneraux \usepackage{fontspec} \setmainfont{Linux Libertine O} \usepackage{polyglossia} \setmainlanguage{french} \usepackage{setspace} \onehalfspacing % Définition des index \usepackage[xindy]{indextools}%On précise qu'on veut utiliser xindy % Apparence des index % Cf http://geekographie.maieul.net/171 \newcommand{\lettergroup}[1]{% {\centering\large---\emph{#1}---\par}% } \apptocmd{\subitem}{$\rightarrow$\,}{}{} % % Chargement de eledmac et de hyperref avec les bonnes options \usepackage[series={A},noeledsec,nofamiliar,noend,xindy,xindy+hyperref]{eledmac} \usepackage[hyperindex=false]{hyperref} % Toujours appeler \makeindex après le chargement de eledmac, cf doc de eledmac. \makeindex[name=animal,title=Animaux,columnseprule] \begin{document} \beginnumbering \autopar On va parler de chats sauvages\edindex[animal]{chat!sauvage} et domestiques\edindex[animal]{chat!domestique}, de tortues marines\edindex[animal]{tortue!marine} et terrestres\edindex[animal]{tortue!terrestre}, d'élèphant d'Asie\edindex[animal]{élèphant!d'Asie} et d'Afrique\edindex[animal]{élèphant!d'Afrique}, et soyons fou, d'élans de Sibérie\edindex[animal]{élan!de Sibérie} et d'Amérique\edindex[animal]{élan!d'Amérique}. On va parler au paragraphe suivant des même animaux. C'est à dire : de chats sauvages\edindex[animal]{chat!sauvage} et domestiques\edindex[animal]{chat!domestique}, de tortues \edtext{marines}{\Afootnote{ninja\edindex[animal]{tortue!ninja|textbf}}}\edindex[animal]{tortue!marine} et terrestres\edindex[animal]{tortue!terrestre}, d'élèphant d'Asie\edindex[animal]{élèphant!d'Asie} et d'Afrique\edindex[animal]{élèphant!d'Afrique}, et soyons fou, d'élans de Sibérie\edindex[animal]{élan!de Sibérie} et d'Amérique\edindex[animal]{élan!d'Amérique}. \edtext{Le paragraphe suivant est vraiment très particulier. Il est là juste pour tester ce que donne une indexation lorsqu'on parle d'une note qui est sur plusieurs lignes.}{\lemma{Le paragraphe…lignes}\Afootnote{serpent\edindex[animal]{serpent!de mer}}}% \endnumbering \newpage \beginnumbering \autopar Et pour la bonne cause, on va aussi parler de chats sauvages\edindex[animal]{chat!sauvage|textbf} qui se disputent avec les chiens errants\edindex[animal]{chien!errant}. \endnumbering \printindex[animal] \end{document}

Rien de très original dans le contenu, comme vous pouvez le constatez, si ce n'est que j'ai ajouté l'indexation d'un élément en note critique.

Les deux lignes les plus importantes pour le fonctionnement avec xindy sont :

\usepackage[xindy,xindy+hyperref]{eledmac} \usepackage[hyperindex=false]{hyperref}

La ligne \usepackage[hyperindex=false]{hyperref} vous laisse prendre la main sur l'ajout de liens hypertextes sur les localisation dans l'index, ainsi que je l'ai expliqué dans mon précédent article.

L'option xindy de eledmac est obligatoire si on souhaite utiliser \edindex avec xindy [1].

L'option xindy+hyperref permet en outre de faire fonctionner les liens internes.

Trois premières compilations XeLaTeX

Lorsqu'on indexe avec \edindex le fichier .idx n'est correct qu'après la troisième compilation (X^e)LaTeX. Nous supposons donc que vous faites trois compilations d'affilée de XeLaTeX.

À la fin de ces compiliations, outre le fichier .pdf et le fichier .xdy, vous obtenez un fichier eledmac-markup-attr.xdy.

Il s'agit d'un fichier de configuration xindy produit par eledmac et qui contient la déclaration des attributs de localisation propres à chaque entrée d'index produite par \edindex.

Compilation `xindy`

Il nous faut donc appeler ce fichier .xdy lors de notre compilation. Deux solutions s'offrent à nous.

La première consistent à passer le nom de ce fichier à l'option -M de texindy. Ainsi à la place d'appeler :

$ texindy -L french -I xelatex -M monstyle animal.idx

On appellera

$ texindy -L french -I xelatex -M monstyle eledmac-markup-attr animal.idx

Cependant il existe une solution plus simple : inclure l'appel à eledmac-markup-att.xdy directement dans le fichier monstyle.xdy via :

(require "eledmac-markup-attr.xdy")

Procédez donc à cette compilation : vous obtenez des lignes du type

WARNING : location-reference « 1-1 » did not match any location-class ! (ignored)

Ceci s'explique simplement : xindy n'est pas capable, par défaut, de comprendre une localisation de type numerodepage-numerodeligne tel que l'écrit \edtext dans le fichier .idx.

Qu'importe, nous allons lui apprendre, en ajoutant les lignes suivantes dans notre fichier de configuration .xdy [2] :

(define-location-class "eledmac" ("arabic-numbers" :sep"-" "arabic-numbers") :hierdepth 2 )

Ces lignes disent simplement qu'il existe une classe de localisation, c'est à dire une manière de référencer une entrée, nommée eledmac. Les entrées ainsi localisées possèdent deux niveau de localisation (:hierdepth 2), c'est à dire dans notre cas le page puis la ligne. Le premier niveau est écrit en nombre arabe, le second aussi, et les deux sont séparés par le caractère -.

Avec ces lignes nous arrivons à compiler correctement avec texindy. Cependant après la compilation XeLaTeX suivante, nous obtenons un index peu utilisable, comme vous pouvez le constatez dans le fichier ci-dessous.

Premier essai d'index avec eledmac + xindy

Le numéro de ligne est collé au numéro de page, si bien que l'index ne permet pas de retrouver la référence. Qu'importe, nous allons dire à xindy de mettre le numéro de ligne entre parenthèse, avec les lignes suivantes dans le fichier .xdy

(markup-locref-list :open " (" :sep ", " :close ")" :depth 1 :class "eledmac")

Nous indiquons que pour la classe de localisaton eledmac, que nous avions précédemment définie, le niveau 1 de localisation, c'est à dire dans le cas présent le numéro de ligne, puisque les niveaux commençent à 0, est marqué dans le fichier .ind par une parenthèse ouvrante au début et par une parenthèse fermante à la fin, les différentes entrées du même niveau étant séparées par des virgules.

Avec un tel fichier .xdy, après une nouvelle compilation xindy et une autre compilation XeLaTeX, nous obtenons un index final correctement formaté.

xindy et eledmac : exemple distinguant bien le numéro de ligne du numéro de page

Il y aura une suite à ces tutoriaux sur xindy, mais la semaine prochaine.

[1] En fait pas tout à fait : elle n'est obligatoire que si on souhaite mettre des index en notes de bas de page ou si on souhaite avec des liens hypertextes. Mais autant prendre l'habitude de la charger, cela évitera les mauvaises surprises.

[2] Attention à bien mettre ces lignes dans votre fichier et non pas dans le fichier eledmac-markup-attr.xdy, qui est réécrit à chaque compilation XeLateX !

xindy et hyperref

Maïeul — 2015-04-16T06:30:00Z

Nous arrivons maintenant à un point délicat dans l'utilisation de xindy : sa compatibilité avec le package hyperref. Ce dernier insère en effet des liens hypertextes dans l'index : chaque référence pointe vers la page correspondante. Cependant l'insertion de ces liens utilisent les mécanismes de makeindex et pas ceux de xindy ce qui n'est pas sans poser quelques petits problèmes.

Un exemple qui marche …

Reprenons l'exemple de l'article précédent mais en activant hyperref :

\documentclass{article} \usepackage{fontspec} \usepackage{polyglossia} \setmainlanguage{french} \setmainfont{Linux Libertine O} \usepackage{setspace} \onehalfspacing \usepackage[xindy]{indextools}%On précise qu'on veut utiliser xindy \makeindex[name=animal,title=Animaux,columnseprule] % Personnaliser l'apparence de lettergroup \newcommand{\lettergroup}[1]{% {\centering\large---\emph{#1}---\par}% } \apptocmd{\subitem}{$\rightarrow$\,}{}{} \begin{document} On va parler de chats sauvages\index[animal]{chat!sauvage} et domestiques\index[animal]{chat!domestique}, de tortues marines\index[animal]{tortue!marine} et terrestres\index[animal]{tortue!terrestre}, d'élèphant d'Asie\index[animal]{élèphant!d'Asie} et d'Afrique\index[animal]{élèphant!d'Afrique}, et soyons fou, d'élans de Sibérie\index[animal]{élan!de Sibérie} et d'Amérique\index[animal]{élan!d'Amérique}. \newpage On va parler sur la page suivante des même animaux. C'est à dire : de chats sauvages\index[animal]{chat!sauvage} et domestiques\index[animal]{chat!domestique}, de tortues marines\index[animal]{tortue!marine} et terrestres\index[animal]{tortue!terrestre}, d'élèphant d'Asie\index[animal]{élèphant!d'Asie} et d'Afrique\index[animal]{élèphant!d'Afrique}, et soyons fou, d'élans de Sibérie\index[animal]{élan!de Sibérie} et d'Amérique\index[animal]{élan!d'Amérique}. \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}. \printindex[animal] \end{document}

Cela produit le PDF ci-dessous.

xindy + hyperref : exemple qui fonctionne

Comme vous pouvez constater, tout semble fonctionner : notre index est correct et les liens internes fonctionnent.

… mais c'est tout

Les problèmes surviennent lorsqu'on tente de marquer une référence comme importante, par exemple avec |textbf. Ainsi :

Et pour la bonne cause, on va aussi parler de chats sauvages\index[animal]{chat!sauvage|textbf} qui se disputent avec les chiens errants\index[animal]{chien!errant}. \printindex[animal]

Lors de la compilation texindy vous obtenez le message suivant :

WARNING : unknown cross-reference-class `hyperindexformat' !

Et de fait, la référence marquée par |textbf est absente de l'index final.

xindy + hyperref + |textbf ne fonctionne pas

La cause du problème

Rappelons que xindy se « contente » de transformer un fichier .idx en un fichier .ind. Ouvrons le fichier .idx pour comprendre comment cela.

À côté de ligne sans qui ne posent pas de soucis telle que :

\indexentry{chat!sauvage|hyperpage}{1}

Nous y trouvons la ligne problématique :

\indexentry{chat!sauvage|hyperindexformat{\textbf}}{3}

Et nous voici en face de deux limites de xindy [1] :

alors que makeindex transforme toute syntaxe de type |xxx en la commande correspondante, il n'en va pas de même avec xindy, qui nécessite qu'on lui déclare ces commandes manuellement. En effet, xindy, qui n'est pas conçue uniquement pour LaTeX, considère que la syntaxe |xxx après une entrée dans le fichier .idx correspond à un attribut de localisation, c'est à dire une propriété associée à la localisation d'une entrée. Certains de ces attribut de localisation sont déclarés dans le fichier base/latex-loc-fmts.xdy que texindy charge par défaut.
ces attributs ne peuvent pas recevoir d'arguments. Ainsi, même si nous déclarions hyperindexformat, cela ne nous arrangerait pas. En effet, les commandes avec arguments sont considérés par \xindy comme des marqueurs de renvois au sein de l'index, alors que makeindex est plus souple sur la question.

Solution

Comment résoudre ce problème ? En demandant à hyperref de ne pas intervenir dans la gestion du .idx et en gérant nous même cela via le fichier de configuration .xdy

Désactiver la modification de l'index par `hyperref`

Il suffit simplement de charger le package avec l'option hyperindex=false :

\usepackage[hyperindex=false]{hyperref}

Vous constaterez alors que le fichier .ind ne contient plus que des lignes de type :

\indexentry{chat!sauvage}{1}

\indexentry{chat!sauvage|textbf}{3}

qui sont très bien interprétés par xindy, mais sans évidemment que les liens hypertextes ne soit intégrés.

Configuration de `xindy`

Pour résoudre ce problème, il nous suffit d'ajouter dans le fichier de configuration .xdy les lignes suivantes :

(define-attributes ("emph")) (markup-locref :open "\hyperpage{" :close "}" :attr "default") (markup-locref :open "\textbf{\hyperpage{" :close "}}" :attr "textbf") (markup-locref :open "\textit{\hyperpage{" :close "}}" :attr "textit") (markup-locref :open "\emph{\hyperpage{" :close "}}" :attr "emph")

La première ligne permet de définir l'attribut emph qui n'est pas défini par défaut dans texindy alors qu'il est plus sémantique que l'attribut textit.

Dans les quatres lignes nous réglons la propriété markup-locref pour l'attribut de localisation indiqué entre guillemets après le :attr, sachant que l'attribut defaut est – comme son nom l'indique – celui utilisé si aucun attribut n'est mentionné.

Pour chaque attribut nous définissons via :open un marqueur à insérer avant la localisation, et via :close nous définissons un marqueur à insérer après la localisation.

Avec un tel système, notre fichier .idx deviendra un fichier .ind contenant des lignes telles que

\subitem sauvage\dotfill \hyperpage{1}--\hyperpage{2}, \textbf{\hyperpage{3}}

Ce qui est parfaitement compris par LaTeX lors de compilation suivante, \hyperpage insérant un lien hypertexte vers une page.

Cela nous permet d'obtenir le fichier ci-dessous, contenant de liens internes, y compris en gras.

xindy + hyperref + |textbf exemple qui fonctionne

[1] Bien tenues par rapport à ses avantages, puisqu'on peut facilement les contourner.

Régler l'apparence des index avec xindy

Maïeul — 2015-04-15T06:30:00Z

Après avoir créé notre premier index avec xindy, nous allons maintenons modifier son apparence. Par « apparence » nous entendons la manière dont sont affichés les entrées et les pages, mais pas l'ordre de tri ou les divisions par initiales.

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.

\documentclass{article}
\usepackage{fontspec}
\setmainfont{Linux Libertine O}
\usepackage{setspace}
\onehalfspacing
\usepackage[xindy]{indextools}%On précise qu'on veut utiliser xindy
\makeindex[name=animal,title=Animaux]
\begin{document} On va parler de chats sauvages\index[animal]{chat!sauvage} et domestiques\index[animal]{chat!domestique},
de tortues marines\index[animal]{tortue!marine} et terrestres\index[animal]{tortue!terrestre},
d'élèphant d'Asie\index[animal]{élèphant!d'Asie} et d'Afrique\index[animal]{élèphant!d'Afrique},
et soyons fou, d'élans de Sibérie\index[animal]{élan!de Sibérie} et d'Amérique\index[animal]{élan!d'Amérique}. \newpage On va parler sur la page suivante des même animaux. C'est à dire : de chats sauvages\index[animal]{chat!sauvage} et domestiques\index[animal]{chat!domestique},
de tortues marines\index[animal]{tortue!marine} et terrestres\index[animal]{tortue!terrestre},
d'élèphant d'Asie\index[animal]{élèphant!d'Asie} et d'Afrique\index[animal]{élèphant!d'Afrique},
et soyons fou, d'élans de Sibérie\index[animal]{élan!de Sibérie} et d'Amérique\index[animal]{élan!d'Amérique}. \printindex[animal]
\end{document}

Après la série de compilation grâce a latexmk configuré pour xindy, nous obtenons l'index ci-dessous.

Formatage par défaut avec xindy + indextools

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.
xindy qui se charge d'insérer les commandes LaTeX dans le fichier .ind à partir du fichier .idxy et de ses propres fichiers de configuration.

Trois exemples de configuration niveau LaTeX

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.

Index avec filet de séparation

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 :

\newcommand{\lettergroup}[1]{% {\centering\large---\emph{#1}---\par}%
}

La lettre est centrée dans la colonne, en taille \large, en italique, et entouré de tirets longs.

Exemple de personnalisation de l'entête de groupe de lettre

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.

Une flèche avant les sous-entrée d'un index

XXX exemples de configuration niveau au niveau de `xindy`

`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.idx

Et 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.

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

;; Pour avoir les numéro de pages avec des -- y compris si on a uniquement deux pages
;; Séparateur entre l'entrée et ses numéros
(markup-locclass-list :open "\dotfill ")

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'option open est 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.

Index avec ligne de points

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.

Plusieurs pages d'affilée pour une même entrée d'index : réglage par défaut

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

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 de 9999999999. Cas qui ne risque normalement pas d'arriver [2]. On obtient alors l'index ci-dessous.

Plusieurs pages d'affilée pour une même entrée d'index : pas de fusion

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.

Plusieurs pages d'affilée pour une même entrée d'index : fusion dès deux pages

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 "-")

`s` et `ss`

On peut aussi vouloir :

que deux pages d'affilée soit rendu par Xs où X est 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.

(define-location-class "arabic-page-numbers" ("arabic-numbers") :min-range-length 1)
(markup-range :sep "s" :length 1 :ignore-end)
(markup-range :sep "ss" :ignore-end)

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 : utiliser s comme séparateur, et ne pas afficher la page de fin.
l. 4 : balisage des références consécutives dans les autres cas : utiliser ss comme séparateur, et ne pas afficher la page de fin.

Ce qui nous donne l'index ci-dessous.

Plusieurs pages d'affilée pour une même entrée d'index : utilisation de s et ss

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

(markup-range :sep "ss" :ignore-end)

par

(markup-range :sep "ss" :length 2 :ignore-end)

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.

Synthèse

C'est tout pour aujourd'hui

[1] D'après le manuel on peut utilise le mot-clef none mais chez moi cela provoque une erreur de compilation.

[2] Ou alors vous écrivez un très long livre avec un index totalement inutile, puisqu'il indique qu'on parle de votre sujet sur 10 000 000 000 pages d'affilée.

Premier pas avec xindy

Maïeul — 2015-04-14T06:30:00Z

Après avoir présenté rapidement ce qu'était xindy et pourquoi je recommande son utilisation, faisons les premiers pas avec xindy.

Pour le moment nous nous contenterons d'index un un document en français, avec deux index.

Préréquis

Je suppose que vous utilisez XeLaTeX et non pas LaTeX ou pdfLaTeX [1].

Je suppose également que xindy est installé sur votre ordinateur :

Si vous utilisez TeXLive2014 ou MacTeX 2014, c'est déjà le cas.
Si vous utilisez MikTeX, il existe un tutoriel pour l'installation. Je n'ai pas encore testé, donc tout retour est le bienvenu.

Enfin, je suppose que vous savez comment exécuter LaTeX et ses auxiliaires en lignes de commandes. Si vous ne savez pas :

lisez l'annexe de mon livre (obligatoire pour les gens sous windows)
ou bien lisez l'article LaTeX en ligne de commande

Fichier d'exemple minimal

Nous prendrons le fichier suivant [2] :

% À compiler avec XeLaTeX \documentclass{article} \usepackage{fontspec} \setmainfont{Linux Libertine O} \usepackage{setspace} \onehalfspacing \usepackage[xindy]{indextools}%On précise qu'on veut utiliser xindy \makeindex[name=animal,title=Animaux] \makeindex[name=plante,title=Plantes] \begin{document} On va parler de chats\index[animal]{chat}, de tortues\index[animal]{tortue}, d'élèphant\index[animal]{élèphant}, et soyons fou, d'élans\index[animal]{élan}. \newpage Ces animaux aiment bien les carottes\index[plante]{carotte}, les anémones\index[plante]{anémone}, les anthémis\index[plante]{anthémis}, et les courgette\index[plante]{courgettes}. \newpage \printindex[animal] \printindex[plante] \end{document}

Première compilation XeLaTeX

Compilez le document avec XeLaTeX. Vous obtenez deux pages, mais pas d'index. En revanche, vous obtenez le message suivant dans les messages de compilation

Package indextools Warning : Remember to run xelatex again after calling (indextools) texindy animal.idx'. Package indextools Warning: Remember to run xelatex again after calling (indextools)texindy plante.idx'.

Tout est dit : alors que indextools peut exécuter makeindex automatiquement, ce n'est pas le cas pour xindy [3].

Qu'importe, nous allons le faire maintenant.

Deux exécutions de `texindy`

On constate que deux fichiers .idx ont été produits : animal.idx et plante.idx. Nous allons donc les transformer en appelant texindy, le xindy préconfiguré pour LaTeX.

En ligne de commande donc, frapper (le $ représente l'invite de commande) :

$ texindy -L french -I xelatex animal.idx $ texindy -L french -I xelatex plante.idx

Explication de code :

texindy le programme que l'on appelle.
-L french utilisez les règles de classement alphabétique du français. Chaque langue à ses propres règles de classement [4], c'est pourquoi il est nécessaire de préciser la langue. Et si vous utilisez plusieurs langues dans votre index ? On y viendra plus tard.
-I xelatex indique que nous chargeons les règles propres à xelatex, autrement dit que nos fichiers .idx sont encodés en UTF8. Après chaque retour chariot, vous obtiendrez normalement des messages de compilation xindy.

Vous devriez désormais avoir deux fichiers ; animal.ind et plante.ind. Si oui, nous pouvons passer à la deuxième compilation XeLaTeX

Deuxième compilation XeLaTeX

Maintenant, recompilez votre fichier .tex avec XeLaTeX.

Vous devriez obtenir le fichier ci-dessous.

Premiers index avec xindy

On trouve bien les deux index, triée selon l'ordre alphabétique, avec les lettres accentuées bien placées.

On constate cependant une différence avec une compilation classique avec makeindex : les mots sont regroupés par lettres initiales, avec l'initiale affichée en début de chaque groupe. Nous verrons plus tard comment modifier l'apparence de cette initiale, voire la supprimer, lorsque nous aborderons la personnalisation de l'apparence de l'index.

Automatiser les compilations : `latexmk`

Par rapport à l'utilisation d'indextools + imakeidx nous avons perdu un peu au change : il faut procéder à une compilation supplémentaire de XeLaTeX, et en plus il faut compiler chaque fichier .idx.

En générale la deuxième, voire la troisième, compilation XeLaTeX est nécessaire, notamment si on a une bibliographie, des renvois internes et une tables des matières. Cependant, il serait plus simple d'avoir un outil qui nous fasse toutes ces compilation d'un coup.

Cet outil, c'est latexmk, dont j'ai déjà parlé.

Il nous suffit donc de mettre dans le fichier de configuration latexmkrc ou .latexmkrc :

$pdflatex = "xelatex %S"; $pdf_mode = "1"; $makeindex = "texindy -L french -I xelatex %S";

Pour qu'en ligne de commande un :

$ latexmk fichier.tex

fasse toutes les compilations.

[1] Pour ceux qui ne savent pas pourquoi je conseille XeLaTeX, lisez l'introduction de mon livre.

[2] Je suppose que vous avez la police Linux Libertine installé sur votre ordinateur. Si ce n'est pas le cas, vous pouvez commenter la ligne correspondante, cela ne change rien au problème, c'est juste plus esthétique.

[3] En fait c'est possible mais en appelant XeLaTeX avec certains options spécifiques. Peut importe, nous allons apprendre ici à utiliser latexmk pour simplifier.

[4] Par exemple : en français on classe d'abord sans tenir compte des accents, puis on les intègre dans un second classement ; en espagnol la ligature « ll » est classée comme une lettre à part, entre « l » et « m ».

xindy, un outil d'indexation plus efficace que makeindex

Maïeul — 2015-04-13T06:30:00Z

La plupart des personnes qui débutent en LaTeX utilisent pour générer des index l'historique logiciel makeindex. Celui-ci a pourtant un remplaçant bien plus efficace, notamment pour nous autres francophones. J'ai nommé xindy.

Ce dernier est cependant rarement présenté dans les ouvrages d'introduction à LaTeX [1] – le mien n'échappe pas à ce travers. Or le fonctionnement par rapport à makeindex s'avère assez différent. C'est pourquoi j'ai décidé d'écrire plusieurs tutoriels sur l'utilisation de xindy, qui seront publiés au rythme d'un par jour.

Aujourd'hui donc, une présentation générale de xindy et de ses avantages sur makeindex.

Rappel : comment fonctionne l'indexation avec (X^e)LaTeX

L'indexation avec LaTeX fonctionne classiquement ainsi :

Une commande d'indexation, définie par un package ad hoc, est appelée par l'utilisateur. Souvent cette commande est tout simplement \index{}. Les packages proposant de gérer plusieurs index proposent généralement des commandes de la forme \index[]{}.
Cette commande écrit dans un ou plusieurs fichiers .idx des lignes de la forme \indexentry{}{}. Si vous utilisez le package splitindex, la forme utilisée est \indexentry[{}{}.
Un programme externe à LaTeX transforme ce ou ces fichiers .idx en des fichiers .ind, qui regroupe les termes et indique les emplacements. Classiquement ce fichier contiendra quelque chose comme : \begin{theindex} \item , , \item , \end{theindex}
Le programme qui procède à cette transformation est généralement makeindex, mais il peut aussi s'agir de splitindex (qui lit les fichiers .idx produit par le package homonyme) ou xindy. Il utilise pour ce faire des règles qui lui sont propres et d'autres qui dépendent de fichiers spécifiques. Dans le cas de makeindex, il s'agit du fichier de style .ist. Dans le cas de xindy.xdy.
lors de la seconde lecture du fichier .tex par (X^e)LaTeX, la commande \printindex, définie par le package d'indexation, va lire le fichier .ind de l'index demandé et l'interpréter. Le fichier .ind ne contenant que du code TeX, son interprétation suit les règles classiques de compréhension du code TeX.

Ainsi, il y a trois étapes pour générer un index avec LaTeX :

exécution de (X^e)LaTeX qui écrit le(s) fichier(s) .idx
exécution du logiciel d'indexation, qui transforme le(s) fichier(s) d'indexation brut(s) (.idx) en fichier(s) d'indexation formaté(s) (.ind).
seconde exécution de (X^e)LaTeX qui lit le(s) fichier(s) .ind.

Cependant si vous utilisez le package imakeidx ou son successeur indextools, celui ci utilise une des possibilités des moteurs TeX modernes : la possibilité de lancer automatiquement un package. C'est pourquoi vous n'avez généralement pas à lancer makeindex et ne faites par conséquences qu'un compilation (X^e)LaTeX.

Avantages de `xindy` sur `makeindex`

Le logiciel makeindex est le logiciel historique [2].

Son principal défaut, qui à lui seul justifie de passer à xindy, est de fonctionne uniquement en ASCII et d'ignorer l'Unicode, ce qui s'avère particulièrement problématique si on rédige un document dans une autre langue que l'anglais.

Ainsi un fichier .idx contenant les lignes suivantes :

\indexentry{Souris}{1} \indexentry{Chat}{1} \indexentry{Éléphant}{1}

Sera transformé en fichier .ind contenant les lignes suivantes

 \item Chat, 1 \indexspace \item Souris, 1 \indexspace \item Éléphant, 1

Ce qui ne respecte visiblement pas l'ordre alphabétique. La solution classique est alors d'utiliser le @ pour forcer l'ordre de tri.

Ainsi un fichier contenant .idx

\indexentry{Chat}{1} \indexentry{Elephant@Éléphant}{1} \indexentry{Souris}{1}

sera transformé par makeindex en fichier .ind contenant :

 \item Chat, 1 \indexspace \item Éléphant, 1 \indexspace \item Souris, 1

Cette solution fonctionne, mais s'avère peut pratique à l'usage, notamment si on veut créer des commandes pour automatisation l'indexation de certains termes.

Avec xindy, ce problème ne se pose plus. Pour peux qu'on lui fournisse les bon paramètres, un fichier .idx contenant

\indexentry{Chat}{1} \indexentry{Éléphant}{1} \indexentry{Souris}{1}

 \item Chat, 1 \indexspace \item Éléphant, 1 \indexspace \item Souris, 1

Mais xindy propose bien plus que cela. Les prochains articles expliqueront comment se servir de certains fonctionnalités comme :

la création d'un ordre d'indexation personnalisé, par exemple pour trier les empereurs par date de règne, sans passer par l'astuce du @.
la gestion des numéros de renvois contenant des sous numéros, par exemple sous la forme page, ligne.
d'autres que je découvrirait au fur et à mesure

Il y a cependant quelques limites à xindy, la première étant une moindre compatibilité avec le package hyperref. Mais nous y viendrons en temps voulu.

`texindy`, un `xindy` spécial LaTeX

Une dernière précision s'impose avant de passer aux choses sérieux. Contrairement à makeindex qui transforme des fichiers utilisant une syntaxe LaTeX en des fichiers utilisant une syntaxe LaTeX, xindy peut travailler avec des fichiers ayant une autre syntaxe, par exemple du xml.

C'est pourquoi il existe une version spécifique de xindy, nommée texxindy qui possèdent des réglages par défaut spécifiques aux fichiers utilisant une syntaxe .tex.

[1] J'exclus le LaTeX Companion qu'on ne peut raisonnablement considérer comme un ouvrage d'introduction.

[2] il est d'ailleurs le seul à être livré avec la distribution TeX pour Windows Miktex

indextools, un fork de imakeidx

Maïeul — 2015-01-25T14:11:54Z

À mon grand regret j'ai du, pour la première fois de ma vie, créé un fork d'un package. Le package imakeidx a dont une nouvelle version : indextools.

La raison technique

La raison technique de cette fork est la suivante : lorsqu'on utile hyperref en combinaison avec un package d'indexation, il est conseillé de charger hyperref après le package, pour avoir des liens internes.

Cependant hyperref doit être chargé avant bidi, le package qui permet de gérer les langues qui s'écrivent de droite à gauche. Ce qui fait que l'ordre de chargement correct est :

imakeidx
hyperref
bidi

Malheureusement, bidi redéfinie la manière dont est affichée l'index, ce qui entraîne pour conséquent que certaine fonctionnalité de imakeidx, notamment le reformatage de l'index, ne sont plus prises en compte.

Pour résoudre ce problème, il fallait donc modifier imakeidx pour que ce dernier définisse l'affichage de l'index lors du \begin{document}, dont après bidi.

La raison humaine

Ayant trouvé ce bug, je l'ai signalé à l'auteur d'imakeidx. Celui-ci n'a pas daigné me répondre, même pour me dire, par exemple, que ma solution était mauvaise. Juste ... rien, pas de réponse.

Je l'ai donc contacté via un réseau public pour :

lui demander pourquoi il ne répondait pas
si c'était par manque de temps pour s'occuper d'imakeidx, s'il souhaitait me déléguer la gestion du package.
sinon, s'il comptait intégrer une correction de ce bug.

L'auteur n'a pas répondu ni à la première ni à la troisième question. Quant à la seconde, il a indiqué, séchement, qu'il ne souhaitait pas que je reprenne le package.

Il a sans doute ses raisons, mais en attendant un bug existe, et je trouve idiot de laisse un package ainsi bugué.

C'est pourquoi j'ai, avec regret, décidé de forker le projet, c'est à dire d'en faire une version divergente de la version principale. Ce fork est donc sorti : indextools.

Pour le moment il se contente de résoudre ce bug. J'espère qu'un jour nous n'aurons plus qu'un seul package. En attendant, ceux qui souhaitent utiliser les fonctionnalités de bidi, hyperref et imakeidx en même temps peuvent utilise indextools.

Indexation et renvoi

Maïeul — 2013-06-11T18:45:07Z

Il est possible dans un index de renvoyer vers une autre entrée d'index, grâce à la syntaxe |see{index}. Attention cependant : l'entrée à laquelle on renvoie n'est pas pour autant indexée.

Prenons par exemple le code suivant :

Le Christ lui dit : \enquote{Saül, Saül, pourquoi me persécutes-tu ?}\index{Saül|see{Paul}}

Nous aurons bien une entrée d'index :

Saül, voir Paul

Mais aucune entrée « Paul » correspondant à la page de notre texte.

Il faut donc mettre

Le Christ lui dit : \enquote{Saül, Saül, pourquoi me persécutes-tu ?}\index{Saül|see{Paul}}\index{Paul}

Geekographie Maïeulesque

xindy et bibleref

Le problème

Analyse du problème

Résultat final

xindy, hyperref et |see

Fichier d'exemple

Analyse du fichier .idx et du fichier .ind

Modification du .xdy

Définition de \seelink et de \targetindexentry

Correction de \hyperlink et hypertarget

Tri personnalisé des entrées avec xindy

Exemple

Première méthode : l'arobase

Deuxième méthode : le fichier .xdy

xindy, eledmac et hyperref

Pré-requis

Fichier d'exemple

Trois premières compilations XeLaTeX

Compilation xindy

xindy et hyperref

Un exemple qui marche …

… mais c'est tout

La cause du problème

Solution

Désactiver la modification de l'index par hyperref

Configuration de xindy

Régler l'apparence des index avec xindy

Exemple adapté à la situation

Répartition des tâches

Trois exemples de configuration niveau LaTeX

Colonages : les options de indextools

Apparence des sectionnement par lettre

Une flèche avant les sous-entrée bibliographique

XXX exemples de configuration niveau au niveau de xindy

xindy, ou la succession de fichiers de configuration

Séparation l'entrée et ses références par une ligne de point

Regrouper les pages dans un intervalle

Pas de regroupement des pages

Regroupement dès deux pages

s et ss

Synthèse

Premier pas avec xindy

Préréquis

Fichier d'exemple minimal

Première compilation XeLaTeX

Deux exécutions de texindy

Deuxième compilation XeLaTeX

Automatiser les compilations : latexmk

xindy, un outil d'indexation plus efficace que makeindex

Rappel : comment fonctionne l'indexation avec (Xe)LaTeX

Avantages de xindy sur makeindex

texindy, un xindy spécial LaTeX

indextools, un fork de imakeidx

La raison technique

La raison humaine

Indexation et renvoi

Analyse du fichier `.idx` et du fichier `.ind`

Modification du `.xdy`

Définition de `\seelink` et de `\targetindexentry`

Correction de `\hyperlink` et `hypertarget`

Deuxième méthode : le fichier `.xdy`

Compilation `xindy`

Désactiver la modification de l'index par `hyperref`

Configuration de `xindy`

Colonages : les options de `indextools`

XXX exemples de configuration niveau au niveau de `xindy`

`xindy`, ou la succession de fichiers de configuration

`s` et `ss`

Deux exécutions de `texindy`

Automatiser les compilations : `latexmk`

Rappel : comment fonctionne l'indexation avec (X^e)LaTeX

Avantages de `xindy` sur `makeindex`

`texindy`, un `xindy` spécial LaTeX