Merge pull request #10043 from JamesDeFabia/17681MissingIndexforSplitWords

HPCC-17681 Add missing index terms to Standard Library Reference

Reviewed-By: Greg Panagiotatos <Greg.Panagiotatos@lexisnexis.com>
Reviewed-By: Richard Chapman <rchapman@hpccsystems.com>

docs/ECLStandardLibraryReference/SLR-Mods/AdjustCalendar.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.AdjustCalendar</primary>
     </indexterm><indexterm>
       <primary>Date.AdjustCalendar</primary>
+    </indexterm><indexterm>
+      <primary>AdjustCalendar</primary>
     </indexterm>(</emphasis> <emphasis>date</emphasis> ,
   [<emphasis>year_delta</emphasis>],[<emphasis>month_delta</emphasis>]
   ,[<emphasis>day_delta</emphasis>] <emphasis role="bold">)</emphasis></para>
@@ -58,7 +60,7 @@
 
   <para>The AdjustCalendar function adjusts a date by incrementing or
   decrementing months and/or years. The date must be in the Gregorian calendar
-  after the year 1600. </para>
+  after the year 1600.</para>
 
   <para>This uses the rule outlined in McGinn v. State, 46 Neb. 427, 65 N.W.
   46 (1895):</para>
@@ -68,11 +70,11 @@
     and not appearing to have been used in a different sense, denotes a period
     terminating with the day of the succeeding month numerically corresponding
     to the day of its beginning, less one. If there be no corresponding day of
-    the succeeding month, it terminates with the last day thereof." </para>
+    the succeeding month, it terminates with the last day thereof."</para>
   </blockquote>
 
   <para>Note that day adjustments are performed after year and month
-  adjustments using the preceding rules. </para>
+  adjustments using the preceding rules.</para>
 
   <para>As an example, Jan. 31, 2014 + 1 month results in Feb. 28, 2014; Jan.
   31, 2014 + 1 month + 1 day results in Mar. 1, 2014.</para>

docs/ECLStandardLibraryReference/SLR-Mods/AdjustDate.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.AdjustDate</primary>
     </indexterm><indexterm>
       <primary>Date.AdjustDate</primary>
+    </indexterm><indexterm>
+      <primary>AdjustDate</primary>
     </indexterm>(</emphasis> <emphasis>date</emphasis> ,
   [<emphasis>year_delta</emphasis>],[<emphasis>month_delta</emphasis>]
   ,[<emphasis>day_delta</emphasis>] <emphasis role="bold">)</emphasis></para>
@@ -58,7 +60,7 @@
 
   <para>The <emphasis role="bold">AdjustDate</emphasis> function adjusts a
   date by incrementing or decrementing year, month, and/or day values. The
-  date must be in the Gregorian calendar after the year 1600. </para>
+  date must be in the Gregorian calendar after the year 1600.</para>
 
   <para>If the new calculated date is invalid then it is normalized according
   to mktime() rules. For example, 20140130 plus 1 month would be

docs/ECLStandardLibraryReference/SLR-Mods/BLAS.xml

@@ -283,9 +283,9 @@ STD.BLAS.dasum(9, test_data, 1); //sums the absolute values of the matrix, and r
     <para><emphasis role="bold">STD.BLAS.daxpy<indexterm>
         <primary>STD.BLAS.daxpy</primary>
       </indexterm><indexterm>
-        <primary>BLAS.dasum</primary>
+        <primary>BLAS.daxpy</primary>
       </indexterm><indexterm>
-        <primary>dasum</primary>
+        <primary>daxpy</primary>
       </indexterm>(</emphasis> <emphasis>N, alpha, X, incX, Y, incY,
     x_skipped,y_skipped);</emphasis> <emphasis></emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/CleanAccents.xml

@@ -8,6 +8,8 @@
       <primary>STD.Uni.CleanAccents</primary>
     </indexterm><indexterm>
       <primary>Uni.CleanAccents</primary>
+    </indexterm><indexterm>
+      <primary>CleanAccents</primary>
     </indexterm>(</emphasis> <emphasis>source</emphasis> <emphasis
   role="bold">)</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/CountWords.xml

@@ -8,6 +8,8 @@
       <primary>STD.Str.CountWords</primary>
     </indexterm><indexterm>
       <primary>Str.CountWords</primary>
+    </indexterm><indexterm>
+      <primary>CountWords</primary>
     </indexterm>(</emphasis> <emphasis>source, separator </emphasis><emphasis
   role="bold">)</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/DateDataTypes.xml

