[f66f990] | 1 | ;;; -*- mode: lisp; coding: utf-8; -*- |
---|
| 2 | |
---|
| 3 | ;; Unfortunately xindy is out-of-the-box hyperref-incompatible. This |
---|
| 4 | ;; configuration is a workaround, which requires to pass option |
---|
| 5 | ;; hyperindex=false to hyperref. |
---|
| 6 | ;; textit and emph not currently used, spxpagem replaces former textbf |
---|
| 7 | (define-attributes (("textbf" "textit" "emph" "spxpagem" "default"))) |
---|
| 8 | (markup-locref :open "\textbf{\hyperpage{" :close "}}" :attr "textbf") |
---|
| 9 | (markup-locref :open "\textit{\hyperpage{" :close "}}" :attr "textit") |
---|
| 10 | (markup-locref :open "\emph{\hyperpage{" :close "}}" :attr "emph") |
---|
| 11 | (markup-locref :open "\spxpagem{\hyperpage{" :close "}}" :attr "spxpagem") |
---|
| 12 | (markup-locref :open "\hyperpage{" :close "}" :attr "default") |
---|
| 13 | |
---|
| 14 | (require "numeric-sort.xdy") |
---|
| 15 | |
---|
| 16 | ;; xindy base module latex.xdy loads tex.xdy and the latter instructs |
---|
| 17 | ;; xindy to ignore **all** TeX macros in .idx entries, except those |
---|
| 18 | ;; explicitely described in merge rule. But when after applying all |
---|
| 19 | ;; merge rules an empty string results, xindy raises an error: |
---|
| 20 | |
---|
| 21 | ;; ERROR: CHAR: index 0 should be less than the length of the string |
---|
| 22 | |
---|
| 23 | ;; For example when using pdflatex with utf-8 characters the index |
---|
| 24 | ;; file will contain \IeC macros and they will get ignored except if |
---|
| 25 | ;; suitable merge rules are loaded early. The texindy script coming |
---|
| 26 | ;; with xindy provides this, but only for Latin scripts. The texindy |
---|
| 27 | ;; man page says to use rather xelatex or lualatex in case of Cyrillic |
---|
| 28 | ;; scripts. |
---|
| 29 | |
---|
| 30 | ;; Sphinx contributes LICRcyr2utf8.xdy to provide support for Cyrillic |
---|
| 31 | ;; scripts for the pdflatex engine. |
---|
| 32 | |
---|
| 33 | ;; Another issue caused by xindy ignoring all TeX macros except those |
---|
| 34 | ;; explicitely declared reveals itself when attempting to index ">>>", |
---|
| 35 | ;; as the ">" is converted to "\textgreater{}" by Sphinx's LaTeX |
---|
| 36 | ;; escaping. |
---|
| 37 | |
---|
| 38 | ;; To fix this, Sphinx does **not** use texindy, and does not even |
---|
| 39 | ;; load the xindy latex.xdy base module. |
---|
| 40 | |
---|
| 41 | ;(require "latex.xdy") |
---|
| 42 | |
---|
| 43 | ;; Rather it incorporates some suitable extracts from latex.xdy and |
---|
| 44 | ;; tex.xdy with additional Sphinx contributed rules. |
---|
| 45 | |
---|
| 46 | ;; But, this means for pdflatex and Latin scripts that the xindy file |
---|
| 47 | ;; tex/inputenc/uf8.xdy is not usable because it refers to the macro |
---|
| 48 | ;; \IeC only sporadically, and as tex.xdy is not loaded, a rule such as |
---|
| 49 | ;; (merge-rule "\'e" "é" :string) |
---|
| 50 | ;; does not work, it must be |
---|
| 51 | ;; (merge-rule "\IeC {\'e}" "é" :string) |
---|
| 52 | ;; So Sphinx contributes LICRlatin2utf8.xdy to mitigate that problem. |
---|
| 53 | |
---|
| 54 | ;;;;;;;; extracts from tex.xdy (discarding most original comments): |
---|
| 55 | |
---|
| 56 | ;;; |
---|
| 57 | ;;; TeX conventions |
---|
| 58 | ;;; |
---|
| 59 | |
---|
| 60 | ;; Discard leading and trailing white space. Collapse multiple white |
---|
| 61 | ;; space characters to blank. |
---|
| 62 | |
---|
| 63 | (merge-rule "^ +" "" :eregexp) |
---|
| 64 | (merge-rule " +$" "" :eregexp) |
---|
| 65 | (merge-rule " +" " " :eregexp) |
---|
| 66 | |
---|
| 67 | ;; Handle TeX markup |
---|
| 68 | |
---|
| 69 | (merge-rule "\\([{}$%&#])" "\1" :eregexp) |
---|
| 70 | |
---|
| 71 | ;;;;;;;; end of extracts from xindy's tex.xdy |
---|
| 72 | |
---|
| 73 | ;;;;;;;; extracts from latex.xdy: |
---|
| 74 | |
---|
| 75 | ;; Standard location classes: arabic and roman numbers, and alphabets. |
---|
| 76 | |
---|
| 77 | (define-location-class "arabic-page-numbers" ("arabic-numbers")) |
---|
| 78 | (define-location-class "roman-page-numbers" ("roman-numbers-lowercase")) |
---|
| 79 | (define-location-class "Roman-page-numbers" ("roman-numbers-uppercase")) |
---|
| 80 | (define-location-class "alpha-page-numbers" ("alpha")) |
---|
| 81 | (define-location-class "Alpha-page-numbers" ("ALPHA")) |
---|
| 82 | |
---|
| 83 | ;; Output Markup |
---|
| 84 | |
---|
| 85 | (markup-letter-group-list :sep "~n~n \indexspace~n") |
---|
| 86 | |
---|
| 87 | (markup-indexentry :open "~n \item " :depth 0) |
---|
| 88 | (markup-indexentry :open "~n \subitem " :depth 1) |
---|
| 89 | (markup-indexentry :open "~n \subsubitem " :depth 2) |
---|
| 90 | |
---|
| 91 | (markup-locclass-list :open ", " :sep ", ") |
---|
| 92 | (markup-locref-list :sep ", ") |
---|
| 93 | |
---|
| 94 | ;;;;;;;; end of extracts from latex.xdy |
---|
| 95 | |
---|
| 96 | ;; The LaTeX \index command turns \ into normal character so the TeX macros |
---|
| 97 | ;; written to .idx files are not followed by a blank. This is different |
---|
| 98 | ;; from non-ascii letters which end up (with pdflatex) as \IeC macros in .idx |
---|
| 99 | ;; file, with a blank space after \IeC |
---|
| 100 | |
---|
| 101 | ;; Details of the syntax are explained at |
---|
| 102 | ;; http://xindy.sourceforge.net/doc/manual-3.html |
---|
| 103 | ;; In absence of :string, "xindy uses an auto-detection mechanism to decide, |
---|
| 104 | ;; if the pattern is a regular expression or not". But it is not obvious to |
---|
| 105 | ;; guess, for example "\\_" is not detected as RE but "\\P\{\}" is, so for |
---|
| 106 | ;; being sure we apply the :string switch everywhere and do not use \\ etc... |
---|
| 107 | |
---|
| 108 | ;; Go back from sphinx.util.texescape TeX macros to UTF-8 |
---|
| 109 | |
---|
| 110 | (merge-rule "\sphinxleftcurlybrace{}" "{" :string) |
---|
| 111 | (merge-rule "\sphinxrightcurlybrace{}" "}" :string) |
---|
| 112 | (merge-rule "\_" "_" :string) |
---|
| 113 | (merge-rule "{[}" "[" :string) |
---|
| 114 | (merge-rule "{]}" "]" :string) |
---|
| 115 | (merge-rule "{}`" "`" :string) |
---|
| 116 | (merge-rule "\textbackslash{}" "\" :string) ; " for Emacs syntax highlighting |
---|
| 117 | (merge-rule "\textasciitilde{}" "~~" :string); the ~~ escape is needed here |
---|
| 118 | (merge-rule "\textless{}" "<" :string) |
---|
| 119 | (merge-rule "\textgreater{}" ">" :string) |
---|
| 120 | (merge-rule "\textasciicircum{}" "^" :string) |
---|
| 121 | (merge-rule "\P{}" "¶" :string) |
---|
| 122 | (merge-rule "\S{}" "§" :string) |
---|
| 123 | (merge-rule "\texteuro{}" "€" :string) |
---|
| 124 | (merge-rule "\(\infty\)" "∞" :string) |
---|
| 125 | (merge-rule "\(\pm\)" "±" :string) |
---|
| 126 | (merge-rule "\(\rightarrow\)" "→" :string) |
---|
| 127 | (merge-rule "\(\checkmark\)" "✓" :string) |
---|
| 128 | (merge-rule "\textendash{}" "–" :string) |
---|
| 129 | (merge-rule "\textbar{}" "|" :string) |
---|
| 130 | (merge-rule "\(\sp{\text{0}}\)" "⁰" :string) |
---|
| 131 | (merge-rule "\(\sp{\text{1}}\)" "¹" :string) |
---|
| 132 | (merge-rule "\(\sp{\text{2}}\)" "²" :string) |
---|
| 133 | (merge-rule "\(\sp{\text{3}}\)" "³" :string) |
---|
| 134 | (merge-rule "\(\sp{\text{4}}\)" "⁴" :string) |
---|
| 135 | (merge-rule "\(\sp{\text{5}}\)" "⁵" :string) |
---|
| 136 | (merge-rule "\(\sp{\text{6}}\)" "⁶" :string) |
---|
| 137 | (merge-rule "\(\sp{\text{7}}\)" "⁷" :string) |
---|
| 138 | (merge-rule "\(\sp{\text{8}}\)" "⁸" :string) |
---|
| 139 | (merge-rule "\(\sp{\text{9}}\)" "⁹" :string) |
---|
| 140 | (merge-rule "\(\sb{\text{0}}\)" "₀" :string) |
---|
| 141 | (merge-rule "\(\sb{\text{1}}\)" "₁" :string) |
---|
| 142 | (merge-rule "\(\sb{\text{2}}\)" "₂" :string) |
---|
| 143 | (merge-rule "\(\sb{\text{3}}\)" "₃" :string) |
---|
| 144 | (merge-rule "\(\sb{\text{4}}\)" "₄" :string) |
---|
| 145 | (merge-rule "\(\sb{\text{5}}\)" "₅" :string) |
---|
| 146 | (merge-rule "\(\sb{\text{6}}\)" "₆" :string) |
---|
| 147 | (merge-rule "\(\sb{\text{7}}\)" "₇" :string) |
---|
| 148 | (merge-rule "\(\sb{\text{8}}\)" "₈" :string) |
---|
| 149 | (merge-rule "\(\sb{\text{9}}\)" "₉" :string) |
---|
| 150 | (merge-rule "\(\alpha\)" "α" :string) |
---|
| 151 | (merge-rule "\(\beta\)" "β" :string) |
---|
| 152 | (merge-rule "\(\gamma\)" "γ" :string) |
---|
| 153 | (merge-rule "\(\delta\)" "δ" :string) |
---|
| 154 | (merge-rule "\(\epsilon\)" "ε" :string) |
---|
| 155 | (merge-rule "\(\zeta\)" "ζ" :string) |
---|
| 156 | (merge-rule "\(\eta\)" "η" :string) |
---|
| 157 | (merge-rule "\(\theta\)" "θ" :string) |
---|
| 158 | (merge-rule "\(\iota\)" "ι" :string) |
---|
| 159 | (merge-rule "\(\kappa\)" "κ" :string) |
---|
| 160 | (merge-rule "\(\lambda\)" "λ" :string) |
---|
| 161 | (merge-rule "\(\mu\)" "μ" :string) |
---|
| 162 | (merge-rule "\(\nu\)" "ν" :string) |
---|
| 163 | (merge-rule "\(\xi\)" "ξ" :string) |
---|
| 164 | (merge-rule "\(\pi\)" "π" :string) |
---|
| 165 | (merge-rule "\(\rho\)" "ρ" :string) |
---|
| 166 | (merge-rule "\(\sigma\)" "σ" :string) |
---|
| 167 | (merge-rule "\(\tau\)" "τ" :string) |
---|
| 168 | (merge-rule "\(\upsilon\)" "υ" :string) |
---|
| 169 | (merge-rule "\(\phi\)" "φ" :string) |
---|
| 170 | (merge-rule "\(\chi\)" "χ" :string) |
---|
| 171 | (merge-rule "\(\psi\)" "ψ" :string) |
---|
| 172 | (merge-rule "\(\omega\)" "ω" :string) |
---|
| 173 | (merge-rule "\(\Gamma\)" "Γ" :string) |
---|
| 174 | (merge-rule "\(\Delta\)" "Δ" :string) |
---|
| 175 | (merge-rule "\(\Theta\)" "Θ" :string) |
---|
| 176 | (merge-rule "\(\Lambda\)" "Λ" :string) |
---|
| 177 | (merge-rule "\(\Xi\)" "Ξ" :string) |
---|
| 178 | (merge-rule "\(\Pi\)" "Π" :string) |
---|
| 179 | (merge-rule "\(\Sigma\)" "Σ" :string) |
---|
| 180 | (merge-rule "\(\Upsilon\)" "Υ" :string) |
---|
| 181 | (merge-rule "\(\Phi\)" "Φ" :string) |
---|
| 182 | (merge-rule "\(\Psi\)" "Ψ" :string) |
---|
| 183 | (merge-rule "\(\Omega\)" "Ω" :string) |
---|
| 184 | |
---|
| 185 | ;; This xindy module provides some basic support for "see" |
---|
| 186 | (require "makeindex.xdy") |
---|
| 187 | |
---|
| 188 | ;; This creates one-letter headings and works fine with utf-8 letters. |
---|
| 189 | ;; For Cyrillic with pdflatex works thanks to LICRcyr2utf8.xdy |
---|
| 190 | (require "latin-lettergroups.xdy") |
---|
| 191 | |
---|
| 192 | ;; currently we don't (know how to easily) separate "Numbers" from |
---|
| 193 | ;; "Symbols" with xindy as is the case with makeindex. |
---|
| 194 | (markup-index :open "\begin{sphinxtheindex} |
---|
| 195 | \let\lettergroup\sphinxstyleindexlettergroup |
---|
| 196 | \let\lettergroupDefault\sphinxstyleindexlettergroupDefault |
---|
| 197 | \let\spxpagem\sphinxstyleindexpagemain |
---|
| 198 | \let\spxentry\sphinxstyleindexentry |
---|
| 199 | \let\spxextra\sphinxstyleindexextra |
---|
| 200 | |
---|
| 201 | " |
---|
| 202 | :close " |
---|
| 203 | |
---|
| 204 | \end{sphinxtheindex} |
---|
| 205 | " |
---|
| 206 | :tree) |
---|
| 207 | |
---|