From 90c2b528b1595d9efe7497682f5e0172517453c7 Mon Sep 17 00:00:00 2001 From: jfbu Date: Sat, 30 Jun 2018 23:37:26 +0200 Subject: [PATCH] Update docs and CHANGES for ``latex_use_xindy`` config variable --- CHANGES | 2 ++ doc/usage/configuration.rst | 27 +++++++++++++++++++++++++++ 2 files changed, 29 insertions(+) diff --git a/CHANGES b/CHANGES index d7761f542..d04da2e54 100644 --- a/CHANGES +++ b/CHANGES @@ -143,6 +143,7 @@ Features added for mathjax * #4362: latex: Don't overwrite .tex file if document not changed * #1431: latex: Add alphanumeric enumerated list support +* Add :confval:`latex_use_xindy` for UTF-8 savvy indexing Bugs fixed ---------- @@ -152,6 +153,7 @@ Bugs fixed * #4945: i18n: fix lang_COUNTRY not fallback correctly for IndexBuilder. Thanks to Shengjing Zhu. * #4983: productionlist directive generates invalid IDs for the tokens +* #5132: (lualatex) PDF build fails if indexed word starts with Unicode characters Testing -------- diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index a0fbe641a..99b55f67e 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -1872,6 +1872,33 @@ information. .. versionadded:: 1.6 +.. confval:: latex_use_xindy + + If ``True`` (default ``False``), the PDF build from the LaTeX files + created by Sphinx will use :program:`xindy` (doc__) rather than + :program:`makeindex`. This means that utf-8 initials in indexed + words will be handled correctly, and entries will be ordered + according to the rules appropriate to the :confval:`language`. + Currently, this uses :program:`texindy` and only (most) European + languages with Latin scripts are supported. For usages requiring + direct use of ``xindy``, user will have to customize the files + :file:`Makefile` and :file:`latexmkrc` which are written to LaTeX + build repertory. This can be done via + :confval:`latex_additional_files` and customized such files located + in source repertory. + + __ http://xindy.sourceforge.net/ + + This option is recommended in case of :confval:`latex_engine` set + to ``xelatex`` or ``lualatex`` (it is even mandatory for the latter + as the PDF build is broken if some indexed terms start with a + non-ascii character). It is without effect in case of + :confval:`platex` (Japanese documents). Even if + :confval:`latex_engine` is left to its default, the option is + recommended as soon as indexed terms use non-ascii characters. + + .. versionadded:: 1.8 + .. confval:: latex_elements .. versionadded:: 0.5