@@ -8,18 +8,24 @@
       <primary>STD.Date.Date_rec</primary>
     </indexterm><indexterm>
       <primary>Date.Date_rec</primary>
+    </indexterm><indexterm>
+      <primary>Date_rec</primary>
     </indexterm></emphasis></para>
 
   <para><emphasis role="bold">STD.Date.Date_t<indexterm>
       <primary>STD.Date.Date_t</primary>
     </indexterm><indexterm>
       <primary>Date.Date_t</primary>
+    </indexterm><indexterm>
+      <primary>Date_t</primary>
     </indexterm></emphasis></para>
 
   <para><emphasis role="bold">STD.Date.Days_t<indexterm>
       <primary>STD.Date.Days_t</primary>
     </indexterm><indexterm>
       <primary>Date.Days_t</primary>
+    </indexterm><indexterm>
+      <primary>Days_t</primary>
     </indexterm></emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">

docs/ECLStandardLibraryReference/SLR-Mods/DateFromParts.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.DateFromParts</primary>
     </indexterm><indexterm>
       <primary>Date.DateFromParts</primary>
+    </indexterm><indexterm>
+      <primary>DateFromParts</primary>
     </indexterm>(</emphasis> <emphasis>year, month, day</emphasis> <emphasis
   role="bold">)</emphasis></para>
 
@@ -45,7 +47,9 @@
     </tgroup>
   </informaltable>
 
-  <para>The <emphasis role="bold">DateFromParts</emphasis> function returns a Date_t value from the <emphasis>year</emphasis>, <emphasis>month</emphasis>, and <emphasis>day</emphasis> parameters.</para>
+  <para>The <emphasis role="bold">DateFromParts</emphasis> function returns a
+  Date_t value from the <emphasis>year</emphasis>, <emphasis>month</emphasis>,
+  and <emphasis>day</emphasis> parameters.</para>
 
   <para>Example:</para>
 

docs/ECLStandardLibraryReference/SLR-Mods/Day.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.Day</primary>
     </indexterm><indexterm>
       <primary>Date.Day</primary>
+    </indexterm><indexterm>
+      <primary>Day</primary>
     </indexterm>(</emphasis> <emphasis>date</emphasis> <emphasis
   role="bold">)</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/FromGregorianYMD.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.FromGregorianYMD</primary>
     </indexterm><indexterm>
       <primary>Date.FromGregorianYMD</primary>
+    </indexterm><indexterm>
+      <primary>FromGregorianYMD</primary>
     </indexterm>(</emphasis> <emphasis>year, month, day</emphasis> <emphasis
   role="bold">)</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/GetNthWord.xml

@@ -8,22 +8,18 @@
       <primary>STD.Str.GetNthWord</primary>
     </indexterm><indexterm>
       <primary>Str.GetNthWord</primary>
+    </indexterm><indexterm>
+      <primary>GetNthWord</primary>
     </indexterm>(</emphasis> <emphasis>source, instance </emphasis><emphasis
   role="bold">)</emphasis></para>
 
-  <para>
-  <emphasis role="bold">STD.Uni.GetNthWord
-    <indexterm>
+  <para><emphasis role="bold">STD.Uni.GetNthWord <indexterm>
       <primary>STD.Uni.GetNthWord</primary>
-    </indexterm>
-    <indexterm>
+    </indexterm> <indexterm>
       <primary>Uni.GetNthWord</primary>
-    </indexterm>
-    (</emphasis> 
-    <emphasis>source, instance </emphasis>
-    <emphasis role="bold">[</emphasis>
-    <emphasis>, locale</emphasis><emphasis role="bold"> ] )</emphasis>
-  </para>
+    </indexterm> (</emphasis> <emphasis>source, instance </emphasis> <emphasis
+  role="bold">[</emphasis> <emphasis>, locale</emphasis><emphasis role="bold">
+  ] )</emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">
@@ -47,8 +43,9 @@
         <row>
           <entry><emphasis>locale</emphasis></entry>
 
-          <entry>A null-terminated string containing the language and country code to use to
-determine correct sort order and other operations.</entry>
+          <entry>A null-terminated string containing the language and country
+          code to use to determine correct sort order and other
+          operations.</entry>
         </row>
 
         <row>
@@ -61,7 +58,8 @@ determine correct sort order and other operations.</entry>
   </informaltable>
 
   <para>The <emphasis role="bold">GetNthWord </emphasis>function returns the
