[Tex/LaTex] Why Glossaries with Xindy unable to execute（cannot find the correct PATH)

cjkglossariespathsxindy

After I compiled a tex file by xelatex, I use Glosarries with Xindy to make a index, it reported:

    $ makeglossaries test
makeglossaries version 2.04 (2012-05-19)
added glossary type 'main' (glg,gls,glo)
xindy  -L english  -I xindy -M "test" -t "test.glg" -o "test.gls" "test.glo"
Opening logfile "test.glg" 
ERROR: Opening logfile "test.glg" failed!

***Call to xindy failed***

Check 'test.glg' for details

And in test.glg, there are:

*** Unable to execute: 'xindy  -L english  -I xindy -M "test" -t "test.glg" -o "test.gls" "test.glo"' ***  Status report:
Opening logfile "test.glg"
ERROR: Opening logfile "test.glg" failed!

But I can use xindy on my Mac in my terminal:

    Jing@Jing2MacBook-Pro ~$ xindy
    You need to specify --out-file if the raw index is read from standard input.
    usage: xindy [-V?h] [-qv] [-d magic] [-o outfile.ind] [-t log]         ................

What's the problem?

There is a similar problem and provided me an useful idea:

Makeindex fails when called from a script

There is the true problem same as my question:

xindy cannot open the temp file

For 'glossaries' when it doesn't use Xindy, we have to use 'makeglossaries test.tex' in the folder where .tex is.

For 'glossaries' when it's with Xindy, Xindy also has the path problem, but we must copy the tex file to xindy's Temp folders, then xindy can only work.

The keypoint is:

'makeglossaries' or xindy can not use the folder where .tex file(and some other files came from .tex after compiled by xelatex ) as the TMPDIR, it uses the system default TMPDIR, so 'makeglossaries' can not find .glg, then 'makeglossaries' can't make a index.

You can use command 'env' in Terminal to find out what is your default TMPDIR of system. My default TMPDIR in system is:

TMPDIR=/var/folders/9h/71txqqf572x998x6sm4c6l440000gn/T/

So I must copy all the tex file I want to make index in /var/folders/9h/71txqqf572x998x6sm4c6l440000gn/T/, compile tex file there, then xindy can only work.

Otherwise, we have to manully change the TMPDIR in Terminal to the folder where .tex file is after
xelatex test.tex
in current session.

If your tex file are in /Users/Jhering/mynewbook/,in Mac/Linux/Unix-like, to change TMPDIR looks like:

export TMPDIR=/Users/Jhering/mynewbook/

In windows ,eg:

set TEMP=C:\Users\Jhering\mynewbook

Then you can

makeglossaries test

xelatex test.tex

But how can we don't need change the TMPDIR to the folder where .tex file is every time?

Sample Code (originally came from the package glossaries, none was edited):

Make sure you have had the parameter 'xindy' as follows:

      \usepackage[xindy]{glossaries}

The test.tex file is:

% This file is public domain.
 %
 % This is a sample document illustrating how to use the
 % glossaries package with xindy. To create the document:
 %
 %   latex samplexdy
 %   makeglossaries samplexdy
 %   latex samplexdy
 %
 % If you don't have Perl installed, then use one of the
 % following instead of makeglossaries:
 %
 % If you want to have a separate "Mc" letter group do:
 %
 %    xindy -I xindy -M samplexdy-mc -t samplexdy.glg -o samplexdy.gls samplexdy.glo
 %
 % Otherwise do:
 %
 %  xindy -L english -C utf8 -I xindy -M samplexdy -t samplexdy.glg -o samplexdy.gls samplexdy.glo
 %
\documentclass{article}

\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage{fmtcount}

\usepackage[colorlinks,plainpages]{hyperref}
\usepackage[xindy,style=altlistgroup]{glossaries}

 % Define a new command to do bold italic:

