From 161f6fe963657c26131dfd27baa4bbb5548aae3d Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Thu, 28 May 2020 17:48:11 +0000 Subject: document :min-range-length none workaround, from J\"urgen S git-svn-id: svn://tug.org/texlive/trunk@55314 c570f23f-e606-0410-a88d-b1316a301751 --- Build/source/utils/xindy/ChangeLog | 7 ++++ .../utils/xindy/TLpatches/patch-10-doc-min-range | 45 ++++++++++++++++++++++ Build/source/utils/xindy/xindy-src/doc/faq-4.html | 9 +++-- .../source/utils/xindy/xindy-src/doc/manual-3.html | 6 +-- 4 files changed, 60 insertions(+), 7 deletions(-) create mode 100644 Build/source/utils/xindy/TLpatches/patch-10-doc-min-range diff --git a/Build/source/utils/xindy/ChangeLog b/Build/source/utils/xindy/ChangeLog index f63b2db255c..ec9c6911fab 100644 --- a/Build/source/utils/xindy/ChangeLog +++ b/Build/source/utils/xindy/ChangeLog @@ -1,3 +1,10 @@ +2020-05-28 J\"urgen Spitzm\"uller + + * xindy-src/doc/faq-4.html, + * xindy-src/doc/manual-3.html: document workaround for + :min-range-length none being broken. + https://github.com/jschrod/xindy.ctan/issues/3 + 2020-03-08 Karl Berry * xindy-src/make-rules/alphabets/Makefile.am (alphabets-inc.tex): diff --git a/Build/source/utils/xindy/TLpatches/patch-10-doc-min-range b/Build/source/utils/xindy/TLpatches/patch-10-doc-min-range new file mode 100644 index 00000000000..644be4b42b5 --- /dev/null +++ b/Build/source/utils/xindy/TLpatches/patch-10-doc-min-range @@ -0,0 +1,45 @@ +diff --git a/doc/faq-4.html b/doc/faq-4.html +index 8105256..3a57b7a 100644 +--- a/doc/faq-4.html ++++ b/doc/faq-4.html +@@ -460,11 +460,12 @@ location references. For exmaple the sequence + the form +

+

+-  (define-location-class ... :min-range-length none)
++  (define-location-class ... :min-range-length 100000)
+ 
+-

The argument :min-range-length none avoids forming of ranges. +-Arbitrary numbers instead of none define the minimum length of a +-sequence of location references that are needed to form a range. ++

Arbitrary numbers define the minimum length of a sequence of location references that are needed to form a range. ++The use of a sufficiently large number (such as :min-range-length 100000) avoids forming of ranges ++(unless your document has more than 100.000 pages and an index entry spans all of them; in this unlikely case, just increase ++the number sufficiently). + xindys default value is 2. +

+

+diff --git a/doc/manual-3.html b/doc/manual-3.html +index 3520de7..e00cf79 100644 +--- a/doc/manual-3.html ++++ b/doc/manual-3.html +@@ -185,8 +185,8 @@ strings representing separators. Separators must follow the + keyword argument :sep. If the keyword :min-range-length is + specified we define the minimum range length to be used when + building ranges. The argument num must be a positive integer +-number or the keyword none in which case the building of ranges +-is disallowed. If the switch :var is specified the declared class ++number. Use a sufficiently large number (such as 10000) to disallow the building of ranges. ++If the switch :var is specified the declared class + is of type variable, i.e. it is a var-location-class. Since + building of ranges is currently only allowed for standard classes + :var and :min-range-length must not be used together. The +@@ -198,7 +198,7 @@ layers the hierarchy does contain. See command +

+

+   (define-location-class "page-numbers" ("arabic-numbers")
+-                         :minimum-range-length 3)
++                         :min-range-length 3)
+ 
+

Defines the location class page-numbers consisting of one layer + which is the alphabet arabic-numbers. Since the minimum diff --git a/Build/source/utils/xindy/xindy-src/doc/faq-4.html b/Build/source/utils/xindy/xindy-src/doc/faq-4.html index 81052562f1d..3a57b7ac8ad 100644 --- a/Build/source/utils/xindy/xindy-src/doc/faq-4.html +++ b/Build/source/utils/xindy/xindy-src/doc/faq-4.html @@ -460,11 +460,12 @@ location references. For exmaple the sequence the form

-  (define-location-class ... :min-range-length none)
+  (define-location-class ... :min-range-length 100000)
 
-

The argument :min-range-length none avoids forming of ranges. -Arbitrary numbers instead of none define the minimum length of a -sequence of location references that are needed to form a range. +

Arbitrary numbers define the minimum length of a sequence of location references that are needed to form a range. +The use of a sufficiently large number (such as :min-range-length 100000) avoids forming of ranges +(unless your document has more than 100.000 pages and an index entry spans all of them; in this unlikely case, just increase +the number sufficiently). xindys default value is 2.

diff --git a/Build/source/utils/xindy/xindy-src/doc/manual-3.html b/Build/source/utils/xindy/xindy-src/doc/manual-3.html index 3520de7f1ea..e00cf79c6f7 100644 --- a/Build/source/utils/xindy/xindy-src/doc/manual-3.html +++ b/Build/source/utils/xindy/xindy-src/doc/manual-3.html @@ -185,8 +185,8 @@ strings representing separators. Separators must follow the keyword argument :sep. If the keyword :min-range-length is specified we define the minimum range length to be used when building ranges. The argument num must be a positive integer -number or the keyword none in which case the building of ranges -is disallowed. If the switch :var is specified the declared class +number. Use a sufficiently large number (such as 10000) to disallow the building of ranges. +If the switch :var is specified the declared class is of type variable, i.e. it is a var-location-class. Since building of ranges is currently only allowed for standard classes :var and :min-range-length must not be used together. The @@ -198,7 +198,7 @@ layers the hierarchy does contain. See command

   (define-location-class "page-numbers" ("arabic-numbers")
-                         :minimum-range-length 3)
+                         :min-range-length 3)
 

Defines the location class page-numbers consisting of one layer which is the alphabet arabic-numbers. Since the minimum -- cgit v1.2.3