-  word in the <emphasis>instance</emphasis> position in the <emphasis>source</emphasis>string.</para>
+  word in the <emphasis>instance</emphasis> position in the
+  <emphasis>source</emphasis>string.</para>
 
   <para>Example:</para>
 
@@ -71,5 +69,4 @@ str1 := 'a word a day keeps the doctor away';
 
 STD.STr.GetNthWord(str1,2);    //returns "word"
 </programlisting>
-
 </sect1>

docs/ECLStandardLibraryReference/SLR-Mods/Hour.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.Hour</primary>
     </indexterm><indexterm>
       <primary>Date.Hour</primary>
+    </indexterm><indexterm>
+      <primary>Hour</primary>
     </indexterm>(</emphasis> <emphasis>time</emphasis> <emphasis
   role="bold">)</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/IsDateLeapYear.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.IsDateLeapYear</primary>
     </indexterm><indexterm>
       <primary>Date.IsDateLeapYear</primary>
+    </indexterm><indexterm>
+      <primary>IsDateLeapYear</primary>
     </indexterm>(</emphasis> <emphasis>date</emphasis> <emphasis
   role="bold">)</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/IsLeapYear.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.IsLeapYear</primary>
     </indexterm><indexterm>
       <primary>Date.IsLeapYear</primary>
+    </indexterm><indexterm>
+      <primary>IsLeapYear</primary>
     </indexterm>(</emphasis> <emphasis>year</emphasis> <emphasis
   role="bold">)</emphasis></para>
 
@@ -33,8 +35,9 @@
     </tgroup>
   </informaltable>
 
-  <para>The <emphasis role="bold">IsLeapYear</emphasis> function returns TRUE if the <emphasis>year</emphasis> is 
-  a leap year in the Gregorian (or proleptic Gregorian) calendar.</para>
+  <para>The <emphasis role="bold">IsLeapYear</emphasis> function returns TRUE
+  if the <emphasis>year</emphasis> is a leap year in the Gregorian (or
+  proleptic Gregorian) calendar.</para>
 
   <para>Example:</para>
 

docs/ECLStandardLibraryReference/SLR-Mods/IsValidDate.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.IsValidDate</primary>
     </indexterm><indexterm>
       <primary>Date.IsValidDate</primary>
+    </indexterm><indexterm>
+      <primary>IsValidDate</primary>
     </indexterm>(</emphasis> <emphasis>date</emphasis> ,
   [<emphasis>yearLowerBound</emphasis>],[<emphasis>yearUpperBound</emphasis>]
   <emphasis role="bold">)</emphasis></para>

docs/ECLStandardLibraryReference/SLR-Mods/IsValidGregorianDate.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.IsValidGregorianDate</primary>
     </indexterm><indexterm>
       <primary>Date.IsValidGregorianDate</primary>
+    </indexterm><indexterm>
+      <primary>IsValidGregorianDate</primary>
     </indexterm>(</emphasis> <emphasis>date</emphasis> <emphasis
   role="bold">)</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/IsValidTime.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.IsValidTime</primary>
     </indexterm><indexterm>
       <primary>Date.IsValidTime</primary>
+    </indexterm><indexterm>
+      <primary>IsValidTime</primary>
     </indexterm>(</emphasis> <emphasis>time</emphasis> <emphasis
   role="bold">)</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/Minute.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.Minute</primary>
     </indexterm><indexterm>
       <primary>Date.Minute</primary>
+    </indexterm><indexterm>
+      <primary>Minute</primary>
     </indexterm>(</emphasis> <emphasis>time</emphasis> <emphasis
   role="bold">)</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/Month.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.Month</primary>
     </indexterm><indexterm>
       <primary>Date.Month</primary>
+    </indexterm><indexterm>
+      <primary>Month</primary>
     </indexterm>(</emphasis> <emphasis>date</emphasis> <emphasis
   role="bold">)</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/Second.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.Second</primary>
     </indexterm><indexterm>
       <primary>Date.Second</primary>
+    </indexterm><indexterm>
+      <primary>Second</primary>
     </indexterm>(</emphasis> <emphasis>time</emphasis> <emphasis
   role="bold">)</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/SplitWords.xml

@@ -8,6 +8,8 @@
       <primary>STD.Str.SplitWords</primary>
     </indexterm><indexterm>
       <primary>Str.SplitWords</primary>
+    </indexterm><indexterm>
+      <primary>SplitWords</primary>
     </indexterm>(</emphasis> <emphasis>source, separator </emphasis><emphasis
   role="bold">[ </emphasis><emphasis>, allowblank</emphasis><emphasis
   role="bold"> ] )</emphasis></para>