\newcommand*{\hyperbfit}[1]{\textit{\hyperbf{#1}}}

 % Need to add this to the list of attributes in order
 % to use it with xindy:
 % (This command will have no effect if \noist is used)

\GlsAddXdyAttribute{hyperbfit}

 % Redefine the page numbers so that they appear as a word:

 \renewcommand*{\thepage}{\Numberstring{page}}

 % Need to add this to the list of location styles.
 % \Numberstring{page} gets expanded to
 % \protect \Numberstringnum {<n>} (where <n> is the page number)
 % so need to define the location in that format:
 % (This command will have no effect if \noist is used)

\GlsAddXdyLocation{Numberstring}{:sep "\string\protect\space
  \string\Numberstringnum\space\glsopenbrace"
  "arabic-numbers" :sep "\glsclosebrace"}

 % (Need to redefine \glsXpageXhyperbfit and
 % \glsXpageXglsnumberformat after \makeglossaries to get the
 % hyperlinks working correctly.)

 % To have Mc as a separate group uncomment the following three
 % lines:

 %\setStyleFile{samplexdy-mc} % note no extension
 %\noist
 %\GlsSetXdyLanguage{}

 % The above three lines specify to use samplexdy-mc.xdy (supplied
 % with this file) and don't overwrite it. The language is
 % unset using \GlsSetXdyLanguage{} as all the language
 % dependent information is contained in samplexdy-mc.xdy
 % Note that using \noist means that commands like
 % \GlsAddXdyAttribute and \GlsAddXdyLocation will no longer have
 % an effect.

 % Write the style file (if \noist isn't used)
 % and activate glossary entries

\makeglossaries

 % Each page location will be specified in the form:
 %
 % "\glsXpageXglsnumberformat{}{\protect \Numberstringnum "\marg{n}"}"
 % or
 % "\glsXpageXhyperbfit{}{\protect \Numberstringnum "\marg{n}"}"
 %
 % Redefine to allow hyperlinks:

\renewcommand{\glsXpageXglsnumberformat}[2]{%
 \linkpagenumber#2%
}

\renewcommand{\glsXpageXhyperbfit}[2]{%
 \textbf{\em\linkpagenumber#2}%
}

\newcommand{\linkpagenumber}[3]{\hyperlink{page.#3}{#1#2{#3}}}

 % Define glossary entries
 % \glshyperlink is used instead of \gls to prevent the glossary
 % page numbers also appear in the locations, however I need
 % to ensure that the referenced entries are added to the
 % glossary via commands that use \glslink, \glsadd or \glssee

\newglossaryentry{mcadam}{name={McAdam, John Loudon},
first={John Loudon McAdam},text={McAdam},
description={Scottish engineer}}

\newglossaryentry{maclaurin}{name={Maclaurin, Colin},
first={Colin Maclaurin},text={Maclaurin},
description={Scottish mathematician best known for the
\gls{maclaurinseries}}}

\newglossaryentry{maclaurinseries}{name={Maclaurin series},
description={Series expansion},see={taylorstheorem}}

\newglossaryentry{taylorstheorem}{name={Taylor's theorem},
description={Theorem expressing a function $f(x)$ as the sum of
a polynomial and a remainder:
\[f(x) = f(a)+f'(a)(x-a)+f''(a)(x-a^2)/2!+\cdots+R_n\]
If $n\to\infty$ the expansion is a \glshyperlink{taylorseries}
and if $a=0$, the series is called a
\gls{maclaurinseries}}}

\newglossaryentry{taylorseries}{name={Taylor series},
description={Series expansion},see={taylorstheorem}}

\newglossaryentry{taylor}{name={Taylor, Brook},
first={Brook Taylor},text={Taylor},
description={English mathematician}}

\newglossaryentry{mcnemar}{name={McNemar, Quinn},
first={Quinn McNemar},text={McNemar},
description={Mathematician who introduced
\gls{mcnemarstest}. This entry has the number list
suppressed},nonumberlist}

\newglossaryentry{mcnemarstest}{name={McNemar's test},
description={A nonparametric test introduced by
\gls{mcnemar} in 1947}}

\newglossaryentry{mach}{name={Mach, Ernst},
first={Ernst Mach},text={Mach},
 % if using samplexdy-mc.xdy, the following line is needed
 % to prevent this entry being put in the "Mc" group
sort={mach, Ernst},
description={Czech/Austrian physicist and philosopher}}

\newglossaryentry{machnumber}{name={Mach number},
 % if using samplexdy-mc.xdy, the following line is needed
 % to prevent this entry being put in the "Mc" group
sort={mach number},
description={Ratio of the speed of a body in a fluid to the
speed of sound in that fluid named after \gls{mach}}}

\newglossaryentry{malthus}{name={Malthus, Thomas Robert},
first={Thomas Robert Malthus},text={Malthus},
description={English mathematician, sociologist and classicist}}

\newglossaryentry{ampereandre}{name={Ampère, André-Marie},
first={André-Marie Ampère},text={Ampère},
description={French mathematician and physicist}}

\newglossaryentry{ampere}{name={ampere},
description={SI unit of electric current named after
\gls{ampereandre}}}

\newglossaryentry{archimedes}{name={Archimedes of Syracuse},
first={Archimedes of Syracuse},text={Archimedes},
description={Greek mathematician}}

\newglossaryentry{archimedesprinciple}{name={Archemedes' principle},
description={Principle that if a body is submerged in a fluid
it experiences upthrust equal to the weight of the displaced
fluid. Named after \gls{archimedes}}}

\newglossaryentry{galton}{name={Galton, Sir Francis},
first={Sir Francis Galton},text={Galton},
description={English anthropologist}}

\newglossaryentry{gauss}{name={Gauss, Karl Friedrich},
first={Karl Friedrich Gauss},text={Gauss},
description={German mathematician}}

\newglossaryentry{gaussianint}{name={Gaussian integer},
description={Complex number where both real and imaginary
parts are integers}}

\newglossaryentry{peano}{name={Peano, Giuseppe},
first={Giuseppe Peano},text={Peano},
description={Italian mathematician}}

\newglossaryentry{peanoscurve}{name={Peano's curve},
description={A space-filling curve discovered by
\gls{peano}}}

\newglossaryentry{pearson}{name={Pearson, Karl},
first={Karl Pearson},text={Pearson},
description={English mathematician}}

\newglossaryentry{pearspmcc}{name={Pearson's product moment
correlation coefficient},description={Product moment correlation
coefficient named after \gls{pearson}}}

\begin{document}
\title{Sample Document Using the Glossaries Package With Xindy}
\author{Nicola Talbot}
\maketitle

\section{\glsentryfirst{gauss}}

This is a section on \gls[format=(]{gauss}. This section spans
several pages.

\newpage

This page talks about \glspl[format=hyperbfit]{gaussianint}. Since
it's the principle definition, the user-defined hyperbfit format is
used.

\newpage

The section on \gls[format=)]{gauss} ends here.

\section{Series Expansions}

This section is about series expansions. It mentions
\gls{maclaurin} and \gls{taylor}. It also discusses
\gls{taylorstheorem} which is related to the \gls{taylorseries}.
The \gls{maclaurinseries} is a special case of the
\gls{taylorseries}.

\section{\glsentryname{archimedesprinciple}}

This section discusses \gls{archimedesprinciple} which was
introduced by \gls{archimedes}.

\section{Another section}

This section covers \gls{mach} who introduced the \gls{machnumber}.
It also mentions \gls{ampereandre} after whom the
SI unit \gls{ampere} is named. It then discusses \gls{galton}
and \gls{malthus}. Finally it mentions \gls{mcadam}.

\newpage
This page discusses \gls{mcnemar} who introduced
\gls{mcnemarstest} and \gls{peano} who discovered \gls{peanoscurve}.

\printglossaries
\end{document}

It works when the folders' names and .tex files' names in PATH are not CJK characters. I have to change all my CJK files' names and folders' names in order to use xindy!

What an issue now in 21 century!

Best Answer

test.tex is in the folder ~/翻译
I use xindy --interactive -L english -M.... in Terminal to find where the temp folder of xindy.

enter image description here

Copy test.tex in the temp folder of xindy.

enter image description here 4. In this folder use

xelatex test.tex
makeglossaries test
xelatex test.tex

enter image description here 5. Xindy works.

enter image description here

But it is so dirty, I don't know how to resolve it fine.

Related Solutions

[Tex/LaTex] Problems with xindy and glossaries

You must set document language to german to let glossaries know how it should sort entries. Due to xindy bug, you also have to set encoding manually:

\documentclass[10pt,twoside,a4paper,fleqn]{book}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage[german]{babel}
\usepackage{ifthen, xkeyval, xfor, amsgen}
\usepackage[xindy]{glossaries}
\GlsSetXdyCodePage{duden-utf8}
\usepackage{translator}
\makeglossaries

\begin{document}

\newglossaryentry{real number}
{
    name={real number},
    description={include both rational numbers and irrational numbers},
    symbol={\ensuremath{\mathbb{R}}}
}

\newglossaryentry{Agypten}
{
    name = {{Ä}gypten},
    description = {German:Egypt}
}

\chapter{Model chapter for a report}

This is the first chapter of the report. Most certainly it will have
    some \glspl{real number}. Maybe there will be
    something in German, like \gls{Agypten}

\printglossary

\end{document}

Important lines are \usepackage[german]{babel} and \GlsSetXdyCodePage{duden-utf8}. Note that you missed comma in Agypten glossary entry.

Edit: if makeglossaries still don't work, try this:

xindy -M lang/german/duden-utf8 -I xindy -M test -t test.glg -o test.gls test.glo

[Tex/LaTex] Issue with xindy for package glossaries

It sounds like xindy is unable to determine how to sort one or more of your entries, but without a minimal example it's hard to tell exactly. The default is for xindy to sort on the entry name unless you have specified a sort value. However, xindy ignores (La)TeX commands so if the sort key only contains commands, xindy is left with a blank sort key and issues a warning. Earlier versions of xindy gave a somewhat cryptic error:

ERROR: CHAR: index 0 should be less than the length of the string

Newer versions give a slightly more understandable warning:

WARNING: Would replace complete index key by empty string, ignoring

Since the first warning isn't very easy to understand, makeglossaries searches for instances of it and if found gives the warning:

Possible cause of problem: Sort key required for entries only containing command names

Here's a minimal example illustrating the problem:

\documentclass{article}

\usepackage[xindy]{glossaries}

\makeglossaries

\newglossaryentry{P}{name={\P},description={Paragraph symbol}}

\newglossaryentry{S}{name={\S},description={Section symbol}}

\begin{document}

Reference the terms: \gls{S} \gls{P}.

\printglossaries

\end{document}

In this case the first term has the sort key \P and the second term has the sort key \S. In both cases, once xindy has stripped out the commands, it's left with an empty sort string and doesn't know how to compare the entries. Should \P come before or after \S? The solution is to provide a sort key for these entries:

\documentclass{article}

\usepackage[xindy]{glossaries}

\makeglossaries

\newglossaryentry{P}{name={\P},sort={P},description={Paragraph symbol}}

\newglossaryentry{S}{name={\S},sort={S},description={Section symbol}}

\begin{document}

Reference the terms: \gls{S} \gls{P}.

\printglossaries

\end{document}

If all your terms are like this (for example they are all symbols) then it may not make any sense trying to sort them alphabetically. In which case it might be better to sort them by definition (package option sort=def, as you mentioned in your comment) or by use in the document. In either of these cases, glossaries manufactures a numerical sort key for each term, so the issue no longer arises.

Edit: There's a GUI diagnostic tool for the glossaries package called makeglossariesgui which can provide further details by analysing the .aux, .log and associated glossary files. The example below has three problematic entries and a working one for comparison:

\documentclass{article}

\usepackage[utf8]{inputenc}
\usepackage[xindy]{glossaries}

\makeglossaries

\newglossaryentry{sample}{name={sample},
 description={an example}}

\newglossaryentry{S}{name={\S},
 description={section symbol}}

\newglossaryentry{alpha}{name={\ensuremath{\alpha}},
 description={alpha}}

\newglossaryentry{beta}{name={$\beta$},text={\beta},
 description={beta}}

\begin{document}
Test: \gls{sample}, \gls{S}, $\gls{alpha}$, $\gls{beta}$.

\printglossaries

\end{document}

A LaTeX run is first required to generate the .aux file (although this is usually already present if you're trying to work out why xindy has failed). The .aux file can then be opened in makeglossariesgui using the File > Open menu item.

For the above MWE, an error dialog is displayed to show that xindy failed:

Once that dialog box is dismissed, the "Diagnostics" tab lists each problem:

The text displayed is:

Xindy won't accept the sort value \S (for entry S) as it's treated as an empty string. This is because xindy ignores (La)TeX commands within the sort field, and once these commands have been stripped the sort field becomes empty. You will need to explicitly set the sort field using the sort key in the entry definition.

Xindy won't accept the sort value \ensuremath {\alpha } (for entry alpha) as it's treated as an empty string. This is because xindy ignores (La)TeX commands within the sort field, and once these commands have been stripped the sort field becomes empty. You will need to explicitly set the sort field using the sort key in the entry definition.

Xindy won't accept the sort value $\beta $ (for entry beta) as it's treated as an empty string. This is because xindy ignores (La)TeX commands within the sort field, and once these commands have been stripped the sort field becomes empty. You will need to explicitly set the sort field using the sort key in the entry definition.

Xindy reported the following:
    WARNING: Would replace complete index key by empty string, ignoring
         #<ordrule-regexp: '\\[a-zA-Z@]+ *' => '' :again NIL :only-at-start NIL
    ERROR: CHAR: index 0 should be less than the length of the string

So this explicitly identifies each problematic entry by its label (which neither xindy nor makeglossaries do).

The "General Information" tab contains a "Details" link, which when clicked on opens a window with a summary of all the entries. The second column shows the sort key, which is displayed in red if there's a problem with it.

Once the problems have been fixed, you can switch back to using makeglossaries or explicitly xindy.

Incidentally, the glossaries-extra package, provides the command \glsxtrnewsymbol when the symbols package option is used. This internally uses \newglossaryentry but sets the sort value to the label rather than the name field. For example:

\glsxtrnewsymbol[text={\beta},description={beta example}]{beta}{$\beta$}

This is equivalent to

\newglossaryentry{beta}{name={$\beta$},text={\beta},
 sort={beta},
 type=symbols,
 category=symbol,
 description={beta example}}