summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2020-05-28 17:48:11 +0000
committerKarl Berry <karl@freefriends.org>2020-05-28 17:48:11 +0000
commit161f6fe963657c26131dfd27baa4bbb5548aae3d (patch)
tree5a4d50c324ee88b057b57e209ac89532923879f7
parent4ac93fe2033005baa7a6d353ca484e573c6dbc73 (diff)
document :min-range-length none workaround, from J\"urgen S
git-svn-id: svn://tug.org/texlive/trunk@55314 c570f23f-e606-0410-a88d-b1316a301751
-rw-r--r--Build/source/utils/xindy/ChangeLog7
-rw-r--r--Build/source/utils/xindy/TLpatches/patch-10-doc-min-range45
-rw-r--r--Build/source/utils/xindy/xindy-src/doc/faq-4.html9
-rw-r--r--Build/source/utils/xindy/xindy-src/doc/manual-3.html6
4 files changed, 60 insertions, 7 deletions
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 <spitz@lyx.org>
+
+ * 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 <karl@tug.org>
* 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
+ <P>
+ <PRE>
+- (define-location-class ... :min-range-length none)
++ (define-location-class ... :min-range-length 100000)
+ </PRE>
+-<P>The argument <CODE>:min-range-length none</CODE> avoids forming of ranges.
+-Arbitrary numbers instead of <CODE>none</CODE> define the minimum length of a
+-sequence of location references that are needed to form a range.
++<P>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 <CODE>:min-range-length 100000</CODE>) 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).
+ <SF>xindy</SF>s default value is&nbsp;2.
+ <P>
+ <P>
+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 <CODE>:sep</CODE>. If the keyword <CODE>:min-range-length</CODE> is
+ specified we define the <EM>minimum range length</EM> to be used when
+ building ranges. The argument <CODE>num</CODE> must be a positive integer
+-number or the keyword <CODE>none</CODE> in which case the building of ranges
+-is disallowed. If the switch <CODE>:var</CODE> is specified the declared class
++number. Use a sufficiently large number (such as 10000) to disallow the building of ranges.
++If the switch <CODE>:var</CODE> is specified the declared class
+ is of type <EM>variable</EM>, i.e. it is a <EM>var-location-class</EM>. Since
+ building of ranges is currently only allowed for standard classes
+ <CODE>:var</CODE> and <CODE>:min-range-length</CODE> must not be used together. The
+@@ -198,7 +198,7 @@ layers the hierarchy does contain. See command
+ <P>
+ <PRE>
+ (define-location-class "page-numbers" ("arabic-numbers")
+- :minimum-range-length 3)
++ :min-range-length 3)
+ </PRE>
+ <P>Defines the location class <CODE>page-numbers</CODE> consisting of one layer
+ which is the alphabet <CODE>arabic-numbers</CODE>. 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
<P>
<PRE>
- (define-location-class ... :min-range-length none)
+ (define-location-class ... :min-range-length 100000)
</PRE>
-<P>The argument <CODE>:min-range-length none</CODE> avoids forming of ranges.
-Arbitrary numbers instead of <CODE>none</CODE> define the minimum length of a
-sequence of location references that are needed to form a range.
+<P>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 <CODE>:min-range-length 100000</CODE>) 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).
<SF>xindy</SF>s default value is&nbsp;2.
<P>
<P>
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 <CODE>:sep</CODE>. If the keyword <CODE>:min-range-length</CODE> is
specified we define the <EM>minimum range length</EM> to be used when
building ranges. The argument <CODE>num</CODE> must be a positive integer
-number or the keyword <CODE>none</CODE> in which case the building of ranges
-is disallowed. If the switch <CODE>:var</CODE> is specified the declared class
+number. Use a sufficiently large number (such as 10000) to disallow the building of ranges.
+If the switch <CODE>:var</CODE> is specified the declared class
is of type <EM>variable</EM>, i.e. it is a <EM>var-location-class</EM>. Since
building of ranges is currently only allowed for standard classes
<CODE>:var</CODE> and <CODE>:min-range-length</CODE> must not be used together. The
@@ -198,7 +198,7 @@ layers the hierarchy does contain. See command
<P>
<PRE>
(define-location-class "page-numbers" ("arabic-numbers")
- :minimum-range-length 3)
+ :min-range-length 3)
</PRE>
<P>Defines the location class <CODE>page-numbers</CODE> consisting of one layer
which is the alphabet <CODE>arabic-numbers</CODE>. Since the minimum