@@ -34,8 +36,8 @@
         <row>
           <entry><emphasis>allowblank</emphasis></entry>
 
-          <entry>Optional. If TRUE, specifies allowing blank items in the result. 
-          If omitted, the default is FALSE.</entry>
+          <entry>Optional. If TRUE, specifies allowing blank items in the
+          result. If omitted, the default is FALSE.</entry>
         </row>
 
         <row>

docs/ECLStandardLibraryReference/SLR-Mods/TimeDataTypes.xml

@@ -8,12 +8,16 @@
       <primary>STD.Date.Time_rec</primary>
     </indexterm><indexterm>
       <primary>Date.Time_rec</primary>
+    </indexterm><indexterm>
+      <primary>Time_rec</primary>
     </indexterm></emphasis></para>
 
   <para><emphasis role="bold">STD.Date.Time_t<indexterm>
       <primary>STD.Date.Time_t</primary>
     </indexterm><indexterm>
       <primary>Date.Time_t</primary>
+    </indexterm><indexterm>
+      <primary>Time_t</primary>
     </indexterm></emphasis></para>
 
   <para><emphasis role="bold">STD.DateTime_rec <indexterm>
@@ -54,7 +58,7 @@
 
           <entry>An INTEGER8 holding holding a number of seconds. Can be used
           to represent either a duration or the number of seconds since epoch
-          (Jan 1, 1970). </entry>
+          (Jan 1, 1970).</entry>
         </row>
 
         <row>

docs/ECLStandardLibraryReference/SLR-Mods/TimeFromParts.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.TimeFromParts</primary>
     </indexterm><indexterm>
       <primary>Date.TimeFromParts</primary>
+    </indexterm><indexterm>
+      <primary>TimeFromParts</primary>
     </indexterm>(</emphasis> <emphasis>hour, minute, second</emphasis>
   <emphasis role="bold">)</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/ToGregorianYMD.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.ToGregorianYMD</primary>
     </indexterm><indexterm>
       <primary>Date.ToGregorianYMD</primary>
+    </indexterm><indexterm>
+      <primary>ToGregorianYMD</primary>
     </indexterm>(</emphasis> <emphasis>days</emphasis> <emphasis
   role="bold">)</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/WordCount.xml

@@ -8,6 +8,8 @@
       <primary>STD.Str.WordCount</primary>
     </indexterm><indexterm>
       <primary>Str.WordCount</primary>
+    </indexterm><indexterm>
+      <primary>WordCount</primary>
     </indexterm>(</emphasis> <emphasis>source</emphasis><emphasis role="bold">
   )</emphasis></para>
 

docs/ECLStandardLibraryReference/SLR-Mods/WorkunitExists.xml

@@ -4,10 +4,18 @@
 <sect1 id="WorkunitExists">
   <title>WorkunitExists</title>
 
-  <para><emphasis role="bold">STD.System.Workunit.WorkunitExists(</emphasis>
-  <emphasis> wuid </emphasis> <emphasis role="bold">[</emphasis> <emphasis>,
-  online </emphasis> <emphasis role="bold">] [</emphasis> <emphasis>, archived
-  </emphasis> <emphasis role="bold">] )</emphasis></para>
+  <para><emphasis role="bold">STD.System.Workunit.WorkunitExists(<indexterm>
+      <primary>STD.System.Workunit.WorkunitExists</primary>
+    </indexterm><indexterm>
+      <primary>System.Workunit.WorkunitExists</primary>
+    </indexterm><indexterm>
+      <primary>Workunit.WorkunitExists</primary>
+    </indexterm><indexterm>
+      <primary>WorkunitExists</primary>
+    </indexterm></emphasis> <emphasis> wuid </emphasis> <emphasis
+  role="bold">[</emphasis> <emphasis>, online </emphasis> <emphasis
+  role="bold">] [</emphasis> <emphasis>, archived </emphasis> <emphasis
+  role="bold">] )</emphasis></para>
 
   <informaltable colsep="1" frame="all" rowsep="1">
     <tgroup cols="2">

docs/ECLStandardLibraryReference/SLR-Mods/Year.xml

@@ -8,6 +8,8 @@
       <primary>STD.Date.Year</primary>
     </indexterm><indexterm>
       <primary>Date.Year</primary>
+    </indexterm><indexterm>
+      <primary>Year</primary>
     </indexterm>(</emphasis> <emphasis>date</emphasis> <emphasis
   role="bold">)</emphasis></para>