IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update LaTeX xindy docs

Browse Source
This commit is contained in:
jfbu 2018-07-26 14:07:21 +02:00
parent d5a82c6245
commit 9a0097bef2
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
doc/usage/configuration.rst
View File

@ -1926,26 +1926,23 @@ macros and environments, see also :doc:`/latex`.
__ http://xindy.sourceforge.net/ __ http://xindy.sourceforge.net/
- This option is ignored if :confval:`latex_engine` is ``'platex'`` - This option is ignored if :confval:`latex_engine` is ``'platex'``
(Japanese documents) as :program:`mendex` is used in that case. (Japanese documents; :program:`mendex` replaces :program:`makeindex`
then).
- The default is ``True`` for ``'xelatex'`` or ``'lualatex'`` as - The default is ``True`` for ``'xelatex'`` or ``'lualatex'`` as
:program:`makeindex`, if any indexed term starts with a non-ascii :program:`makeindex`, if any indexed term starts with a non-ascii
character, creates ``.ind`` file containing invalid bytes for character, creates ``.ind`` files containing invalid bytes for
UTF-8 encoding. With ``'lualatex'`` this then breaks the PDF UTF-8 encoding. With ``'lualatex'`` this then breaks the PDF
build. Notice that :program:`xindy` supports most but not build.
all European languages.
- The default is ``False`` for ``'pdflatex'`` but ``True`` is - The default is ``False`` for ``'pdflatex'`` but ``True`` is
recommended for non-English documents as soon as some indexed recommended for non-English documents as soon as some indexed
terms use non-ascii characters from the language script. terms use non-ascii characters from the language script.
Cyrillic scripts are (transparently) supported with
``'pdflatex'`` thanks to a specific Sphinx-contributed ``xindy``
style file :file:`cyrLICRutf8.xdy`.
As :program:`xindy` does not support the same range of languages Sphinx adds to :program:`xindy` base distribution some dedicated support
as ``LaTeX/babel`` does, the default :program:`makeindex` for for using ``'pdflatex'`` engine with Cyrillic scripts. And whether with
``'pdflatex'`` may be preferred in some circumstances, although ``'pdflatex'`` or Unicode engines, Cyrillic documents handle correctly the
the index will be ill-formed probably. indexing of Latin names, even with diacritics.
.. versionadded:: 1.8 .. versionadded:: 1.8